3.9. ID および承認の管理

手順

1. https://github.com/settings/applications/new にアクセスします。

2. 以下の値を設定します。

   1. アプリケーション名: OpenShift Dev Spaces
   2. Homepage URL: https://<openshift_dev_spaces_fqdn>/
   3. Authorization callback URL: https://<openshift_dev_spaces_fqdn>/api/oauth/callback
3. Register application をクリックします。
4. Generate new client secret をクリックします。

5. GitHub OAuth アプリケーションシークレットを適用する際に使用する GitHub OAuth クライアント ID をコピーし、これを Base64 にエンコードします。

   $ echo -n '<github_oauth_client_id>' | base64

6. GitHub OAuth クライアントシークレットをコピーし、GitHub OAuth App Secret を適用する際に使用する Base64 にエンコードします。

   $ echo -n '<github_oauth_client_secret>' | base64

手順

1. Secret を準備します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: github-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: oauth-scm-configuration
     annotations:
       che.eclipse.org/oauth-scm-server: github
       che.eclipse.org/scm-server-endpoint: <github_server_url> 2
       che.eclipse.org/scm-github-disable-subdomain-isolation: "<true_or_false>" 3
   type: Opaque
   data:
     id: <Base64_GitHub_OAuth_Client_ID> 4
     secret: <Base64_GitHub_OAuth_Client_Secret> 5

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   2

   これは、組織が使用している GitHub 製品によって異なります。GitHub.com または GitHub Enterprise Cloud でリポジトリーをホストする場合は、この行を省略するか、デフォルトの https://github.com を入力します。GitHub Enterprise Server でリポジトリーをホストする場合は、GitHub Enterprise Server の URL を入力します。

   3

   この行は GitHub Enterprise Server に対してのみ追加されます。サブドメイン分離を無効にするには、これを "true" に設定します。サブドメイン分離を有効にするには、これを "false" に設定します。

   4

   Base64 でエンコードされた GitHubOAuth クライアント ID。

   5

   base64 でエンコードされた GitHub OAuth クライアントシークレット。

2. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 出力に Secret が作成されたことを確認します。

手順

1. アバターをクリックして、プロファイル アプリケーション の編集に移動します。
2. Name に OpenShift Dev Spaces を入力します。
3. Redirect URI として https://<openshift_dev_spaces_fqdn>/api/oauth/callback を入力します。
4. Confidential および Expire access tokens のチェックボックスを選択します。
5. Scopes の下で、api、write_repository、および openid のチェックボックスにチェックを入れます。
6. Save application をクリックします。

7. GitLab アプリケーション ID をコピーし、GitLab で承認されたアプリケーションシークレットを適用するときに使用する Base64 にエンコードします。

   $ echo -n '<gitlab_application_id>' | base64

8. GitLab クライアントシークレット をコピーし、GitLab で承認されたアプリケーションシークレットを適用するときに使用する Base64 にエンコードします。

   $ echo -n '<gitlab_client_secret>' | base64

手順

1. Secret を準備します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: gitlab-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: oauth-scm-configuration
     annotations:
       che.eclipse.org/oauth-scm-server: gitlab
       che.eclipse.org/scm-server-endpoint: <gitlab_server_url> 2
   type: Opaque
   data:
     id: <Base64_GitLab_Application_ID> 3
     secret: <Base64_GitLab_Client_Secret> 4

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   2

   GitLab サーバーの URL です。SAAS バージョンには https://gitlab.com を使用します。

   3

   Base64 でエンコードされた GitLab アプリケーション ID。

   4

   Base64 でエンコードされた GitLab クライアントシークレット。

2. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 出力に Secret が作成されたことを確認します。

手順

1. Administration > Applications > Application links に移動します。
2. Creae List を選択します。
3. External application および Incoming を選択します。
4. Redirect URL フィールドに https://<openshift_dev_spaces_fqdn>/api/oauth/callback を入力します。
5. Application permissions で Admin - Write チェックボックスを選択します。
6. Save をクリックします。

7. Client ID をコピーし、Bitbucket アプリケーションリンクのシークレットを適用するときに使用できるように Base64 にエンコードします。

   $ echo -n '<Bitbucket_Client_ID>' | base64

