## File: README.md # Nacos: Dynamic *Na*ming and *Co*nfiguration *S*ervice [](https://gitter.im/alibaba/nacos?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [](https://www.apache.org/licenses/LICENSE-2.0.html) [](https://github.com/alibaba/nacos/actions/workflows/ci.yml) [](https://app.codecov.io/gh/alibaba/nacos/tree/develop) [](https://opensource.alibaba.com/contribution_leaderboard/details?projectValue=nacos) [](https://deepwiki.com/alibaba/nacos) ------- ## What does it do Nacos (official site: [nacos.io](https://nacos.io)) is an easy-to-use platform designed for dynamic service discovery and configuration and service management. It helps you to build cloud native applications and microservices platform easily. Service is a first-class citizen in Nacos. Nacos supports almost all type of services，for example，[Dubbo/gRPC service](https://nacos.io/docs/latest/ecology/use-nacos-with-dubbo/), [Spring Cloud RESTFul service](https://nacos.io/docs/latest/ecology/use-nacos-with-spring-cloud/) or [Kubernetes service](https://nacos.io/docs/latest/quickstart/quick-start-kubernetes/). Nacos provides four major functions. * **Service Discovery and Service Health Check** Nacos makes it simple for services to register themselves and to discover other services via a DNS or HTTP interface. Nacos also provides real-time health checks of services to prevent sending requests to unhealthy hosts or service instances. * **Dynamic Configuration Management** Dynamic Configuration Service allows you to manage configurations of all services in a centralized and dynamic manner across all environments. Nacos eliminates the need to redeploy applications and services when configurations are updated, which makes configuration changes more efficient and agile. * **Dynamic DNS Service** Nacos supports weighted routing, making it easier for you to implement mid-tier load balancing, flexible routing policies, flow control, and simple DNS resolution services in the production environment within your data center. It helps you to implement DNS-based service discovery easily and prevent applications from coupling to vendor-specific service discovery APIs. * **Service and MetaData Management** Nacos provides an easy-to-use service dashboard to help you manage your services metadata, configuration, kubernetes DNS, service health and metrics statistics. ## Quick Start It is super easy to get started with your first project. ### Deploying Nacos on cloud You can deploy Nacos on cloud, which is the easiest and most convenient way to start Nacos. Use the following [Nacos deployment guide](https://cn.aliyun.com/product/aliware/mse?spm=nacos-website.topbar.0.0.0) to see more information and deploy a stable and out-of-the-box Nacos server. ### Start by the provided startup package #### Step 1: Download the binary package You can download the package from the [latest stable release](https://github.com/alibaba/nacos/releases). Take release `nacos-server-1.0.0.zip` for example: ```sh unzip nacos-server-1.0.0.zip cd nacos/bin ``` #### Step 2: Start Server On the **Linux/Unix/Mac** platform, run the following command to start server with standalone mode: ```sh sh startup.sh -m standalone ``` On the **Windows** platform, run the following command to start server with standalone mode. Alternatively, you can also double-click the `startup.cmd` to run NacosServer. ``` startup.cmd -m standalone ``` For more details, see [quick-start.](https://nacos.io/docs/latest/quickstart/quick-start/) ## Quick start for other open-source projects: * [Quick start with Nacos command and console](https://nacos.io/docs/latest/quickstart/quick-start/) * [Quick start with dubbo](https://nacos.io/docs/latest/ecology/use-nacos-with-dubbo/) * [Quick start with spring cloud](https://nacos.io/docs/latest/ecology/use-nacos-with-spring-cloud/) * [Quick start with kubernetes](https://nacos.io/docs/latest/quickstart/quick-start-kubernetes/) ## Documentation You can view the full documentation from the [Nacos website](https://nacos.io/docs/latest/overview/). You can also read this online eBook from the [NACOS ARCHITECTURE & PRINCIPLES](https://nacos.io/docs/ebook/kbyo6n/). All the latest and long-term notice can also be found here from [GitHub notice issue](https://github.com/alibaba/nacos/labels/notice). ## Contributing Contributors are welcomed to join Nacos project. Please check [CONTRIBUTING](./CONTRIBUTING.md) about how to contribute to this project. ### How can I contribute? * Take a look at issues with tags marked [`good first issue`](https://github.com/alibaba/nacos/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or [`contribution welcome`](https://github.com/alibaba/nacos/issues?q=is%3Aopen+is%3Aissue+label%3A%22contribution+welcome%22). * Answer questions on [issues](https://github.com/alibaba/nacos/issues). * Fix bugs reported on [issues](https://github.com/alibaba/nacos/issues), and send us a pull request. * Review the existing [pull request](https://github.com/alibaba/nacos/pulls). * Improve the [website](https://github.com/nacos-group/nacos-group.github.io), typically we need * blog post * translation on documentation * use cases around the integration of Nacos in enterprise systems. ## Other Related Project Repositories * [nacos-spring-project](https://github.com/nacos-group/nacos-spring-project) provides the integration functionality for Spring. * [nacos-group](https://github.com/nacos-group) is the repository that hosts the eco tools for Nacos, such as SDK, synchronization tool, etc. * [spring-cloud-alibaba](https://github.com/spring-cloud-incubator/spring-cloud-alibaba) provides the one-stop solution for application development over Alibaba middleware which includes Nacos. ## Contact * [Gitter](https://gitter.im/alibaba/nacos): Nacos's IM tool for community messaging, collaboration and discovery. * [Twitter](https://twitter.com/nacos2): Follow along for latest nacos news on Twitter. * [Weibo](https://weibo.com/u/6574374908): Follow along for latest nacos news on Weibo (Twitter of China version). * [Nacos Segmentfault](https://segmentfault.com/t/nacos): Get latest notice and prompt help from Segmentfault. * Email Group: * users-nacos@googlegroups.com: Nacos usage general discussion. * dev-nacos@googlegroups.com: Nacos developer discussion (APIs, feature design, etc). * commits-nacos@googlegroups.com: Commits notice, very high frequency. * Join us from DingDing(Group 1: 21708933(full), Group 2: 30438813(full), Group 3: 31222241(full), Group 4: 12810027056). ### DingDing Group QR Code ### DingDing MCP Group QR Code ### WeChat Group QR Code ## Enterprise Service If you need Nacos enterprise service support, or purchase cloud product services, you can join the discussion by scanning the following DingTalk group. It can also be directly activated and used through the microservice engine (MSE) provided by Alibaba Cloud. https://cn.aliyun.com/product/aliware/mse?spm=nacos-website.topbar.0.0.0 ## Download - [Nacos Official Website](https://nacos.io/download/nacos-server) - [GitHub Release](https://github.com/alibaba/nacos/releases) ## Who is using These are only part of the companies using Nacos, for reference only. If you are using Nacos, please [add your company here](https://github.com/alibaba/nacos/issues/273) to tell us your scenario to make Nacos better. | | | | | | --- | --- | --- | --- | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 郑州山水 | 知氏教育 | | | --- ## File: console-ui/src/pages/AuthorityControl/README.md # 权限控制 > AuthorityControl 1. UserManagement => 用户管理 2. RolesManagement => 角色管理 3. PermissionsManagement => 权限管理 --- ## File: console-ui/README.md # Nacos Console UI (Legacy) The legacy Nacos console frontend, built with React + Webpack 4. ## Prerequisites - Node.js >= 14 (recommended 14.x ~ 22.x) - npm - Global CLI tools: ```bash npm install cross-env webpack webpack-cli ``` ## Install Dependencies ```bash npm install ``` ## Local Development ```bash npm start ``` Proxy configuration is in `build/webpack.dev.conf.js` under the `proxy` property: ```js proxy: [{ context: ['/'], changeOrigin: true, secure: false, target: 'http://ip:port', }], ``` ## Build ```bash npm run build ``` Build output goes to the `dist/` directory. > Note: Node.js 17+ requires the `--openssl-legacy-provider` flag (already configured in the package.json build script). ## Deploy Copy build artifacts to the backend static resources directory: ```bash rm -rf ../console/src/main/resources/static/legacy/* cp -r dist/* ../console/src/main/resources/static/legacy/ ``` Deployed directory structure: ``` console/src/main/resources/static/legacy/ ├── index.html ├── css/ └── js/ ``` ## contextPath Adaptation Build artifacts use relative paths (`../`), adapting to any `nacos.console.contextPath` configuration value. No rebuild is needed for different contextPath settings. --- ## File: example/README.md # Nacos example module This module contains some examples for nacos. 1. Run the Nacos service in standalone mode locally. By default, it uses port 8848. 2. App.java file is a simple "Hello Nacos" program. 3. ConfigExample.java file demonstrates how to utilize the configuration center in Nacos. 4. NamingExample.java file demonstrates how to use Nacos for service register, deregister, and subscribe. --- ## File: istio/src/main/resources/proto/mcp/Readme.md // Copyright 2018 Istio Authors // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. # Mesh Configuration Protocol (MCP) ## Introduction This folder contains the proto buffers for the Mesh Configuration Protocol (MCP). MCP is based on [XDS](https://github.com/envoyproxy/data-plane-api/blob/master/xds_protocol.rst#streaming-grpc-subscriptions) and maintains conceptual alignment with it, despite the specific service and proto definitions being different. ## Overview MCP is a subscription-based configuration distribution API. The configuration consumer (i.e. sink) requests updates for collections of resources from a configuration producer (i.e. source). The source pushes resource updates to the sink when resources are added, updated, or deleted. The sink positively ACK's the resource update, if it was accepted, and NACK's if it was rejected, e.g. because a resource was invalid. The source may push additional update once the previous update was ACK/NACK'd. The source should only have one outstanding update (per-collection) in flight at a time. MCP is a pair of bidirectional streaming gRPC API services (`ResourceSource` and `ResourceSink`). * The `ResourceSource` service is used when the resource source is the server and the sink is a client. By default, Galley implements the `ResourceSource` service and Pilot/Mixer connect as clients. * The `ResourceSink` service is used when the resource source is a client and the sink is the server. Galley can be configured to optionally "dial-out" to a remote configuration sink, e.g. Pilot is in another cluster where it cannot, as a client, initiate connection to Galley. In this scenario, Pilot would implement the `ResourceSink` service and Galley would connect as a client. ResourceSource and ResourceSink are semantically equivalent with regards to the message exchange. The only meaningful difference is who initiates the connection and opens the grpc stream. ## Data model MCP is the mechanism of transport whereby Pilot and Mixer can be configured by a manager component. MCP defines a common per-resource metadata format and resource specific contents is defined elsewhere (e.g. ). ### Collections Resources of the same type are organized into named collections. Istio API collection names are of the form `istio///` where ``, ``, and `` are defined by the [API style guidelines](../GUIDELINES.md). For example, the collection name for VirtualService is `istio/networking/v1alpha3/virtualservices`. ### Metadata ## Connection establishment * `ResourceSource` service - The client is the resource sink. The client dials the server and establishes a new gRPC stream. The client sends RequestResources and receive Resources messages. * `ResourceSink` service - The client is the resource source. The client dials the server and establishes a new gRPC stream. The server sends RequestResources and receive Resources messages. ## Configuration updates The following overview applies to both ResourceSink and ResourceSource services, regardless of client/server roles. The resource update protocol is derived from Incremental xDS. The protocol exchange is mostly the same except that resource hints have been removed. Most of the text and diagrams below are copied from the Incremental xDS docs and adjusted accordingly. In MCP, resources are first organized by collection. Within each collection, resources are uniquely identifiable by their metadata name. Individual resources are versioned to differentiate newer versions of the same named resource. A `RequestResource` message can be sent in two situations: * Initial message in an MCP bidirectional change stream * As an ACK or NACK response to a previous `Resources` message. In this case the `response_nonce` is set to the nonce value from the `Resources` message. ACK/NACK is determined by the presence of `error_detail` in the subsequent request. The initial `RequestResources` messages includes the collection corresponding to the subscribed set of resources (e.g. VirtualService), the node sink identifier, and nonce fields, and initial_resource_version (more on that later). The source send a `Resources` message when the requested resources are available. After processing the `Resources` message , the sink sends a new `RequestResources` message on the stream, specifying the last version successfully applied and the nonce provided by the source. The nonce field is used to pair `RequestResources` and `Resources` messages per collection. The source should only send one outstanding `Resource` message at a time (per-collection) and wait for the sink to ACK/NACK. Upon receiving an update, the sink is expected to send an ACK/NACK relatively quickly after decoding, validating, and persisting the update to its internal configuration store. The source should ignore requests with stale and unknown nonces that do not match the nonce in the most recently sent `Resource` message. ### Success examples The following example shows the sink receiving a sequence of changes which are successfully ACK'd. The following example shows the same desired resource delivered with incremental updates. This example assumes incremental is supported by the source. When source does not support incremental updates, the pushed `Resources` will always have incremental set to false, regardles of whether the sink requested an incremental update. At any time, the source can decide to push a full-state update, ignoring the sink's request. Both sides must negotiate (i.e. agree) to use incremental on a per request/response basis for an update to be sent incrementally. ### Error example The following example shows what happens when a change cannot be applied. The sink should only NACK in _exceptional_ cases. For example, if a set of resources was invalid, malformed, or could not be decoded. NACK'd updates should raise an alarm for subsequent investigation by a human. The source should not resend the same set of resources that were previously NACK'd. Canary pushes to dedicated sinks may also be used to verify correctness (non-NACK) before pushing to a larger fleet of resource sinks. The nonce in MCP is used to match RequestResources and Resources. On reconnect, the sinks may attempt to resume a session with the same source by specifying the known resources version with initial_resource_version for each collection.