diff --git a/README.en.md b/README.en.md index b0bd2caacfa38677b37353c3953d25b4c437741a..70c79c2cfc46af087343a9e96cdf4ccbd9a95a34 100644 --- a/README.en.md +++ b/README.en.md @@ -1,36 +1,29 @@ # nestos-kubernetes-deployer -#### Description -A Nestos based kubernetes deployment tool +## Introduction -#### Software Architecture -Software architecture description +NKD (NestOS Kubernetes Deployer) is a solution designed for deploying and maintaining Kubernetes clusters on NestOS. It is designed to simplify the process of deploying and upgrading clusters by providing a range of services outside the cluster, including deployment, updates, and configuration management of infrastructure and core components of Kubernetes. NKD is designed to provide a more convenient cluster operation experience, allowing users to easily complete complex management tasks, thereby improving the overall efficiency of deployment and maintenance. -#### Installation +#### Support Platforms -1. xxxx -2. xxxx -3. xxxx +It supports multiple deployment platforms, and NKD dynamically creates the required IaaS resources by connecting infrastructure providers according to the needs of the cluster, and currently supports OpenStack and libvirt platforms. -#### Instructions +## Software architecture -1. xxxx -2. xxxx -3. xxxx +For more information, see [Software Architecture](docs/overall_design.md) + +## Install and deploy -#### Contribution +Please refer to the [user manual for details](docs/manual.md) -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request +## Planning for the future +NKD's ultimate vision is to support O&M and efficient management of multiple clusters at the same time in the form of long-term resident services. It provides a variety of features, such as persistent configuration change records, certificate management, multiple update and upgrade policies, and image source channels. In the future, we will continue to improve the functions and performance of NKD, and introduce more intelligent features, such as automated fault handling and resource optimization. Our goal is to shape NKD into a core component of the NestOS ecosystem, providing all-round support for O&M in cloud-native scenarios, so as to further promote the development and widespread application of cloud-native technologies. -#### Gitee Feature +## Get involved -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +Interested partners are very welcome to join us and contribute. + +## License + +Apache License 2.0