Skip to content

Commit

Permalink
website: fix missing translation
Browse files Browse the repository at this point in the history
  • Loading branch information
mozillazg committed May 4, 2023
1 parent f63db3f commit f58f1f2
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 64 deletions.
18 changes: 10 additions & 8 deletions website/docs/credential-plugin/get-kubeconfig.md
Expand Up @@ -5,15 +5,15 @@ sidebar_position: 1

# get-kubeconfig

获取使用 ack-ram-tool 作为 [credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins) 的 kubeconfig。
Obtain a kubeconfig file that uses ack-ram-tool as the [credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins).

包含如下特性:
It has the following features:

* 证书过期前将自动获取新的证书
* 支持使用临时证书
* 集成 ack-ram-authenticator
* Automatically obtains a new certificate before the certificate expires
* Supports using temporary certificate
* Integrate ack-ram-authenticator

## 使用示例
## Usage

```shell
$ ack-ram-tool credential-plugin get-kubeconfig --cluster-id c5e***
Expand Down Expand Up @@ -53,15 +53,17 @@ users:
preferences: {}

$ ack-ram-tool credential-plugin get-kubeconfig --cluster-id c5e*** > kubeconfig
$ proxy_ack kubectl --kubeconfig kubeconfig get ns
$ kubectl --kubeconfig kubeconfig get ns
NAME STATUS AGE
default Active 6d3h
kube-node-lease Active 6d3h
kube-public Active 6d3h
kube-system Active 6d3h
```

### --mode ram-authenticator-token

```
$ ack-ram-tool credential-plugin get-kubeconfig --mode ram-authenticator-token --cluster-id c5e***
kind: Config
Expand Down Expand Up @@ -98,7 +100,7 @@ preferences: {}
```

## 命令行参数
## Flags

```
Usage:
Expand Down
4 changes: 3 additions & 1 deletion website/docs/credential-plugin/get-kubeconfig.zh-CN.md
Expand Up @@ -54,15 +54,17 @@ users:
preferences: {}

$ ack-ram-tool credential-plugin get-kubeconfig --cluster-id c5e*** > kubeconfig
$ proxy_ack kubectl --kubeconfig kubeconfig get ns
$ kubectl --kubeconfig kubeconfig get ns
NAME STATUS AGE
default Active 6d3h
kube-node-lease Active 6d3h
kube-public Active 6d3h
kube-system Active 6d3h
```

### --mode ram-authenticator-token

```
$ ack-ram-tool credential-plugin get-kubeconfig --mode ram-authenticator-token --cluster-id c5e***
kind: Config
Expand Down
20 changes: 9 additions & 11 deletions website/docs/getting-started.md
Expand Up @@ -22,19 +22,17 @@ ack-ram-tool will search for credential information in the system in the followi
1. Automatically use credential information that exists in the environment variables(
Note: This tool also supports the credential-related environment variables supported by [aliyun cli](https://github.com/aliyun/aliyun-cli#support-for-environment-variables) ):

```
# access key id
$ export ALIBABA_CLOUD_ACCESS_KEY_ID=foo
# access key secret
$ export ALIBABA_CLOUD_ACCESS_KEY_SECRET=bar

