mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-05-17 18:25:26 +00:00
fix some doc
This commit is contained in:
郭旭东
@@ -1,4 +1,4 @@
|
||||
English | [简体中文](zh/README-CN.md)
|
||||
English | [简体中文](zh/README.md)
|
||||
|
||||
# Examples
|
||||
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
[English](../README.md) | 简体中文
|
||||
|
||||
# 示例
|
||||
|
||||
这些示例默认 `kustomize` 在您的 `$PATH` 中。
|
||||
|
||||
这些示例通过了 [pre-commit](../../bin/pre-commit.sh) 测试，并且应该与 HEAD 一起使用。
|
||||
|
||||
```
|
||||
go get sigs.k8s.io/kustomize
|
||||
```
|
||||
|
||||
* [hello world](helloWorld.md) - 部署多个不同配置的 Hello World 服务。
|
||||
|
||||
* [last mile helm](../chart.md) - 对 helm chart 进行 last mile 修改。
|
||||
|
||||
* [LDAP](../ldap/README.md) - 部署多个配置不同的 LDAP 服务。
|
||||
|
||||
* [mySql](../mySql/README.md) - 从头开始创建一个 MySQL 的生产配置。
|
||||
|
||||
* [springboot](../springboot/README.md) - 从头开始创建一个 Spring Boot 项目的生产配置。
|
||||
|
||||
* [combineConfigs](../combineConfigs.md) -
|
||||
融合来自不同用户的配置数据（例如来自 devops/SRE 和 developers）。
|
||||
|
||||
* [configGenerations](../configGeneration.md) - 当 ConfigMapGenerator 修改时进行滚动更新。
|
||||
|
||||
* [secret generation](../secretGeneratorPlugin.md) - 生成 Secret。
|
||||
|
||||
* [generatorOptions](../generatorOptions.md) -修改所有 ConfigMapGenerator 和 SecretGenerator 的行为。
|
||||
|
||||
* [breakfast](../breakfast.md) - 给 Alice 和 Bob 定制一顿早餐 :)
|
||||
|
||||
* [vars](../wordpress/README.md) - 通过 vars 将一个资源的数据注入另一个资源的容器参数 （例如，为 wordpress 指定 SQL 服务）。
|
||||
|
||||
* [image names and tags](../image.md) - 在不使用 patch 的情况下更新镜像名称和标签。
|
||||
|
||||
* [multibases](../multibases/README.md) - 使用相同的 base 生成三个 variants（dev，staging，production）。
|
||||
|
||||
* [remote target](../remoteBuild.md) - 通过 github URL 来构建 kustomization 。
|
||||
|
||||
* [json patch](../jsonpatch.md) -在 kustomization 中应用 json patch 。
|
||||
|
||||
* [transformer configs](../transformerconfigs/README.md) - 自定义 transformer 配置。
|
||||
55
examples/zh/README.md
Normal file
55
examples/zh/README.md
Normal file
@@ -0,0 +1,55 @@
|
||||
[English](../README.md) | 简体中文
|
||||
|
||||
# 示例
|
||||
|
||||
这些示例默认 `kustomize` 在您的 `$PATH` 中。
|
||||
|
||||
这些示例通过了 [pre-commit](../../bin/pre-commit.sh) 测试，并且应该与 HEAD 一起使用。
|
||||
|
||||
```
|
||||
go get sigs.k8s.io/kustomize
|
||||
```
|
||||
|
||||
基本用法
|
||||
|
||||
* [configGenerations](../configGeneration.md) - 当 ConfigMapGenerator 修改时进行滚动更新。
|
||||
|
||||
* [combineConfigs](../combineConfigs.md) - 融合来自不同用户的配置数据（例如来自 devops/SRE 和 developers）。
|
||||
|
||||
* [generatorOptions](../generatorOptions.md) -修改所有 ConfigMapGenerator 和 SecretGenerator 的行为。
|
||||
|
||||
* [vars](../wordpress/README.md) - 通过 vars 将一个资源的数据注入另一个资源的容器参数 （例如，为 wordpress 指定 SQL 服务）。
|
||||
|
||||
* [image names and tags](../image.md) - 在不使用 patch 的情况下更新镜像名称和标签。
|
||||
|
||||
* [remote target](../remoteBuild.md) - 通过 github URL 来构建 kustomization 。
|
||||
|
||||
* [json patch](../jsonpatch.md) -在 kustomization 中应用 json patch 。
|
||||
|
||||
高级用法
|
||||
|
||||
- generator 插件:
|
||||
|
||||
* [last mile helm](../chart.md) - 对 helm chart 进行 last mile 修改。
|
||||
|
||||
* [secret generation](../secretGeneratorPlugin.md) - 生成 Secret。
|
||||
|
||||
- 定制内建 transformer 配置
|
||||
|
||||
* [transformer configs](../transformerconfigs/README.md) - 自定义 transformer 配置。
|
||||
|
||||
多 Variant 示例
|
||||
|
||||
* [hello world](helloWorld.md) - 部署多个不同配置的 Hello World 服务。
|
||||
|
||||
* [LDAP](../ldap/README.md) - 部署多个配置不同的 LDAP 服务。
|
||||
|
||||
* [springboot](../springboot/README.md) - 从头开始创建一个 Spring Boot 项目的生产配置。
|
||||
|
||||
* [mySql](../mySql/README.md) - 从头开始创建一个 MySQL 的生产配置。
|
||||
|
||||
* [breakfast](../breakfast.md) - 给 Alice 和 Bob 定制一顿早餐 :)
|
||||
|
||||
* [multibases](../multibases/README.md) - 使用相同的 base 生成三个 variants（dev，staging，production）。
|
||||
|
||||
>声明：部分文档可能稍微滞后于英文版本，同步工作持续进行中
|
||||
@@ -14,10 +14,10 @@
|
||||
|
||||
步骤：
|
||||
|
||||
1. 拉取已经存在的的 [base] 配置。
|
||||
1. 进行定制。
|
||||
1. 基于定制后的 base 新建2个不同的 [overlays] (_staging_ 和 _production_)。
|
||||
1. 运行 kustomize 和 kubectl 来部署 staging 和 production 。
|
||||
1. 下载 [base] 配置。
|
||||
2. 进行定制。
|
||||
3. 基于定制后的 base 新建2个不同的 [overlays] (_staging_ 和 _production_)。
|
||||
4. 运行 kustomize 和 kubectl 来部署 staging 和 production 。
|
||||
|
||||
首先创建一个工作空间：
|
||||
|
||||
@@ -34,8 +34,6 @@ DEMO_HOME=$(mktemp -d)
|
||||
|
||||
## 创建 base
|
||||
|
||||
让我们开始运行 [hello] 服务。
|
||||
|
||||
如果要使用 [overlays] 创建 [variants] ，必须先创建一个共同的 [base] 。
|
||||
|
||||
为了使本文档保持简洁，base 的资源位于补充目录中，并不在此处，请按照下面的方法下载它们：
|
||||
@@ -87,7 +85,7 @@ tree $DEMO_HOME
|
||||
more $BASE/kustomization.yaml
|
||||
```
|
||||
|
||||
（可选）在 base 上运行 `kustomize` 将自定义 resources 输出到 `stdout` ：
|
||||
（可选）在 base 目录上运行 `kustomize` 将定制过的 resources 打印到标准输出：
|
||||
|
||||
<!-- @buildBase @test -->
|
||||
```
|
||||
@@ -116,7 +114,7 @@ kustomize build $BASE | grep -C 3 app:
|
||||
|
||||
* _Staging_ 包含生产环境中无法应用的带有风险的功能。
|
||||
* _Production_ 包含更多的副本数。
|
||||
* 来自这些集群 [variants] 的问候将与来自其他集群的不同。
|
||||
* 来自这些集群 [variants] 的问候消息将与来自其他集群的不同。
|
||||
|
||||
<!-- @overlayDirectories @test -->
|
||||
```
|
||||
@@ -127,7 +125,7 @@ mkdir -p $OVERLAYS/production
|
||||
|
||||
#### Staging Kustomization
|
||||
|
||||
在 `staging` 目录中创建一个 kustomization 文件，用来定义一个新的 name 前缀和一些不同的 labels 。
|
||||
在 `staging` 目录中创建一个 kustomization 文件，用来定义一个新的名称前缀和一些不同的 labels 。
|
||||
|
||||
<!-- @makeStagingKustomization @test -->
|
||||
```
|
||||
@@ -147,7 +145,7 @@ EOF
|
||||
|
||||
#### Staging Patch
|
||||
|
||||
新增一个自定义的 configMap 将问候从 _Good Morning!_ 改为 _Have a pineapple!_ 。
|
||||
新增一个自定义的 configMap 将问候消息从 _Good Morning!_ 改为 _Have a pineapple!_ 。
|
||||
|
||||
同时，将 _risky_ 标记设置为 true 。
|
||||
|
||||
@@ -166,7 +164,7 @@ EOF
|
||||
|
||||
#### Production Kustomization
|
||||
|
||||
在 `production` 目录中创建一个 kustomization 文件，用来定义一个新的 name 前缀和 labels 。
|
||||
在 `production` 目录中创建一个 kustomization 文件，用来定义一个新的名称前缀和 labels 。
|
||||
|
||||
<!-- @makeProductionKustomization @test -->
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user