Skip to content

Commit 40ed9e6

Browse files
committed
fix zh-doc
1 parent 281f932 commit 40ed9e6

File tree

2 files changed

+42
-41
lines changed

2 files changed

+42
-41
lines changed

examples/zh/chart.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# 使用 kustomize 定义 helm chart
1+
# 使用 kustomize helm chart s进行修改
22

33
[last mile]: https://testingclouds.wordpress.com/2018/07/20/844/
44
[stable chart]: https://github.com/helm/charts/tree/master/stable
55
[Helm charts]: https://github.com/helm/charts
66
[_minecraft_]: https://github.com/helm/charts/tree/master/stable/minecraft
77
[插件]: ../../docs/plugins
88

9-
kustomize 并不会读取 [Helm charts] ,但可以使用[插件]来访问 [Helm charts]
9+
kustomize 并不会读取 [Helm charts] ,但可以使用 generator ß来访问 [Helm charts]
1010

1111
使用 [last mile] 模式来结合 kustomize 和 helm ,使用一个 inflated chart 作为基础,然后使用 kustomize 在部署到集群的途中进行修改。
1212

13-
以下示例中使用的插件编码仅适用于 [stable chart] 仓库中的 chart。该示例虽然使用 [_minecraft_] ,但可以应用于任何 chart。
13+
以下示例中使用的 generator 仅适用于 [stable chart] 仓库中的 chart。该示例虽然使用 [_minecraft_] ,但可以应用于任何 chart。
1414

1515
假设 `helm` 已在你的 `$PATH` 中,建立一个工作空间:
1616

17-
<!-- @makeWorkplace @helmtest -->
17+
<!-- @makeWorkplace @test -->
1818
```bash
1919
DEMO_HOME=$(mktemp -d)
2020
mkdir -p $DEMO_HOME/base
@@ -28,7 +28,7 @@ mkdir -p $DEMO_HOME/prod
2828

2929
这可能涉及许多 kustomizations(参见其他示例),但在本示例中,将 `dev-` 名称前缀添加到所有资源:
3030

31-
<!-- @writeKustDev @helmtest -->
31+
<!-- @writeKustDev @test -->
3232
```bash
3333
cat <<'EOF' >$DEMO_HOME/dev/kustomization.yaml
3434
namePrefix: dev-
@@ -39,7 +39,7 @@ EOF
3939

4040
同上,使用 `namePrefix: prod-` 定义生产 variant :
4141

42-
<!-- @writeKustProd @helmtest -->
42+
<!-- @writeKustProd @test -->
4343
```bash
4444
cat <<'EOF' >$DEMO_HOME/prod/kustomization.yaml
4545
namePrefix: prod-
@@ -52,7 +52,7 @@ EOF
5252

5353
定义这个 base:
5454

55-
<!-- @writeKustDev @helmtest -->
55+
<!-- @writeKustDev @test -->
5656
```bash
5757
cat <<'EOF' >$DEMO_HOME/base/kustomization.yaml
5858
generators:
@@ -66,7 +66,7 @@ base 指向一个名为 `chartInflator.yaml` 的生成配置文件。
6666

6767
创建配置文件 `chartInflator.yaml`,指定 chart 名称为 _minecraft_
6868