# sts token (Optional)
$ export ALIBABA_CLOUD_SECURITY_TOKEN=foobar
| environment variables | description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| `ALIBABA_CLOUD_ACCESS_KEY_ID``ALICLOUD_ACCESS_KEY``ALIBABACLOUD_ACCESS_KEY_ID``ALICLOUD_ACCESS_KEY_ID``ALIBABACLOUD_ACCESS_KEY_ID``ACCESS_KEY_ID` | access key id |
| `ALIBABA_CLOUD_ACCESS_KEY_SECRET``ALICLOUD_SECRET_KEY``ALIBABACLOUD_ACCESS_KEY_SECRET``ALICLOUD_ACCESS_KEY_SECRET``ALIBABACLOUD_ACCESS_KEY_SECRET``ACCESS_KEY_SECRET` | access key secret |
| `ALIBABA_CLOUD_SECURITY_TOKEN``ALICLOUD_ACCESS_KEY_STS_TOKEN``ALIBABACLOUD_SECURITY_TOKEN``ALICLOUD_SECURITY_TOKEN``ALIBABACLOUD_SECURITY_TOKEN``SECURITY_TOKEN` | sts token |
| `ALIBABA_CLOUD_CREDENTIALS_URI` | [credentials URI](https://github.com/aliyun/aliyun-cli#use-credentials-uri) |
| `ALIBABA_CLOUD_ROLE_ARN` | RAM Role ARN |
| `ALIBABA_CLOUD_OIDC_PROVIDER_ARN` | OIDC Provider ARN |
| `ALIBABA_CLOUD_OIDC_TOKEN_FILE` | OIDC Token File |

# or use credentials URI: https://github.com/aliyun/aliyun-cli#use-credentials-uri
$ export ALIBABA_CLOUD_CREDENTIALS_URI=http://localhost:6666/?user=jacksontian
```

2. When credential information does not exist in the environment variables, if there is an aliyun cli configuration file
``~/.aliyun/config.json`` (For details on the aliyun cli configuration file,
Expand Down
21 changes: 9 additions & 12 deletions website/docs/getting-started.zh-CN.md
Expand Up @@ -21,19 +21,16 @@ ack-ram-tool 将按照以下顺序在系统中查找凭证信息:
1. 自动使用环境变量中存在的凭证信息 (
注:本工具也支持aliyun cli 所支持的凭证相关[环境变量](https://github.com/aliyun/aliyun-cli#support-for-environment-variables) ):

```
# access key id
$ export ALIBABA_CLOUD_ACCESS_KEY_ID=foo
# access key secret
$ export ALIBABA_CLOUD_ACCESS_KEY_SECRET=bar
| 环境变量 | 含义 |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| `ALIBABA_CLOUD_ACCESS_KEY_ID``ALICLOUD_ACCESS_KEY``ALIBABACLOUD_ACCESS_KEY_ID``ALICLOUD_ACCESS_KEY_ID``ALIBABACLOUD_ACCESS_KEY_ID``ACCESS_KEY_ID` | access key id |
| `ALIBABA_CLOUD_ACCESS_KEY_SECRET``ALICLOUD_SECRET_KEY``ALIBABACLOUD_ACCESS_KEY_SECRET``ALICLOUD_ACCESS_KEY_SECRET``ALIBABACLOUD_ACCESS_KEY_SECRET``ACCESS_KEY_SECRET` | access key secret |
| `ALIBABA_CLOUD_SECURITY_TOKEN``ALICLOUD_ACCESS_KEY_STS_TOKEN``ALIBABACLOUD_SECURITY_TOKEN``ALICLOUD_SECURITY_TOKEN``ALIBABACLOUD_SECURITY_TOKEN``SECURITY_TOKEN` | sts token |
| `ALIBABA_CLOUD_CREDENTIALS_URI` | [credentials URI](https://github.com/aliyun/aliyun-cli#use-credentials-uri) |
| `ALIBABA_CLOUD_ROLE_ARN` | RAM Role ARN |
| `ALIBABA_CLOUD_OIDC_PROVIDER_ARN` | OIDC Provider ARN |
| `ALIBABA_CLOUD_OIDC_TOKEN_FILE` | OIDC Token File |

# sts token (可选)
$ export ALIBABA_CLOUD_SECURITY_TOKEN=foobar
# or use credentials URI: https://github.com/aliyun/aliyun-cli#use-credentials-uri
$ export ALIBABA_CLOUD_CREDENTIALS_URI=http://localhost:6666/?user=jacksontian
```

2. 当环境变量中不存在凭证信息时,如果存在 aliyun cli 的配置文件 ``~/.aliyun/config.json`` (关于 aliyun cli 的配置文件详情请参考
[官方文档](https://www.alibabacloud.com/help/doc-detail/110341.htm) ) ,程序将自动使用该配置文件。
Expand Down
Expand Up @@ -5,15 +5,15 @@ sidebar_position: 1

# get-kubeconfig

获取使用 ack-ram-tool 作为 [credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins) 的 kubeconfig。
Obtain a kubeconfig file that uses ack-ram-tool as the [credential plugin](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#client-go-credential-plugins).

包含如下特性:
It has the following features:

* 证书过期前将自动获取新的证书
* 支持使用临时证书
* 集成 ack-ram-authenticator
* Automatically obtains a new certificate before the certificate expires
* Supports using temporary certificate
* Integrate ack-ram-authenticator

## 使用示例
## Usage

```shell
$ ack-ram-tool credential-plugin get-kubeconfig --cluster-id c5e***
Expand Down Expand Up @@ -53,15 +53,17 @@ users:
preferences: {}

$ ack-ram-tool credential-plugin get-kubeconfig --cluster-id c5e*** > kubeconfig
$ proxy_ack kubectl --kubeconfig kubeconfig get ns
$ kubectl --kubeconfig kubeconfig get ns
NAME STATUS AGE
default Active 6d3h
kube-node-lease Active 6d3h
kube-public Active 6d3h
kube-system Active 6d3h
```

### --mode ram-authenticator-token

```
$ ack-ram-tool credential-plugin get-kubeconfig --mode ram-authenticator-token --cluster-id c5e***
kind: Config
Expand Down Expand Up @@ -98,7 +100,7 @@ preferences: {}
```

## 命令行参数
## Flags

```
Usage:
Expand Down
Expand Up @@ -54,15 +54,17 @@ users:
preferences: {}

$ ack-ram-tool credential-plugin get-kubeconfig --cluster-id c5e*** > kubeconfig
$ proxy_ack kubectl --kubeconfig kubeconfig get ns
$ kubectl --kubeconfig kubeconfig get ns
NAME STATUS AGE
default Active 6d3h
kube-node-lease Active 6d3h
kube-public Active 6d3h
kube-system Active 6d3h
```

### --mode ram-authenticator-token

```
$ ack-ram-tool credential-plugin get-kubeconfig --mode ram-authenticator-token --cluster-id c5e***
kind: Config
Expand Down
20 changes: 9 additions & 11 deletions website/versioned_docs/version-v0.13.0/getting-started.md
Expand Up @@ -22,19 +22,17 @@ ack-ram-tool will search for credential information in the system in the followi
1. Automatically use credential information that exists in the environment variables(
Note: This tool also supports the credential-related environment variables supported by [aliyun cli](https://github.com/aliyun/aliyun-cli#support-for-environment-variables) ):

```
# access key id
$ export ALIBABA_CLOUD_ACCESS_KEY_ID=foo
# access key secret
$ export ALIBABA_CLOUD_ACCESS_KEY_SECRET=bar

# sts token (Optional)
$ export ALIBABA_CLOUD_SECURITY_TOKEN=foobar
| environment variables | description |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| `ALIBABA_CLOUD_ACCESS_KEY_ID``ALICLOUD_ACCESS_KEY``ALIBABACLOUD_ACCESS_KEY_ID``ALICLOUD_ACCESS_KEY_ID``ALIBABACLOUD_ACCESS_KEY_ID``ACCESS_KEY_ID` | access key id |
| `ALIBABA_CLOUD_ACCESS_KEY_SECRET``ALICLOUD_SECRET_KEY``ALIBABACLOUD_ACCESS_KEY_SECRET``ALICLOUD_ACCESS_KEY_SECRET``ALIBABACLOUD_ACCESS_KEY_SECRET``ACCESS_KEY_SECRET` | access key secret |
| `ALIBABA_CLOUD_SECURITY_TOKEN``ALICLOUD_ACCESS_KEY_STS_TOKEN``ALIBABACLOUD_SECURITY_TOKEN``ALICLOUD_SECURITY_TOKEN``ALIBABACLOUD_SECURITY_TOKEN``SECURITY_TOKEN` | sts token |
| `ALIBABA_CLOUD_CREDENTIALS_URI` | [credentials URI](https://github.com/aliyun/aliyun-cli#use-credentials-uri) |
| `ALIBABA_CLOUD_ROLE_ARN` | RAM Role ARN |
| `ALIBABA_CLOUD_OIDC_PROVIDER_ARN` | OIDC Provider ARN |
| `ALIBABA_CLOUD_OIDC_TOKEN_FILE` | OIDC Token File |

# or use credentials URI: https://github.com/aliyun/aliyun-cli#use-credentials-uri
$ export ALIBABA_CLOUD_CREDENTIALS_URI=http://localhost:6666/?user=jacksontian
```

2. When credential information does not exist in the environment variables, if there is an aliyun cli configuration file
``~/.aliyun/config.json`` (For details on the aliyun cli configuration file,
Expand Down
21 changes: 9 additions & 12 deletions website/versioned_docs/version-v0.13.0/getting-started.zh-CN.md
Expand Up @@ -21,19 +21,16 @@ ack-ram-tool 将按照以下顺序在系统中查找凭证信息:
1. 自动使用环境变量中存在的凭证信息 (
注:本工具也支持aliyun cli 所支持的凭证相关[环境变量](https://github.com/aliyun/aliyun-cli#support-for-environment-variables) ):

```
# access key id
$ export ALIBABA_CLOUD_ACCESS_KEY_ID=foo
# access key secret
$ export ALIBABA_CLOUD_ACCESS_KEY_SECRET=bar
| 环境变量 | 含义 |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| `ALIBABA_CLOUD_ACCESS_KEY_ID``ALICLOUD_ACCESS_KEY``ALIBABACLOUD_ACCESS_KEY_ID``ALICLOUD_ACCESS_KEY_ID``ALIBABACLOUD_ACCESS_KEY_ID``ACCESS_KEY_ID` | access key id |
| `ALIBABA_CLOUD_ACCESS_KEY_SECRET``ALICLOUD_SECRET_KEY``ALIBABACLOUD_ACCESS_KEY_SECRET``ALICLOUD_ACCESS_KEY_SECRET``ALIBABACLOUD_ACCESS_KEY_SECRET``ACCESS_KEY_SECRET` | access key secret |
| `ALIBABA_CLOUD_SECURITY_TOKEN``ALICLOUD_ACCESS_KEY_STS_TOKEN``ALIBABACLOUD_SECURITY_TOKEN``ALICLOUD_SECURITY_TOKEN``ALIBABACLOUD_SECURITY_TOKEN``SECURITY_TOKEN` | sts token |
| `ALIBABA_CLOUD_CREDENTIALS_URI` | [credentials URI](https://github.com/aliyun/aliyun-cli#use-credentials-uri) |
| `ALIBABA_CLOUD_ROLE_ARN` | RAM Role ARN |
| `ALIBABA_CLOUD_OIDC_PROVIDER_ARN` | OIDC Provider ARN |
| `ALIBABA_CLOUD_OIDC_TOKEN_FILE` | OIDC Token File |

# sts token (可选)
$ export ALIBABA_CLOUD_SECURITY_TOKEN=foobar
# or use credentials URI: https://github.com/aliyun/aliyun-cli#use-credentials-uri
$ export ALIBABA_CLOUD_CREDENTIALS_URI=http://localhost:6666/?user=jacksontian
```

2. 当环境变量中不存在凭证信息时,如果存在 aliyun cli 的配置文件 ``~/.aliyun/config.json`` (关于 aliyun cli 的配置文件详情请参考
[官方文档](https://www.alibabacloud.com/help/doc-detail/110341.htm) ) ,程序将自动使用该配置文件。
Expand Down

0 comments on commit f58f1f2

Please sign in to comment.