8. Client secret をコピーし、Bitbucket アプリケーションリンクシークレットを適用するときに使用できるように Base64 にエンコードします。

   $ echo -n '<Bitbucket_Client_secret>' | base64

手順

1. Secret を準備します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: bitbucket-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: oauth-scm-configuration
     annotations:
       che.eclipse.org/oauth-scm-server: bitbucket
       che.eclipse.org/scm-server-endpoint: <bitbucket_server_url> 2
   type: Opaque
   data:
     id: <Base64_Bitbucket_Client_ID> 3
     secret: <Base64_Bitbucket_Client_Secret> 4

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   2

   Bitbucket Server の URL。

   3

   Base64 でエンコードされた Bitbucket Client ID。

   4

   Base64 でエンコードされた Bitbucket Client secret。

2. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 出力に Secret が作成されたことを確認します。

手順

1. アバターをクリックして、All workspaces ページに移動します。
2. ワークスペースを選択してクリックします。
3. Settings OAuth consumers Add consumer に移動します。
4. Name に OpenShift Dev Spaces を入力します。
5. Callback URL として https://<openshift_dev_spaces_fqdn>/api/oauth/callback と入力します。
6. Permissions で、Account と Repositories のすべてのチェックボックスをオンにして、Save をクリックします。

7. 追加したコンシューマーを展開してから、キー 値をコピーして Base64 にエンコードし、Bitbucket OAuth コンシューマーシークレットを適用するときに使用します。

   $ echo -n '<bitbucket_oauth_consumer_key>' | base64

8. Bitbucket OAuth コンシューマーシークレットを適用するときに使用するために、Secret 値をコピーして Base64 にエンコードします。

   $ echo -n '<bitbucket_oauth_consumer_secret>' | base64

手順

1. Secret を準備します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: bitbucket-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: oauth-scm-configuration
     annotations:
       che.eclipse.org/oauth-scm-server: bitbucket
   type: Opaque
   data:
     id: <Base64_Bitbucket_Oauth_Consumer_Key> 2
     secret: <Base64_Bitbucket_Oauth_Consumer_Secret> 3

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   2

   Base64 でエンコードされた Bitbucket OAuth コンシューマーキー。

   3

   Base64 でエンコードされた Bitbucket OAuth コンシューマーシークレット。

2. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 出力に Secret が作成されたことを確認します。

手順

1. コマンドラインでコマンドを実行して、次の手順に必要なファイルを作成し、アプリケーションリンクシークレットを適用するときに使用します。

   $ openssl genrsa -out private.pem 2048 && \
   openssl pkcs8 -topk8 -inform pem -outform pem -nocrypt -in private.pem -out privatepkcs8.pem && \
   cat privatepkcs8.pem | sed 's/-----BEGIN PRIVATE KEY-----//g' | sed 's/-----END PRIVATE KEY-----//g' | tr -d '\n' | base64 | tr -d '\n' > privatepkcs8-stripped.pem && \
   openssl rsa -in private.pem -pubout > public.pub && \
   cat public.pub | sed 's/-----BEGIN PUBLIC KEY-----//g' | sed 's/-----END PUBLIC KEY-----//g' | tr -d '\n' > public-stripped.pub && \
   openssl rand -base64 24 > bitbucket-consumer-key && \
   openssl rand -base64 24 > bitbucket-shared-secret

2. Administration Application Links に移動します。
3. URL フィールドに https://<openshift_dev_spaces_fqdn>/ と入力し、Create new link をクリックします。
4. 提供されたアプリケーション URL が一度リダイレクトされました で、この URL を使用する チェックボックスをオンにして、続行 をクリックします。
5. Application Name に OpenShift Dev Spaces を入力します。
6. Application Type として Generic Application を選択します。
7. OpenShift Dev Spaces を Service Provider Name として入力します。
8. bitbucket-consumer-key ファイルの内容を Consumer キー として貼り付けます。
9. bitbucket-shared-secret ファイルの内容を Shared シークレット として貼り付けます。
10. リクエストトークンの URL として <bitbucket_server_url>/plugins/servlet/oauth/request-token と入力します。
11. アクセストークンの URL として <bitbucket_server_url>/plugins/servlet/oauth/access-token と入力します。
12. Authorize URL として <bitbucket_server_url>/plugins/servlet/oauth/authorize と入力します。
13. 受信リンクの作成 チェックボックスをオンにして、続行 をクリックします。
14. bitbucket-consumer-key ファイルの内容を Consumer Key として貼り付けます。
15. コンシューマー名 として OpenShift Dev Spaces を入力します。
16. public-stripped.pub ファイルの内容を 公開鍵 として貼り付け、Continue をクリックします。