69-
<!-- @writeGeneratorConfig @helmtest -->
69+
<!-- @writeGeneratorConfig @test -->
7070
```bash
7171
cat <<'EOF' >$DEMO_HOME/base/chartInflator.yaml
7272
apiVersion: someteam.example.com/v1
@@ -81,7 +81,7 @@ EOF
8181

8282
将插件下载到 `DEMO_HOME` 并赋予其执行权限:
8383

84-
<!-- @installPlugin @helmtest -->
84+
<!-- @installPlugin @test -->
8585
```bash
8686
plugin=plugin/someteam.example.com/v1/chartinflator/ChartInflator
8787
curl -s --create-dirs -o \
@@ -99,7 +99,7 @@ chmod a+x $DEMO_HOME/kustomize/$plugin
9999
tree $DEMO_HOME
100100
```
101101

102-
将会得到类似的东西
102+
将会得倒类似的目录及文件
103103

104104
> ```bash
105105
> /tmp/whatever
@@ -120,7 +120,7 @@ tree $DEMO_HOME
120120
121121
运行 kustomize 定义一个 helper function 来传入正确的环境和常见标志:
122122
123-
<!-- @defineKustomizeIt @helmtest -->
123+
<!-- @defineKustomizeIt @test -->
124124
```
125125
function kustomizeIt {
126126
XDG_CONFIG_HOME=$DEMO_HOME \
@@ -131,7 +131,7 @@ function kustomizeIt {
131131
132132
最终构建 `prod` variant。这里要注意的是,所有资源名称现在都具有 `prod-` 前缀:
133133

134-
<!-- @doProd @helmtest -->
134+
<!-- @doProd @test -->
135135
```bash
136136
clear
137137
kustomizeIt prod
@@ -144,22 +144,23 @@ kustomizeIt prod
144144
diff <(kustomizeIt dev) <(kustomizeIt prod) | more
145145
```
146146

147-
在 base上 运行 kustomize 查看未修改但已 inflated 的 chart。这里的每次调用都是重新下载并 re-inflating chart。
147+
在 base上 运行 kustomize 查看未修改但已展开的 chart。
148+
这里的每次调用都是重新下载并重新展开 chart。
148149

149-
<!-- @showBase @helmtest -->
150+
<!-- @showBase @test -->
150151
```bash
151152
kustomizeIt base
152153
```
153154

154155
## 使用本地 chart
155156

156-
上面的示例由于未在配置中指定本地 chart 的主目录,则使用 kustomize 构建将 chart 的新副本 fetche 到临时目录
157+
上面的示例由于未在配置中指定本地 chart 的主目录,所以kustomize会取得远程chart的副本并存在临时目录中
157158

158-
要禁止 fetche ,请明确指定 chart home ,并确保图表已存在。
159+
要禁止 fetch,请明确指定 `charHome` ,并确保chart 已经被保存在该目录下
159160

160161
要进行演示,并且不会干扰您现有的 helm 环境,请执行以下操作:
161162

162-
<!-- @helmInit @helmtest -->
163+
<!-- @helmInit @test -->
163164
```bash
164165
helmHome=$DEMO_HOME/dothelm
165166
chartHome=$DEMO_HOME/base/charts
@@ -175,14 +176,14 @@ doHelm init --client-only >& /dev/null
175176

176177
现在下载 chart ; 可以再次使用的 [_minecraft_] (也可以使用其他的 chart ):
177178

178-
<!-- @fetchChart @helmtest -->
179+
<!-- @fetchChart @test -->
179180
```bash
180181
doHelm fetch --untar \
181182
--untardir $chartHome \
182183
stable/minecraft
183184
```
184185

185-
使用 tree 查看更多信息;helm 配置数据和完成的 chart 副本:
186+
使用 tree 查看更多信息;helm 配置数据和完整的 chart 副本:
186187

187188
<!-- @tree -->
188189
```bash
@@ -191,24 +192,24 @@ tree $DEMO_HOME
191192

192193
`chartHome` 字段添加到生成器的配置文件中,以便可以查找本地 chart:
193194

194-
<!-- @modifyGenConfig @helmtest -->
195+
<!-- @modifyGenConfig @test -->
195196
```bash
196197
echo "chartHome: $chartHome" >>$DEMO_HOME/base/chartInflator.yaml
197198
```
198199

199200
更改 values 文件,用来展示本地 chart 的更改:
200201

201-
<!-- @valueChange @helmtest -->
202+
<!-- @valueChange @test -->
202203
```
203204
sed -i 's/CHANGEME!/SOMETHINGELSE/' $chartHome/minecraft/values.yaml
204205
sed -i 's/LoadBalancer/NodePort/' $chartHome/minecraft/values.yaml
205206
```
206207

207208
最后进行构建:
208209

209-
<!-- @finalProd @helmtest -->
210+
<!-- @finalProd @test -->
210211
```bash
211212
kustomizeIt prod
212213
```
213214

214-
观察从变化 `LoadBalancer` `NodePort`并更改编码的密码
215+
观察结果中 `LoadBalancer` 变为 `NodePort`并且加密的密码也有所不同

examples/zh/secretGeneratorPlugin.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515

1616
Kubernetes 的 [ConfigMaps][Secrets] 都是key:value map,但 [Secrets] 的内容更为敏感,比如:密码或者 ssh 秘钥。
1717

18-
Kubernetes 开发者以各种方式工作,Secrets 保存的信息相比 ConfigMapsDeployments 等的配置信息需要更谨慎的隐藏。
18+
Kubernetes 开发者以各种方式工作,Secrets 保存的信息相比 ConfigMaps,Deployments 等的配置信息需要更谨慎的隐藏。
1919

2020
## 创建一个工作空间
2121

22-
<!-- @establishBase @testAgainstLatestRelease -->
22+
<!-- @establishBase @test -->
2323
```bash
2424
DEMO_HOME=$(mktemp -d)
2525
```
@@ -36,7 +36,7 @@ kustomize 可以通过三种不同的方式生成来自本地文件的 Secret
3636

3737
创建一个包含一些短密码的 env 文件:
3838

39-
<!-- @makeEnvFile @testAgainstLatestRelease -->
39+
<!-- @makeEnvFile @test -->
4040
```bash
4141
cat <<'EOF' >$DEMO_HOME/foo.env
4242
ROUTER_PASSWORD=admin
@@ -46,7 +46,7 @@ EOF
4646

