From 762b5a54f0104ca189cbb4b06607d4257ad69a62 Mon Sep 17 00:00:00 2001 From: "H. tktk" Date: Thu, 9 Nov 2017 11:11:07 +0900 Subject: [PATCH 1/3] Translate configure-api.md via GitLocalize --- docs/ja/cluster-management/configure-api.md | 59 +++++++++++++++++---- 1 file changed, 50 insertions(+), 9 deletions(-) diff --git a/docs/ja/cluster-management/configure-api.md b/docs/ja/cluster-management/configure-api.md index 2153fc9d..51ac79e9 100644 --- a/docs/ja/cluster-management/configure-api.md +++ b/docs/ja/cluster-management/configure-api.md @@ -67,7 +67,7 @@ auth: ビルド中に使用されるブックエンドプラグインを設定できます。デフォルトでは`scm`が有効になっており、SCMのcheckoutコマンドでビルドを開始します。 -で開発したブックエンドを使用したい場合は[こちら](#docker%E3%82%B3%E3%83%B3%E3%83%86%E3%83%8A%E3%81%AE%E6%8B%A1%E5%BC%B5)をご覧ください。 +もしご自身で開発したブックエンドを使用したい場合は[こちら](#extending-the-docker-container)をご覧ください。 キー | デフォルト | 説明 --- | --- | --- @@ -163,6 +163,7 @@ datastore: ### Executorプラグイン 現在は[kubernetes](https://github.com/screwdriver-cd/executor-k8s) と [docker](http://github.com/screwdriver-cd/executor-docker) と [VMs in Kubernetes](https://github.com/screwdriver-cd/executor-k8s-vm) と [Jenkins](https://github.com/screwdriver-cd/executor-jenkins) executor をサポートしています。 +詳しくは {a4}custom-environment-variables{/a4} をご覧ください。 #### Kubernetes @@ -170,10 +171,13 @@ datastore: 環境変数名 | デフォルト値 | 説明 --- | --- | --- -EXECUTOR_PLUGIN | | `k8s`を設定します -LAUNCH_VERSION | | 使用するLauncherのバージョン -K8S_HOST | | Kubernetesのホスト -K8S_TOKEN | | Kubernetesのリクエストを認証するためのJWT +EXECUTOR_PLUGIN | k8s | デフォルトのExecutor (例: +`k8s`, + {code1}docker{/code1}, {code2}k8s-vm{/code2}, {code3}jenkins{/code3}) +LAUNCH_VERSION | stable | 使用するLauncherのバージョン +EXECUTOR_K8S_ENABLED | true | Kubernetes executorを利用可能にするフラグ +K8S_HOST | kubernetes.default | Kubernetesのホスト +K8S_TOKEN | Loaded from `/var/run/secrets/kubernetes.io/serviceaccount/token` by default | Kubernetesのリクエストを認証するためのJWT K8S_JOBS_NAMESPACE | default | Kubernetesジョブ用ネームスペース ```yaml @@ -183,7 +187,7 @@ executor: k8s: options: kubernetes: - # The host or IP of the kubernetes cluster + # kubernetes クラスタのホストかIP host: YOUR-KUBERNETES-HOST token: JWT-FOR-AUTHENTICATING-KUBERNETES-REQUEST jobsNamespace: default @@ -198,6 +202,7 @@ executor: --- | --- | --- EXECUTOR_PLUGIN | docker | `docker`を指定します LAUNCH_VERSION | stable | 使用するLauncherのバージョン +EXECUTOR_DOCKER_ENABLED | true | Docker executor を利用可能にするフラグ EXECUTOR_DOCKER_DOCKER | `{}` | [Dockerode の設定](https://www.npmjs.com/package/dockerode#getting-started) (JSONオブジェクト) ```yaml @@ -211,7 +216,11 @@ executor: launchVersion: stable ``` -### Email通知 +### 通知プラグイン + +[Email通知](https://github.com/screwdriver-cd/notifications-email)をサポートしています。 + +#### Email通知 SMTPサーバとEmail通知を行う送信者のアドレスを設定します。 @@ -224,12 +233,44 @@ notifications: from: example@email.com ``` -認証の設定はまだ実装されていませんが、追加することは難しくないでしょう。我々はnodemailerパッケージを使用しているため、認証機能はよくあるnodemailerのセットアップと同様です。コントリビューションお待ちしています:https://github.com/screwdriver-cd/notifications-email +認証の設定はまだ実装されていませんが、追加することは難しくないでしょう。私たちは [nodemailer](https://nodemailer.com/about/) パッケージを使用しているため、認証機能はよくある nodemailer のセットアップと同様です。コントリビューションお待ちしています: [screwdriver-cd/notifications-email](https://github.com/screwdriver-cd/notifications-email) + +#### カスタム通知 + +[notifications-base](https://github.com/screwdriver-cd/notifications-base) を利用することで、カスタム通知パッケージを作成することができます。パッケージ名は `screwdriver-notifications-` の形である必要があります。 + +下記はEmail通知とカスタム通知を同時に使う場合の `local.yaml` の設定例です: + +```yaml +# config/local.yaml +notifications: + email: + host: smtp.yourhost.com + port: 25 + from: example@email.com + your-notification: + foo: bar + abc: 123 +``` + +もし [scoped package](https://docs.npmjs.com/misc/scope) を使用したい場合は、設定は以下のようになります: + +```yaml +# config/local.yaml +notifications: + your-notification: + config: + foo: bar + abc: 123 + scopedPackage: '@scope/screwdriver-notifications-your-notification' +``` ### ソース管理プラグイン 現在は[Github](https://github.com/screwdriver-cd/scm-github) と [Bitbucket.org](https://github.com/screwdriver-cd/scm-bitbucket)をサポートしています。 +*注意: Gitlab はユーザにより開発されたプラグインです。* + #### ステップ1: OAuthアプリケーションをセットアップ OAuthアプリケーションのセットアップと、OAuth Client ID及びSecretの取得が必要です。 @@ -242,7 +283,7 @@ OAuthアプリケーションのセットアップと、OAuth Client ID及びSec ##### Bitbucket.org: -1. Navigate to the Bitbucket OAuth applications: [https://bitbucket.org/account/user/{your-username}/api](https://bitbucket.org/account/user/%7Byour-username%7D/api) +1. Bitbucket OAuth applications ページを開きます: [https://bitbucket.org/account/user/{your-username}/api](https://bitbucket.org/account/user/%7Byour-username%7D/api) 2. `Add Consumer`をクリックします。 3. APIが動作しているホストのIPアドレスを`URL` と `Callback URL` に入力します。 From 0ae7416c4a675ffb8a72964ad30d28c30770a6f0 Mon Sep 17 00:00:00 2001 From: "H. tktk" Date: Thu, 9 Nov 2017 11:14:27 +0900 Subject: [PATCH 2/3] fix some link --- docs/ja/cluster-management/configure-api.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/ja/cluster-management/configure-api.md b/docs/ja/cluster-management/configure-api.md index 51ac79e9..d8251c9f 100644 --- a/docs/ja/cluster-management/configure-api.md +++ b/docs/ja/cluster-management/configure-api.md @@ -163,7 +163,7 @@ datastore: ### Executorプラグイン 現在は[kubernetes](https://github.com/screwdriver-cd/executor-k8s) と [docker](http://github.com/screwdriver-cd/executor-docker) と [VMs in Kubernetes](https://github.com/screwdriver-cd/executor-k8s-vm) と [Jenkins](https://github.com/screwdriver-cd/executor-jenkins) executor をサポートしています。 -詳しくは {a4}custom-environment-variables{/a4} をご覧ください。 +詳しくは [custom-environment-variables](https://github.com/screwdriver-cd/screwdriver/blob/master/config/custom-environment-variables.yaml) をご覧ください。 #### Kubernetes @@ -171,9 +171,7 @@ datastore: 環境変数名 | デフォルト値 | 説明 --- | --- | --- -EXECUTOR_PLUGIN | k8s | デフォルトのExecutor (例: -`k8s`, - {code1}docker{/code1}, {code2}k8s-vm{/code2}, {code3}jenkins{/code3}) +EXECUTOR_PLUGIN | k8s | デフォルトのExecutor (例: `k8s`, `docker`, `k8s-vm`, `jenkins`) LAUNCH_VERSION | stable | 使用するLauncherのバージョン EXECUTOR_K8S_ENABLED | true | Kubernetes executorを利用可能にするフラグ K8S_HOST | kubernetes.default | Kubernetesのホスト @@ -269,7 +267,7 @@ notifications: 現在は[Github](https://github.com/screwdriver-cd/scm-github) と [Bitbucket.org](https://github.com/screwdriver-cd/scm-bitbucket)をサポートしています。 -*注意: Gitlab はユーザにより開発されたプラグインです。* +_注意: Gitlab はユーザにより開発されたプラグインです。_ #### ステップ1: OAuthアプリケーションをセットアップ From 71915f443498193e37c9e0218ae889c4e9f9056e Mon Sep 17 00:00:00 2001 From: "H. tktk" Date: Mon, 13 Nov 2017 10:07:45 +0900 Subject: [PATCH 3/3] fix about scm plugin --- docs/ja/cluster-management/configure-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ja/cluster-management/configure-api.md b/docs/ja/cluster-management/configure-api.md index d8251c9f..d91eeee4 100644 --- a/docs/ja/cluster-management/configure-api.md +++ b/docs/ja/cluster-management/configure-api.md @@ -265,7 +265,7 @@ notifications: ### ソース管理プラグイン -現在は[Github](https://github.com/screwdriver-cd/scm-github) と [Bitbucket.org](https://github.com/screwdriver-cd/scm-bitbucket)をサポートしています。 +現在は[GithubとGitHub Enterprise](https://github.com/screwdriver-cd/scm-github)、 [Bitbucket.org](https://github.com/screwdriver-cd/scm-bitbucket)と[Gitlab](https://github.com/bdangit/scm-gitlab)をサポートしています。 _注意: Gitlab はユーザにより開発されたプラグインです。_