diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/.vale/gitlab/Acronyms.yml | 1 | ||||
-rw-r--r-- | doc/api/protected_branches.md | 2 | ||||
-rw-r--r-- | doc/api/scim.md | 2 | ||||
-rw-r--r-- | doc/ci/environments/deployment_safety.md | 2 | ||||
-rw-r--r-- | doc/development/changelog.md | 4 | ||||
-rw-r--r-- | doc/integration/jira_development_panel.md | 87 | ||||
-rw-r--r-- | doc/user/group/saml_sso/index.md | 4 | ||||
-rw-r--r-- | doc/user/project/pages/custom_domains_ssl_tls_certification/index.md | 2 |
8 files changed, 96 insertions, 8 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml index c347c663bbf..ae76162dfcf 100644 --- a/doc/.vale/gitlab/Acronyms.yml +++ b/doc/.vale/gitlab/Acronyms.yml @@ -61,6 +61,7 @@ exceptions: - RSA - RSS - SAML + - SCIM - SCP - SCSS - SHA diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md index 1f4f1eb933a..8a3ff1b20e7 100644 --- a/doc/api/protected_branches.md +++ b/doc/api/protected_branches.md @@ -255,7 +255,7 @@ Example response: ### Example with user / group level access **(STARTER)** Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the -form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API in](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3516) in GitLab 10.3 EE. +form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3516) in GitLab 10.3 EE. ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=1" diff --git a/doc/api/scim.md b/doc/api/scim.md index 0a5703ad8db..350f992779e 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -2,7 +2,7 @@ > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9388) in [GitLab Silver](https://about.gitlab.com/pricing/) 11.10. -The SCIM API implements the [the RFC7644 protocol](https://tools.ietf.org/html/rfc7644). +The SCIM API implements the [RFC7644 protocol](https://tools.ietf.org/html/rfc7644). CAUTION: **Caution:** This API is for internal system use for connecting with a SCIM provider. While it can be used directly, it is subject to change without notice. diff --git a/doc/ci/environments/deployment_safety.md b/doc/ci/environments/deployment_safety.md index a0b7adb5279..cdccdef049d 100644 --- a/doc/ci/environments/deployment_safety.md +++ b/doc/ci/environments/deployment_safety.md @@ -32,7 +32,7 @@ Pipeline jobs in GitLab CI/CD run in parallel, so it's possible that two deploym jobs in two different pipelines attempt to deploy to the same environment at the same time. This is not desired behavior as deployments should happen sequentially. -You can ensure only one deployment job runs at a time with the [`resource_group` keyword](../yaml/README.md#resource_group) keyword in your `.gitlab-ci.yml`. +You can ensure only one deployment job runs at a time with the [`resource_group` keyword](../yaml/README.md#resource_group) in your `.gitlab-ci.yml`. For example: diff --git a/doc/development/changelog.md b/doc/development/changelog.md index e83ce40ef60..8aaf4056384 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -43,8 +43,8 @@ the `author` field. GitLab team members **should not**. a changelog entry regardless of these guidelines if the contributor wants one. Example: "Fixed a typo on the search results page." - Any docs-only changes **should not** have a changelog entry. -- Any change behind a feature flag **should not** have a changelog entry - unless - the feature flag has been defaulted to true. +- Any change behind a disabled feature flag **should not** have a changelog entry. +- Any change behind an enabled feature flag **should** have a changelog entry. - A change that [removes a feature flag](feature_flags/development.md) **should** have a changelog entry - only if the feature flag did not default to true already. - A fix for a regression introduced and then fixed in the same release (i.e., diff --git a/doc/integration/jira_development_panel.md b/doc/integration/jira_development_panel.md index dc19d42ee2e..7c646b95ae7 100644 --- a/doc/integration/jira_development_panel.md +++ b/doc/integration/jira_development_panel.md @@ -134,6 +134,93 @@ steps with additional Jira DVCS accounts. Now that the integration is configured, read more about how to test and use it in [Usage](#usage). +#### Troubleshooting your DVCS connection + +Refer to the items in this section if you're having problems with your DVCS connector. + +##### Jira cannot access GitLab server + +```plaintext +Error obtaining access token. Cannot access https://gitlab.example.com from Jira. +``` + +This error message is generated in Jira, after completing the **Add New Account** +form and authorizing access. It indicates a connectivity issue from Jira to +GitLab. No other error messages appear in any logs. + +If there was an issue with SSL/TLS, this error message will be generated. + +- The [GitLab Jira integration](jira.md) requires GitLab to connect to Jira. Any + TLS issues that arise from a private certificate authority or self-signed + certificate [are resolved on the GitLab server](https://docs.gitlab.com/omnibus/settings/ssl.html#other-certificate-authorities), + as GitLab is the TLS client. +- The Jira Development Panel integration requires Jira to connect to GitLab, which + causes Jira to be the TLS client. If your GitLab server's certificate is not + issued by a public certificate authority, the Java truststore on Jira's server + needs to have the appropriate certificate added to it (such as your organization's + root certificate). + +Refer to Atlassian's documentation and Atlassian Support for assistance setting up Jira correctly: + +- [Adding a certificate to the trust store](https://confluence.atlassian.com/kb/how-to-import-a-public-ssl-certificate-into-a-jvm-867025849.html). + - Simplest approach is to use [keytool](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html). + - Add additional roots to Java's default truststore (`cacerts`) to allow Jira to + also trust public certificate authorities. + - If the integration stops working after upgrading Jira's Java runtime, this + might be because the `cacerts` truststore got replaced. + +- [Troubleshooting connectivity up to and including TLS handshaking](https://confluence.atlassian.com/kb/unable-to-connect-to-ssl-services-due-to-pkix-path-building-failed-error-779355358.html), + using the a java class called `SSLPoke`. + +- Download the class from Atlassian's knowledgebase to Jira's server, for example to `/tmp`. +- Use the same Java runtime as Jira. +- Pass all networking-related parameters that Jira is called with, such as proxy + settings or an alternative root truststore (`-Djavax.net.ssl.trustStore`): + +```shell +${JAVA_HOME}/bin/java -Djavax.net.ssl.trustStore=/var/atlassian/application-data/jira/cacerts -classpath /tmp SSLPoke gitlab.example.com 443 +``` + +The message `Successfully connected` indicates a successful TLS handshake. + +If there are problems, the Java TLS library generates errors that you can +look up for more detail. + +##### Jira error adding account and no repositories listed + +```plaintext +Error! +Failed adding the account: [Error retrieving list of repositories] +``` + +This error message is generated in Jira after completing the **Add New Account** +form in Jira and authorizing access. Attempting to click **Try Again** returns +`Account is already integrated with JIRA.` The account is set up in the DVCS +accounts view, but no repositories are listed. + +Potential resolutions: + +- If you're using GitLab versions 11.10-12.7, upgrade to GitLab 12.8.10 or later + to resolve an identified [issue](https://gitlab.com/gitlab-org/gitlab/-/issues/37012). +- The Jira Development Panel integration requires GitLab Premium, GitLab.com Silver, + or a higher tier. If you're using a lower tier of GitLab, you'll need to upgrade + to use this feature. + +[Contact GitLab Support](https://about.gitlab.com/support) if none of these reasons apply. + +#### Fixing synchonization issues + +If Jira displays incorrect information (such as deleted branches), you may need to +resynchronize the information. To do so: + +1. In Jira, go to **Jira Administration > Applications > DVCS accounts**. +1. At the account (group or subgroup) level, Jira displays an option to + **Refresh repositories** in the `...` (ellipsis) menu. +1. For each project, there's a sync button displayed next to the **last activity** date. + To perform a *soft resync*, click the button, or complete a *full sync* by shift clicking + the button. For more information, see + [Atlassian's documentation](https://confluence.atlassian.com/adminjiracloud/synchronize-an-account-972332890.html). + ### GitLab for Jira app You can integrate GitLab.com and Jira Cloud using the [GitLab for Jira](https://marketplace.atlassian.com/apps/1221011/gitlab-for-jira) app in the Atlassian Marketplace. diff --git a/doc/user/group/saml_sso/index.md b/doc/user/group/saml_sso/index.md index f0d0fbff158..f516f4080fa 100644 --- a/doc/user/group/saml_sso/index.md +++ b/doc/user/group/saml_sso/index.md @@ -18,7 +18,7 @@ If you follow our guidance to automate user provisioning using [SCIM](scim_setup User synchronization of SAML SSO groups is supported through [SCIM](scim_setup.md). SCIM supports adding and removing users from the GitLab group. For example, if you remove a user from the SCIM app, SCIM removes that same user from the GitLab group. -SAML SSO is not supported at the subgroup level, +SAML SSO is not supported at the subgroup level. ## Configuring your Identity Provider @@ -265,7 +265,7 @@ Group SAML SSO helps if you need to allow access via multiple SAML identity prov To proceed with configuring Group SAML SSO instead, you'll need to enable the `group_saml` OmniAuth provider. This can be done from: -- `gitlab.rb` for GitLab [Omnibus installations](#omnibus-installations). +- `gitlab.rb` for [Omnibus GitLab installations](#omnibus-installations). - `gitlab/config/gitlab.yml` for [source installations](#source-installations). ### Limitations diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md index 8e8f75be82d..e6912259bfa 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/index.md @@ -100,7 +100,7 @@ as it most likely won't work if you set an [`MX` record](dns_concepts.md#mx-reco Subdomains (`subdomain.example.com`) require: -- A DNS [CNAME record](dns_concepts.md#cname-record) record pointing your subdomain to the Pages server. +- A DNS [CNAME record](dns_concepts.md#cname-record) pointing your subdomain to the Pages server. - A DNS [TXT record](dns_concepts.md#txt-record) to verify your domain's ownership. | From | DNS Record | To | |