From d9a8064c17b2087e26bb268c4ac2bcf5e6a897bc Mon Sep 17 00:00:00 2001 From: Dayuan Date: Tue, 18 Jun 2024 17:58:56 +0800 Subject: [PATCH] docs: update the Chinese readme and the Windows download command (#1172) --- README-zh.md | 94 +++++++++++++++++++++++++++++++--------------------- README.md | 20 +++++------ 2 files changed, 64 insertions(+), 50 deletions(-) diff --git a/README-zh.md b/README-zh.md index f0cb224f..8c12fa77 100644 --- a/README-zh.md +++ b/README-zh.md @@ -3,73 +3,91 @@

-

更高效、更安全地构建你的内部研发者平台

-[简体中文](https://github.com/KusionStack/kusion/blob/main/README-zh.md) | [English](https://github.com/KusionStack/kusion/blob/main/README.md) - -[kusionstack.io](https://kusionstack.io/) | [Konfig](https://github.com/KusionStack/konfig) | [Catalog](https://github.com/KusionStack/catalog) | [CNCF Landscape](https://landscape.cncf.io/?selected=kusion-stack) +

+ Intent-Driven Platform Orchestrator +

+ +

+ 🌐 官网 • + ⚡️ 快速开始 • + 📚 文档 • + 💬 讨论
+ [English] + [中文] +

[![Kusion](https://github.com/KusionStack/kusion/actions/workflows/release.yaml/badge.svg)](https://github.com/KusionStack/kusion/actions/workflows/release.yaml) [![GitHub release](https://img.shields.io/github/release/KusionStack/kusion.svg)](https://github.com/KusionStack/kusion/releases) [![Go Report Card](https://goreportcard.com/badge/github.com/KusionStack/kusion)](https://goreportcard.com/report/github.com/KusionStack/kusion) - [![Go Reference](https://pkg.go.dev/badge/github.com/KusionStack/kusion.svg)](https://pkg.go.dev/github.com/KusionStack/kusion) [![license](https://img.shields.io/github/license/KusionStack/kusion.svg)](https://github.com/KusionStack/kusion/blob/main/LICENSE) + -# Kusion +Kusion 是一个意图驱动的[平台编排器](https://internaldeveloperplatform.org/platform-orchestrators/)，它位于[内部开发者平台 (IDP)](https://internaldeveloperplatform.org/what-is-an-internal-developer-platform/)的核心。通过 Kusion，你可以启用以应用为中心的开发，你的开发者只需要编写单一的应用配置 - [AppConfiguration](https://www.kusionstack.io/docs/concepts/app-configuration)，无需提供特定于环境的值，即可定义工作负载和所有资源依赖，Kusion 确保为应用运行提供一切所需。 -Kusion 是 [KusionStack](https://github.com/KusionStack) 的云原生平台工程引擎，旨在帮助您构建高效且安全的内部开发者平台（IDP）。它允许应用开发者在一个地方、用统一的方式完成 DevOps 生命周期中的所有运维任务，而不用关心底层基础设（Kubernetes、云平台和自建服务）的复杂性。对于平台工程师也提供了灵活的 Module 扩展机制，方便他们实现基础设施能力的抽象、复用与标准化，以实现应用研发自服务。 +Kusion 帮助负责创建应用的应用开发者以及负责维护应用运行的基础设施的平台工程师。这些角色在你的组织中可能重叠或不同，但 Kusion 旨在为任何负责这些任务的从业者减轻工作负担。 -## 核心能力 +## Kusion 如何工作？ -- **平台代码化**：在同一个地方、以统一的方式，管理应用所有的运维操作。 -- **动态配置管理**：开发人员可用一份与环境无关的配置，部署到任何环境，环境差异性由 Kusion 处理。 -- **研发自服务**：开发人员可以通过选择平台工程师在 [Kusion Modules](https://www.kusionstack.io/docs/concepts/kusion-module/overview) 中提供的功能来自助满足需求。 -- **内置安全性和合规性**：平台工程师可以通过灵活的平台配置，实现满足安全性、合规性和最佳实践的标准化应用程序交付。 -- **开放模块生态系统**：不断增长的开放模块生态系统涵盖了 DevOps 生命周期的所有阶段，并与各种云原生基础设施有广泛的连接。 -- **轻量级并且 Kubernetes 友好**：Kusion 作为一个纯客户端解决方案，拥有丰富的 API，提供了出色的可移植性和集成便利性。同时用户友好的可观察性和故障排除能力使得 Kubernetes 操作更加简单。 +作为一个平台编排器，Kusion 使您能够解决通常与 Day 0 和 Day 1 关联的挑战。平台工程师和应用工程师都可以从 Kusion 中获益。 -
- -![workflow](docs/workflow.png) -
+Kusion 有两个关键工作流程： +1. **Day 0 - 设置模块和工作空间：** 平台工程师为部署应用及其底层基础设施创建共享模块，并为目标着陆区定义工作空间。这些标准化的共享模块编写了包括安全、合规和财务在内的组织中各利益相关者的要求。 + Kusion 模块抽象了底层基础设施工具的复杂性，使应用开发者能够使用自助模式部署他们的应用程序。 + +2. **Day 1 - 设置应用程序：** 应用开发者利用平台工程师创建的工作空间和模块来部署应用及其支持的基础设施。平台团队维护工作空间和模块，这允许应用开发者专注于在标准化的基础设施上使用可重复的过程构建应用。 ## 快速开始 -### 部署第一个应用 - -参考 [Quick Start](https://www.kusionstack.io/docs/getting-started/deliver-quickstart) 通过 Kusion -部署您的第一个应用 - -![apply](https://raw.githubusercontent.com/KusionStack/kusionstack.io/main/static/img/docs/user_docs/getting-started/kusion_apply_quickstart.gif) +本指南将涵盖： +1. 安装 Kusion CLI。 +2. 使用 Kusion 将应用部署到 Kubernetes。 -## 安装 +### 安装 -### Homebrew (macOS & Linux) +#### Homebrew (macOS & Linux) ```shell +# tap formula repository Kusionstack/tap +brew tap KusionStack/tap + +# install Kusion brew install KusionStack/tap/kusion ``` -### Docker +#### Powershell ```shell -docker pull kusionstack/kusion:latest +# install Kusion latest version +powershell -Command "iwr -useb https://www.kusionstack.io/scripts/install.ps1 | iex" ``` -> 有关安装的更多信息，请查看 KusionStack 官网的[安装指南](https://www.kusionstack.io/docs/getting-started/install-kusion)。 +> 有关安装的更多信息，请参考[安装指南](https://www.kusionstack.io/docs/getting-started/install-kusion)以获取更多选项。 + +### 部署 + +要部署应用程序，您可以运行 `kusion apply` 命令。 +> 要快速启动并运行 Kusion，请参阅[快速开始指南](https://www.kusionstack.io/docs/getting-started/deliver-quickstart)。 +> + +![apply](https://raw.githubusercontent.com/KusionStack/kusionstack.io/main/static/img/docs/user_docs/getting-started/kusion_apply_quickstart.gif) -# 联系我们 -- Twitter: [KusionStack](https://twitter.com/KusionStack) -- Slack: [Kusionstack](https://join.slack.com/t/kusionstack/shared_invite/zt-2drafxksz-VzCZZwlraHP4xpPeh_g8lg) -- 钉钉: 42753001 -- 微信群 + +## 联系方式 + +如果您有任何问题，欢迎通过以下方式联系我们： +- [Slack](https://kusionstack.slack.com) | [加入](https://join.slack.com/t/kusionstack/shared_invite/zt-2drafxksz-VzCZZwlraHP4xpPeh_g8lg) +- [钉钉群](https://page.dingtalk.com/wow/dingtalk/act/en-home)：`42753001`（中文） +- 微信群（中文）：添加微信小助手，拉你进用户群 -# 🎖︎ 贡献指南 +## 贡献 + +如果您有兴趣贡献，在**提交 Pull Request 前**请参阅[贡献指南](CONTRIBUTING.md)。 + +## 许可证 -Kusion 仍处在快速发展阶段，有很多能力需要补全，我们欢迎所有人参与进来与我们一起共建。 -访问[贡献指南](docs/contributing.md)了解如何参与到贡献 Kusion 项目中。 -如有任何疑问欢迎[提交 Issue](https://github.com/KusionStack/kusion/issues)。 +Kusion 根据 Apache 2.0 许可证授权。有关详细信息，请见 [LICENSE](LICENSE) 文件。 diff --git a/README.md b/README.md index b0e64c20..6a6d71ef 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ ## What is Kusion? -Kusion is an intent-driven [Platform Orchestrator](https://internaldeveloperplatform.org/platform-orchestrators/), which sits at the core of an [Internal Developer Platform (IDP)](https://internaldeveloperplatform.org/what-is-an-internal-developer-platform/). With Kusion you can enable app-centric development, your developers only need to write a single application specification - [AppConfiguration](https://www.kusionstack.io/docs/concepts/app-configuration). [AppConfiguration](https://www.kusionstack.io/docs/concepts/app-configuration) defines the workload and all resource dependencies without needing to supply environment-specific values, Kusion ensures it provides everything needed for the application to run. +Kusion is an intent-driven [Platform Orchestrator](https://internaldeveloperplatform.org/platform-orchestrators/), which sits at the core of an [Internal Developer Platform (IDP)](https://internaldeveloperplatform.org/what-is-an-internal-developer-platform/). With Kusion you can enable app-centric development, your developers only need to write a single application specification - [AppConfiguration](https://www.kusionstack.io/docs/concepts/app-configuration). AppConfiguration defines the workload and all resource dependencies without needing to supply environment-specific values, Kusion ensures it provides everything needed for the application to run. Kusion helps app developers who are responsible for creating applications and the platform engineers responsible for maintaining the infrastructure the applications run on. These roles may overlap or align differently in your organization, but Kusion is intended to ease the workload for any practitioner responsible for either set of tasks. @@ -42,7 +42,7 @@ As a Platform Orchestrator, Kusion enables you to address challenges often assoc There are two key workflows for Kusion: -1. **Day 0 - Set up the modules and workspaces:** Platform engineers create shared modules for deploying applications and their underlying infrastructure, and workspace definitions for target landing zone. These standardized, shared modules codify the requirements from stakeholders across the organization including security, compliance, and finance. +1. **Day 0 - Set up the modules and workspaces:** Platform engineers create shared modules for deploying applications and their underlying infrastructure, and workspace definitions for the target landing zone. These standardized, shared modules codify the requirements of stakeholders across the organization including security, compliance, and finance. Kusion modules abstract the complexity of underlying infrastructure tooling, enabling app developers to deploy their applications using a self-service model. @@ -62,7 +62,7 @@ There are two key workflows for Kusion: This guide will cover: -1. Install Kusion CLI using package manager. +1. Install Kusion CLI. 2. Deploy an application to Kubernetes with Kusion. ### Install @@ -77,14 +77,11 @@ brew tap KusionStack/tap brew install KusionStack/tap/kusion ``` -#### Scoop +#### Powershell ``` -# add scoop bucket KusionStack -scoop bucket add KusionStack https://github.com/KusionStack/scoop-bucket.git - -# install kusion -scoop install KusionStack/kusion +# install Kusion latest version +powershell -Command "iwr -useb https://www.kusionstack.io/scripts/install.ps1 | iex" ``` > For more information about installation, please refer to the [Installation Guide](https://www.kusionstack.io/docs/getting-started/install-kusion) for more options. @@ -93,10 +90,9 @@ scoop install KusionStack/kusion To deploy an application, you can run the `kusion apply` command. -![apply](https://raw.githubusercontent.com/KusionStack/kusionstack.io/main/static/img/docs/user_docs/getting-started/kusion_apply_quickstart.gif) - > To rapidly get Kusion up and running, please refer to the [Quick Start Guide](https://www.kusionstack.io/docs/getting-started/deliver-quickstart). +![apply](https://raw.githubusercontent.com/KusionStack/kusionstack.io/main/static/img/docs/user_docs/getting-started/kusion_apply_quickstart.gif) ## Contact @@ -104,7 +100,7 @@ If you have any questions, feel free to reach out to us in the following ways: - [Slack](https://kusionstack.slack.com) | [Join](https://join.slack.com/t/kusionstack/shared_invite/zt-2drafxksz-VzCZZwlraHP4xpPeh_g8lg) - [DingTalk Group](https://page.dingtalk.com/wow/dingtalk/act/en-home): `42753001` (Chinese) -- Wechat Group (Chinese): Broker wechat to add you into the user group. +- WeChat Group (Chinese): Add the WeChat assistant to bring you into the user group.