Skip to content

Commit

Permalink
fix: manually generate a deploy key command (#592)
Browse files Browse the repository at this point in the history
  • Loading branch information
y-oksaku authored Mar 9, 2024
1 parent b4afd2c commit f0f5fa3
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/cluster-management/configure-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -623,7 +623,7 @@ Deploy Keys are SSH keys that grant access to a single GitHub repository. This k

If users want to use deploy keys in their pipeline they have 2 options:
* Enable automatic generation and handling of deploy keys as a part of the pipeline by setting the `autoDeployKeyGeneration` flag to `true` in their `config/local.yaml`. With this flag enabled, the user will get an option to actually trigger the generation in the UI.
* Manually generate the public and private key pair using `openssl genrsa -out jwt.pem 2048` and `openssl rsa -in jwt.pem -pubout -out jwt.pub`. Now add the public key as a deploy key to the repo. The private key needs to be **base64 encoded** and added as a secret `SD_SCM_DEPLOY_KEY` in the pipeline. Refer [secrets](/user-guide/configuration/secrets) for adding secrets.
* Manually generate the public and private key pair using `ssh-keygen -t ed25519 -C "[email protected]" -f sd_deploy_key`. Now add the public key as a deploy key to the repo. The private key needs to be **base64 encoded** and added as a secret `SD_SCM_DEPLOY_KEY` in the pipeline. Refer [secrets](/user-guide/configuration/secrets) for adding secrets.

###### Read-only SCM
Sometimes you might want to have a SCM with read-only access. Users will be able to indirectly create pipelines for an SCM by listing them as a [child pipeline](../user-guide/configuration/externalConfig). Below is an example of an SCM configuration you would add to your SCMs for a read-only one. Users cannot login to the SCM in the UI.
Expand Down
2 changes: 1 addition & 1 deletion docs/ja/cluster-management/configure-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ Deploy Keyは、単一のGitHubリポジトリへのアクセスが許可され

パイプラインでDeploy Keyを利用したい場合、2つの方法があります:
* `config/local.yaml`で、`autoDeployKeyGeneration`のフラグを`true`にすることで、パイプラインの一部としてDeploy Keyの自動生成と処理を有効にします。フラグを`true`にすることで、ユーザはUIで自動生成のオプションを追加できるようになります。
* `openssl genrsa -out jwt.pem 2048`と`openssl rsa -in jwt.pem -pubout -out jwt.pub`を使用して公開鍵と秘密鍵のペアを手動で生成します。そして、公開鍵をDeploy Keyとしてリポジトリに登録します。秘密鍵は**base64でエンコード**される必要があり、それを`SD_SCM_DEPLOY_KEY`のsecretsとしてパイプラインに追加します。secretsの追加方法は、[secrets](/ja/user-guide/configuration/secrets)を参照してください。
* `ssh-keygen -t ed25519 -C "[email protected]" -f sd_deploy_key`を使用して公開鍵と秘密鍵のペアを手動で生成します。そして、公開鍵をDeploy Keyとしてリポジトリに登録します。秘密鍵は**base64でエンコード**される必要があり、それを`SD_SCM_DEPLOY_KEY`のsecretsとしてパイプラインに追加します。secretsの追加方法は、[secrets](/ja/user-guide/configuration/secrets)を参照してください。

###### Read-only SCM
SCMを読み取り専用にしたい場合には、SCMのパイプラインを[child pipeline](../user-guide/configuration/externalConfig)としてリストアップすることで、間接的にSCMのパイプラインを作成できるようになります。以下に、read-only SCMの設定を追加する例を記します。ユーザーはUIでSCMにログインすることはできません。
Expand Down

0 comments on commit f0f5fa3

Please sign in to comment.