DevOps with GitLab:パラメーター
DevOpsサーバーの設定を、パラメーターグループとして実施できます。
パラメーターグループ
| 作成可能数 | 100 |
- パラメーターグループは、リージョン単位で作成します。
- DevOpsサーバーとパラメーターグループは、お互いに同一リージョンのもののみ適用できます。
- パラメーター変更時、パラメーターが適用されているDevOpsサーバーは再起動されます。
- DevOpsサーバー1台につき1つのパラメーターグループのみ適用できます。
- DevOpsサーバーにパラメーターグループを紐づけできるのは、DevOpsサーバー作成時のみです。
命名時に使用可能な文字
| 設定項目 | 長さ | 主な制約事項 | 備考 |
|---|---|---|---|
| パラメーターグループ名 | 1~63 | 半角英数字、ハイフン | ハイフンは先頭と末尾に使用不可 |
| メモ | ~255 | 全半角 |
パラメーターのデフォルト値
- 新規で作成したパラメーターグループは、すべての項目のパラメーターが空で作成されます。
- 設定が空のパラメーターは、システムデフォルトの仕様が適用されます。
- 各パラメーターの内容は以下の「設定可能なパラメーターの一覧」を確認してください。
設定可能なパラメーターの一覧
パラメーターグループで指定可能なパラメーター名と内容は以下の表の通りです。
カスタムESS設定
DevOpsサーバーから送信されるメールのFromやReply-toをカスタマイズできるパラメーターです。
| パラメーター名 | 内容 | 設定可能な値 |
|---|---|---|
| parameters.smtp_user_name | ESSのSMTPユーザー名を指定します。システムデフォルトのESSを使用する場合はsmtp_user_nameとsmtp_passwordを空に設定します。 | 空文字、50文字以内の文字列 |
| parameters.smtp_password | ESSのSMTP パスワード名を指定します。システムデフォルトのESSを使用する場合はsmtp_user_nameとsmtp_passwordを空に設定します。 | 空文字、50文字以内の文字列 |
| parameters.gitlab_email_from | ESSの認証済みメールアドレスを入力します。DevOpsサーバーから送信されるメールのFromをカスタマイズできます。空文字を設定するとシステムデフォルトのメールアドレス devops-info-{DevOpsサーバー名}-{DevOpsサーバーが稼働しているリージョン名}@system.nifcloud.com となります。 | 空文字、320文字以内の文字列 |
| parameters.gitlab_email_reply_to | ESSの認証済みメールアドレスを入力します。DevOpsサーバーから送信されるメールのReply-Toをカスタマイズできます。 | 空文字、320文字以内の文字列 |
SAML認証連携
DevOpsサーバーのログインにSAML認証を追加できるパラメーターです。
システムデフォルトではSAML認証は無効となっています。 最大5つまで認証先を追加できます。
設定値の詳細はGitLab公式ドキュメントを参照してください。
| パラメーター名 | 内容 | 設定可能な値 | GitLab 設定ファイル(gitlab.rb)内の対応箇所 |
GitLab 公式ドキュメント |
|---|---|---|---|---|
| parameters.omniauth_allow_single_sign_on | SAML 認証を有効にする場合は「saml」を指定し、無効にする場合は空文字を設定します。複数の SAML プロバイダーを設定する場合は、「saml,saml_2,…」のように saml 名をカンマ区切りで指定します。 | 空文字、saml,saml_2,saml_3,saml_4,saml_5 | gitlab_rails['omniauth_allow_single_sign_on'] |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_auto_sign_in_with_provider | 「saml」を指定すると、GitLab のログイン画面を表示した際に自動で SAML 認証画面に遷移します。 | 空文字、saml | gitlab_rails['omniauth_auto_sign_in_with_provider'] |
Configure common settings - GitLab Docs |
| parameters.omniauth_block_auto_created_users | SAML 認証でログインに成功した場合に GitLab 側に自動でユーザーを作成するのを防止できます。自動でユーザーを登録しても良い場合には「false」を設定します。デフォルトは false。 | 空文字、true、false | gitlab_rails['omniauth_block_auto_created_users'] |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_auto_link_saml_user | SAML 認証でログインに成功した場合に GitLab 側に存在する既存ユーザーと自動的にリンクできます。自動でユーザーをリンクさせない場合には「false」を設定します。デフォルトは false。 | 空文字、true、false | gitlab_rails['omniauth_auto_link_saml_user'] |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_providers_saml_name | 「saml」を指定します。SAML 認証を利用しない場合は空文字を指定します。 | 空文字、saml | gitlab_rails['omniauth_providers'] の name |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_providers_saml_label | GitLab のログイン画面に表示される SAML 認証ボタンのラベル名を設定します。 | 空文字、20以内の文字列 | gitlab_rails['omniauth_providers'] の label |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_providers_saml_assertion_consumer_service_url | SAML 認証を使用するアクセス元の URL を設定します。この値は DevOpsサーバーの URL に/users/auth/saml/callback を付与した URL を設定します。 | 空文字、100文字以内の文字列 | gitlab_rails['omniauth_providers'] の args 内、assertion_consumer_service_url |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_providers_saml_idp_cert_fingerprint | IdP が発行するフィンガープリントを設定します。 | 空文字、60文字以内の文字列 | gitlab_rails['omniauth_providers'] の args 内、idp_cert_fingerprint |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_providers_saml_idp_sso_target_url | IdP が発行する SAML 連携時のログイン URL を設定します。 | 空文字、100文字以内の文字列 | gitlab_rails['omniauth_providers'] の args 内、idp_sso_target_url |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_providers_saml_issuer | SAML 認証を使用するアクセス元の URL を設定します。この値は DevOpsサーバーの URL を設定します。 | 空文字、100文字以内の文字列 | gitlab_rails['omniauth_providers'] の args 内、issuer |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_providers_saml_name_identifier_format | IdP が発行するユーザー名を識別するための識別子を設定します。 | 空文字、100文字以内の文字列 | gitlab_rails['omniauth_providers'] の args 内、name_identifier_format |
Configure SAML support in GitLab - GitLab Docs |
| parameters.omniauth_providers_saml_groups_attribute | SAML ログイン成功時にユーザーに付与されるグループ設定を特定するためのキー情報を設定します。IdP 側で設定した設定名と合わせてください。 | 空文字、20文字以内の文字列 | gitlab_rails['omniauth_providers'] の groups_attribute |
Required groups - GitLab Docs |
| parameters.omniauth_providers_saml_required_groups | SAML ログイン成功時にユーザーが所属していなければいけないグループを指定します。複数のグループをカンマ区切りで記載できます。 | 空文字、50文字以内のカンマ区切り文字列 | gitlab_rails['omniauth_providers'] の required_groups |
Required groups - GitLab Docs |
| parameters.omniauth_providers_saml_external_groups | SAML ログイン成功時にユーザーがこのグループに所属していると自動的に外部ユーザーとして登録されます。複数のグループをカンマ区切りで記載できます。 | 空文字、30文字以内のカンマ区切り文字列 | gitlab_rails['omniauth_providers'] の external_groups |
External groups - GitLab Docs |
| parameters.omniauth_providers_saml_admin_groups | SAML ログイン成功時にユーザーがこのグループに所属していると自動的に管理ユーザーとして登録されます。複数のグループをカンマ区切りで記載できます。 | 空文字、30文字以内のカンマ区切り文字列 | gitlab_rails['omniauth_providers'] の admin_groups |
Administrator groups - GitLab Docs |
| parameters.omniauth_providers_saml_auditor_groups | SAML ログイン成功時にユーザーがこのグループに所属していると自動的に読み込み専用ユーザーとして登録されます。複数のグループをカンマ区切りで記載できます。 | 空文字、30文字以内のカンマ区切り文字列 | gitlab_rails['omniauth_providers'] の auditor_groups |
Auditor groups - GitLab Docs |
LDAP認証連携
DevOpsサーバーのログインにLDAP認証を追加できるパラメーターです。
システムデフォルトではLDAP認証は無効となっています。
Premiumライセンスを登録している場合に最大5つまで認証先を追加できます。
設定値の詳細はGitLab公式ドキュメントを参照してください。
| パラメーター名 | 内容 | 設定可能な値 | GitLab 設定ファイル(gitlab.rb)内の対応箇所 |
GitLab 公式ドキュメント |
|---|---|---|---|---|
| parameters.ldap_enabled | LDAP認証を有効にする場合は「true」、無効にする場合は「false」を設定します。デフォルトはfalse。 | 空文字、true、false | gitlab_rails['ldap_enabled'] |
Configure LDAP - GitLab Docs |
| parameters.ldap_servers_name | 連携先LDAPを一意に識別する名前を設定します。LDAP認証を個別に無効にする場合は空文字を設定します。 | 空文字、20文字以内の文字列 | - | - |
| parameters.ldap_servers_label | GitLabのログイン画面に表示されるLDAP認証のラベル名を設定します。 | 空文字、20文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、label |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_host | 連携先LDAPサーバーのホスト名またはIPアドレスを指定します。 | 空文字、255文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、host |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_port | 連携先LDAPサーバーのポート番号を指定します。デフォルトは389。 | 空文字、0~65535の数字 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、port |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_uid | サインインに使用するユーザー名にマップされるLDAP属性を指定します。 | 空文字、30文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、uid |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_base | ユーザーを検索するベースDN名を指定します。 | 空文字、100文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、base |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_encryption | 暗号化方式を指定します。start_tlsやsimple_tlsを指定します。LDAP認証を利用しない場合は空文字を指定します。 | 空文字、start_tls、simple_tls、plain | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、encryption |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_bind_dn | バインドするユーザーのフルDN名を指定します。 | 空文字、100文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、bind_dn |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_password | 連携先LDAPサーバーのパスワードを指定します。 | 空文字、50文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、password |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_verify_certificates | SSL 証明書の検証を有効にするかどうか指定します。falseを設定すると、LDAPサーバーのSSL証明書の検証は実行されません。デフォルトはfalse。 | 空文字、true、false | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、verify_certificates |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_timeout | 連携先LDAPサーバーと接続確認をするタイムアウト時間(秒)を指定します。デフォルトは10。 | 空文字、0~3600の数字 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、timeout |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_active_directory | 連携先LDAPサーバがActiveDirectoryの場合はtrueを指定します。デフォルトはfalse。 | 空文字、true、false | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、active_directory |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_allow_username_or_email_login | trueを設定すると、サインイン時に送信されたLDAPユーザー名の最初のアットマーク以後の値をすべてを無視します。デフォルトはfalse。 | 空文字、true、false | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、allow_username_or_email_login |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_block_auto_created_users | trueを設定した場合は新規で作成されたユーザーは管理者が許可するまでログインできません。デフォルトはfalse。 | 空文字、true、false | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、block_auto_created_users |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_user_filter | LDAPユーザーをフィルタできます。フォーマットはRFC4515です。 | 空文字、200文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、user_filter |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_lowercase_usernames | trueを設定するとGitLabは名前を小文字に変換します。デフォルトはfalse。 | 空文字、true、false | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、lowercase_usernames |
Basic configuration settings - GitLab Docs |
| parameters.ldap_servers_attributes_username | GitLabで使用されるユーザー名のLDAP属性を指定します。 | 空文字、50文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、attributes 内、username |
Attribute configuration settings - GitLab Docs |
| parameters.ldap_servers_attributes_email | GitLabで使用されるユーザー名のメールアドレスのLDAP属性を指定します。 | 空文字、50文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、attributes 内、email |
Attribute configuration settings - GitLab Docs |
| parameters.ldap_servers_attributes_name | GitLabで表示されるユーザー名のLDAP属性を指定します。 | 空文字、20文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、attributes 内、name |
Attribute configuration settings - GitLab Docs |
| parameters.ldap_servers_attributes_first_name | GitLabで表示されるユーザーのファーストネームのLDAP属性を指定します。name属性が存在しない場合に使用します。 | 空文字、20文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、attributes 内、first_name |
Attribute configuration settings - GitLab Docs |
| parameters.ldap_servers_attributes_last_name | GitLabで表示されるユーザーのラストネームのLDAP属性を指定します。name属性が存在しない場合に使用します。 | 空文字、20文字以内の文字列 | gitlab_rails['ldap_servers'] の {parameters.ldap_servers_name} 設定、attributes 内、last_name |
Attribute configuration settings - GitLab Docs |
サンプルリクエスト
curl -XPUT https://jp-east-1.devops.api.nifcloud.com/v1/parameterGroups/gitlab1pg
-H 'X-Amz-Date: 20230401T000000Z'
-H 'Authorization: AWS4-HMAC-SHA256 ...'
-H 'content-type:application/json'
-d '
{
"changedParameterGroupName":"gitlab1pg",
"description":"production_pg",
"parameters":{
"smtp_user_name":"user1",
"smtp_password":"xxxx",
"gitlab_email_from":"a@b",
"gitlab_email_reply_to":"c@d",
"omniauth_allow_single_sign_on":"saml",
"omniauth_auto_sign_in_with_provider":"saml",
"omniauth_block_auto_created_users":"true",
"omniauth_auto_link_saml_user":"false",
"omniauth_providers_saml_name":"saml",
"omniauth_providers_saml_label":"TestSAML",
"omniauth_providers_saml_assertion_consumer_service_url":"https://saml.assertion.consumer.service.url",
"omniauth_providers_saml_idp_cert_fingerprint":"ab:ce:ef:gh:ij:kl:mn:op:qr:st:uv:wx:yz",
"omniauth_providers_saml_idp_sso_target_url":"https://saml.idp.sso.target.url",
"omniauth_providers_saml_issuer":"issuer",
"omniauth_providers_saml_name_identifier_format":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"omniauth_providers_saml_groups_attribute":"groups",
"omniauth_providers_saml_required_groups":"a_group,b_group,c_group,d_group",
"omniauth_providers_saml_external_groups":"a_group",
"omniauth_providers_saml_admin_groups":"b_group",
"omniauth_providers_saml_auditor_groups":"c_group",
"ldap_enabled":"true",
"ldap_servers_name":"main",
"ldap_servers_label":"Login",
"ldap_servers_host":"ldap.server.com",
"ldap_servers_port":"389",
"ldap_servers_uid":"uid",
"ldap_servers_encryption":"start_tls",
"ldap_servers_verify_certificates":"true",
"ldap_servers_bind_dn":"cn=admin,dc=my-company,dc=com",
"ldap_servers_password":"ldappassword",
"ldap_servers_timeout":"10",
"ldap_servers_active_directory":"true",
"ldap_servers_allow_username_or_email_login":"true",
"ldap_servers_block_auto_created_users":"true",
"ldap_servers_base":"dc=my-company,dc=com",
"ldap_servers_user_filter":"(employeeType=developer)",
"ldap_servers_lowercase_usernames":"true",
"ldap_servers_attributes_username":"uid,userid,sAMAccountName",
"ldap_servers_attributes_email":"mail,email,userPrincipalName",
"ldap_servers_attributes_name":"displayName",
"ldap_servers_attributes_first_name":"givenName",
"ldap_servers_attributes_last_name":"sn"
}
}'
フィードバック
サービス利用中のトラブルは、サポート窓口にお願いします。
お役に立ちましたか?