手順

1. bitbucket-consumer-key ファイルの内容を Base64 にエンコードします。

   $ echo -n '<bitbucket-consumer-key file content>' | base64

2. bitbucket-shared-secret ファイルの内容を Base64 にエンコードします。

   $ echo -n '<bitbucket-shared-secret file content>' | base64

3. Secret を準備します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: bitbucket-oauth-config
     namespace: openshift-devspaces 1
     labels:
       app.kubernetes.io/component: oauth-scm-configuration
       app.kubernetes.io/part-of: che.eclipse.org
     annotations:
       che.eclipse.org/oauth-scm-server: bitbucket
       che.eclipse.org/scm-server-endpoint: <bitbucket_server_url> 2
   type: Opaque
   data:
     private.key: <Base64_content_of_privatepkcs8-stripped.pem> 3
     consumer.key: <Base64_content_of_bitbucket-consumer-key> 4
     shared_secret: <Base64_content_of_bitbucket-shared-secret> 5

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   2

   Bitbucket Server の URL。

   3

   privatepkcs8-stripped.pem ファイルの内容。ファイルの生成時に Base64 でエンコードされました。

   4

   手順 1 で手動で Base64 にエンコードした bitbucket-consumer-key ファイルの内容。

   5

   手順 2 で手動で Base64 にエンコードした bitbucket-shared-secret ファイルの内容。

4. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

5. 出力に Secret が作成されたことを確認します。

手順

1. https://app.vsaex.visualstudio.com/app/register/ にアクセスしてください。

2. 以下の値を設定します。

   1. 会社名: OpenShift Dev Spaces
   2. アプリケーション名: OpenShift Dev Spaces
   3. Application website: https://<openshift_dev_spaces_fqdn>/
   4. Authorization callback URL: https://<openshift_dev_spaces_fqdn>/api/oauth/callback
3. Select Authorized scopes で、Code (read and write) を選択します。
4. Create application をクリックします。

5. Microsoft Azure DevOps Services OAuth アプリケーションシークレットを適用する際に使用するために、アプリケーション ID をコピーし、Base64 にエンコードします。

   $ echo -n '<microsoft_azure_devops_services_oauth_app_id>' | base64

6. Show をクリックして、Client Secret を表示します。

7. Microsoft Azure DevOps Services OAuth アプリケーションシークレットを適用する際に使用するために、クライアントシークレット をコピーし、Base64 にエンコードします。

   $ echo -n '<microsoft_azure_devops_services_oauth_client_secret>' | base64

手順

1. Secret を準備します。

   kind: Secret
   apiVersion: v1
   metadata:
     name: azure-devops-oauth-config
     namespace: openshift-devspaces1
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: oauth-scm-configuration
     annotations:
       che.eclipse.org/oauth-scm-server: azure-devops
   type: Opaque
   data:
     id: <Base64_Microsoft_Azure_DevOps_Services_OAuth_App_ID>2
     secret: <Base64_Microsoft_Azure_DevOps_Services_OAuth_Client_Secret>3

   1

   OpenShift Dev Spaces namespace。デフォルトは openshift-devspaces です。

   2

   Base64 エンコードされた Microsoft Azure DevOps Services OAuth アプリケーション ID。

   3

   Base64 エンコードされた Microsoft Azure DevOps Services OAuth クライアントシークレット。

2. シークレットを適用します。

   $ oc apply -f - <<EOF
   <Secret_prepared_in_the_previous_step>
   EOF

3. 出力に Secret が作成されたことを確認します。