4747
创建一个长密码的文本文件:
4848

49-
<!-- @makeLongSecretFile @testAgainstLatestRelease -->
49+
<!-- @makeLongSecretFile @test -->
5050
```bash
5151
cat <<'EOF' >$DEMO_HOME/longsecret.txt
5252
Lorem ipsum dolor sit amet,
@@ -56,9 +56,9 @@ ut labore et dolore magna aliqua.
5656
EOF
5757
```
5858

59-
并创建一个参考上面的 kustomization.yaml 文件并且另外定义一些文字 KV 对:
59+
创建一个kustomization.yaml 文件, 其中包含引用上面文件的 secretGenerator, 并且另外定义一些文字 KV 对:
6060

61-
<!-- @makeKustomization1 @testAgainstLatestRelease -->
61+
<!-- @makeKustomization1 @test -->
6262
```bash
6363
cat <<'EOF' >$DEMO_HOME/kustomization.yaml
6464
secretGenerator:
@@ -75,7 +75,7 @@ EOF
7575

7676
生成 Secret :
7777

78-
<!-- @build1 @testAgainstLatestRelease -->
78+
<!-- @build1 @test -->
7979
```bash
8080
result=$(kustomize build $DEMO_HOME)
8181
echo "$result"
@@ -103,23 +103,23 @@ test 1 == $(echo "$result" | grep -c "FRUIT: YXBwbGU=")
103103
104104
使用 base64 解码器确认这些值的原始版本。
105105
106-
这三种方法共同的问题是声明的 secrets 必须保存磁盘上
106+
这三种方法共同的问题是创建 Secret 所使用的敏感数据必须保存磁盘上
107107
108-
这会增加额外的安全问题:对本地存储的 secrets 文件的查看、安装和删除权限的控制等。
108+
这会增加额外的安全问题:对本地存储的敏感文件的查看、安装和删除权限的控制等。
109109
110110
## 来自任何地方的 Secret
111111
112-
一般的替代方案是在[插件](../docs/plugins)中生成 secrets 。
112+
一般的替代方案是在[generator](../../docs/plugins)中生成 secrets 。
113113
114114
然后,这些值可以通过经过身份验证和授权的 RPC 进入密码保险库服务。
115115
116-
[sgp]: ../plugin/someteam.example.com/v1/secretsfromdatabase
116+
[sgp]: ../../plugin/someteam.example.com/v1/secretsfromdatabase
117117
118-
这里有一个[secret 生成插件][sgp],它假装从数据库中拉取 map 中的值。
118+
这里有一个[secret 生成器][sgp],它模拟从数据库中拉取 map 中的值。
119119
120120
下载
121121
122-
<!-- @copyPlugin @testAgainstLatestRelease -->
122+
<!-- @copyPlugin @test -->
123123
```bash
124124
repo=https://raw.githubusercontent.com/kubernetes-sigs/kustomize
125125
pPath=plugin/someteam.example.com/v1/secretsfromdatabase
@@ -131,7 +131,7 @@ curl -s -o $dir/SecretsFromDatabase.go \
131131
${repo}/master/$pPath/SecretsFromDatabase.go
132132
```
133133
134-
进行构建
134+
运行 kustomize build 生成结果
135135
136136
<!-- @compilePlugin @xtest -->
137137
```bash
@@ -142,7 +142,7 @@ go build -buildmode plugin \
142142
143143
创建一个配置文件:
144144
145-
<!-- @makeConfiguration @testAgainstLatestRelease -->
145+
<!-- @makeConfiguration @test -->
146146
```bash
147147
cat <<'EOF' >$DEMO_HOME/secretFromDb.yaml
148148
apiVersion: someteam.example.com/v1
@@ -157,17 +157,17 @@ keys:
157157
EOF
158158
```
159159
160-
创建一个引用此插件的新 kustomization.yaml 文件:
160+
创建一个引用此生成器的新 kustomization.yaml 文件:
161161
162-
<!-- @makeKustomization2 @testAgainstLatestRelease -->
162+
<!-- @makeKustomization2 @test -->
163163
```bash
164164
cat <<'EOF' >$DEMO_HOME/kustomization.yaml
165165
generators:
166166
- secretFromDb.yaml
167167
EOF
168168
```
169169
170-
最终生成 secret ,设置 `XDG_CONFIG_HOME` 以便可以在 `$DEMO_HOME` 中找到该插件
170+
最终生成 secret ,设置 `XDG_CONFIG_HOME` 以便可以在 `$DEMO_HOME` 中找到该生成器
171171
172172
<!-- @build2 @xtest -->
173173
```bash

0 commit comments

Comments
 (0)