From 4cb5e5011abfe8d50ac3a7ebd0018c563c6d7af4 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Fri, 13 Mar 2020 09:09:23 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- .../vale/styles/gitlab/SentenceSpacing.yml | 11 +++-- doc/README.md | 2 +- .../auth/how_to_configure_ldap_gitlab_ce/index.md | 6 +-- .../geo/replication/troubleshooting.md | 6 +-- doc/administration/gitaly/index.md | 4 +- doc/administration/high_availability/README.md | 53 ++++++++++++++------- .../high_availability/monitoring_node.md | 4 +- .../lfs/manage_large_binaries_with_git_lfs.md | 2 +- .../performance/influxdb_configuration.md | 2 +- doc/administration/troubleshooting/sidekiq.md | 2 +- doc/api/epic_issues.md | 14 +++--- doc/api/epics.md | 6 +-- doc/api/group_level_variables.md | 2 +- doc/api/keys.md | 2 + doc/api/merge_request_context_commits.md | 2 +- doc/api/merge_requests.md | 14 +++--- doc/api/pipeline_schedules.md | 2 +- doc/api/services.md | 2 +- doc/api/settings.md | 2 +- doc/api/users.md | 12 ++--- doc/ci/examples/deployment/composer-npm-deploy.md | 2 +- doc/ci/jenkins/index.md | 6 ++- doc/ci/pipelines/schedules.md | 2 +- doc/ci/review_apps/index.md | 3 +- doc/ci/services/postgres.md | 2 +- doc/ci/services/redis.md | 2 +- doc/ci/triggers/README.md | 2 +- doc/ci/yaml/README.md | 12 ++++- doc/development/code_review.md | 2 +- doc/development/contributing/issue_workflow.md | 2 +- doc/development/database_review.md | 2 +- doc/development/fe_guide/development_process.md | 2 +- doc/development/fe_guide/icons.md | 2 +- doc/development/file_storage.md | 2 +- doc/development/permissions.md | 4 +- doc/development/query_recorder.md | 2 +- doc/development/scalability.md | 2 +- .../testing_guide/end_to_end/best_practices.md | 2 +- .../testing_guide/end_to_end/quick_start_guide.md | 2 +- doc/install/aws/index.md | 8 +++- doc/install/installation.md | 2 +- doc/install/requirements.md | 2 +- doc/integration/jira_development_panel.md | 4 +- doc/integration/kerberos.md | 2 +- doc/ssh/README.md | 3 ++ doc/topics/autodevops/index.md | 2 +- doc/user/analytics/value_stream_analytics.md | 10 ++-- doc/user/application_security/index.md | 29 +++++++++++ .../img/policies_maintainer_add_v12_9.png | Bin 0 -> 22423 bytes .../img/policies_maintainer_edit_v12_9.png | Bin 0 -> 35281 bytes .../license_compliance/img/policies_v12_9.png | Bin 0 -> 66698 bytes doc/user/compliance/license_compliance/index.md | 18 ++++++- doc/user/gitlab_com/index.md | 11 +---- doc/user/project/integrations/prometheus.md | 2 +- doc/user/project/issues/design_management.md | 15 +++++- .../img/design_drag_and_drop_uploads_v12_9.png | Bin 0 -> 402118 bytes doc/user/project/merge_requests/code_quality.md | 2 + .../releases/img/release_with_milestone_v12_9.png | Bin 0 -> 27783 bytes doc/user/project/releases/img/releases_v12_9.png | Bin 0 -> 51974 bytes doc/user/project/releases/index.md | 9 ++-- 60 files changed, 209 insertions(+), 115 deletions(-) create mode 100644 doc/user/compliance/license_compliance/img/policies_maintainer_add_v12_9.png create mode 100644 doc/user/compliance/license_compliance/img/policies_maintainer_edit_v12_9.png create mode 100644 doc/user/compliance/license_compliance/img/policies_v12_9.png create mode 100644 doc/user/project/issues/img/design_drag_and_drop_uploads_v12_9.png create mode 100644 doc/user/project/releases/img/release_with_milestone_v12_9.png create mode 100644 doc/user/project/releases/img/releases_v12_9.png (limited to 'doc') diff --git a/doc/.linting/vale/styles/gitlab/SentenceSpacing.yml b/doc/.linting/vale/styles/gitlab/SentenceSpacing.yml index 0fc8bfedadc..b061f7f6f9e 100644 --- a/doc/.linting/vale/styles/gitlab/SentenceSpacing.yml +++ b/doc/.linting/vale/styles/gitlab/SentenceSpacing.yml @@ -1,12 +1,15 @@ --- -# Checks the presence of more than one space between sentences or clauses. +# Check for the following in common content scenarios: +# +# - No spaces. +# - More than one space. # # For a list of all options, see https://errata-ai.github.io/vale/styles/ extends: existence -message: "'%s' should have one space between sentences or clauses." +message: '"%s" must contain one and only one space.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation -level: warning +level: error nonword: true tokens: - '[a-z][.?!,][A-Z]' - - '[.?!,] {2,}[\w]' + - '[\w.?!,\(\)\-":] {2,}[\w.?!,\(\)\-":]' diff --git a/doc/README.md b/doc/README.md index 44d8b3b1932..198f37c9ea1 100644 --- a/doc/README.md +++ b/doc/README.md @@ -109,7 +109,7 @@ The following documentation relates to the DevOps **Plan** stage: | Plan Topics | Description | |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------| | [Burndown Charts](user/project/milestones/burndown_charts.md) **(STARTER)** | Watch your project's progress throughout a specific milestone. | -| [Discussions](user/discussions/index.md) | Threads, comments, and resolvable threads in issues, commits, and merge requests. | +| [Discussions](user/discussions/index.md) | Threads, comments, and resolvable threads in issues, commits, and merge requests. | | [Due Dates](user/project/issues/due_dates.md) | Keep track of issue deadlines. | | [Epics](user/group/epics/index.md) **(ULTIMATE)** | Tracking groups of issues that share a theme. | | [Issues](user/project/issues/index.md), including [confidential issues](user/project/issues/confidential_issues.md),
[issue and merge request templates](user/project/description_templates.md),
and [moving issues](user/project/issues/managing_issues.md#moving-issues) | Project issues and restricting access to issues as well as creating templates for submitting new issues and merge requests. Also, moving issues between projects. | diff --git a/doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md b/doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md index 35620be7d7e..acb39ae0f78 100644 --- a/doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md +++ b/doc/administration/auth/how_to_configure_ldap_gitlab_ce/index.md @@ -14,7 +14,7 @@ GitLab has supported LDAP integration since [version 2.2](https://about.gitlab.c ### Choosing an LDAP Server -The main reason organizations choose to utilize a LDAP server is to keep the entire organization's user base consolidated into a central repository. Users can access multiple applications and systems across the IT environment using a single login. Because LDAP is an open, vendor-neutral, industry standard application protocol, the number of applications using LDAP authentication continues to increase. +The main reason organizations choose to utilize a LDAP server is to keep the entire organization's user base consolidated into a central repository. Users can access multiple applications and systems across the IT environment using a single login. Because LDAP is an open, vendor-neutral, industry standard application protocol, the number of applications using LDAP authentication continues to increase. There are many commercial and open source [directory servers](https://en.wikipedia.org/wiki/Directory_service#LDAP_implementations) that support the LDAP protocol. Deciding on the right directory server highly depends on the existing IT environment in which the server will be integrated with. @@ -32,9 +32,9 @@ For example, [Active Directory](https://docs.microsoft.com/en-us/previous-versio We won't cover the installation and configuration of Windows Server or Active Directory Domain Services in this tutorial. There are a number of resources online to guide you through this process: -- Install Windows Server 2012 - (`technet.microsoft.com`) - [Installing Windows Server 2012](https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/jj134246(v=ws.11)) +- Install Windows Server 2012 - (`technet.microsoft.com`) - [Installing Windows Server 2012](https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2012-R2-and-2012/jj134246(v=ws.11)) -- Install Active Directory Domain Services (AD DS) (`technet.microsoft.com`)- [Install Active Directory Domain Services](https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/deploy/install-active-directory-domain-services--level-100-#BKMK_PS) +- Install Active Directory Domain Services (AD DS) (`technet.microsoft.com`) - [Install Active Directory Domain Services](https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/deploy/install-active-directory-domain-services--level-100-#BKMK_PS) > **Shortcut:** You can quickly install AD DS via PowerShell using `Install-WindowsFeature AD-Domain-Services -IncludeManagementTools` diff --git a/doc/administration/geo/replication/troubleshooting.md b/doc/administration/geo/replication/troubleshooting.md index e075a2b132e..3a8219bdbc2 100644 --- a/doc/administration/geo/replication/troubleshooting.md +++ b/doc/administration/geo/replication/troubleshooting.md @@ -215,7 +215,7 @@ sudo gitlab-rake gitlab:geo:check - Ensure that you entered the `external_url` or `gitlab_rails['geo_node_name']` when adding the secondary node in the admin are of the **primary** node. - Prior to GitLab 12.4, edit the secondary node in the Admin Area of the **primary** node and ensure that there is a trailing `/` in the `Name` field. -1. Check returns Exception: PG::UndefinedTable: ERROR: relation "geo_nodes" does not exist +1. Check returns `Exception: PG::UndefinedTable: ERROR: relation "geo_nodes" does not exist` ```plaintext Checking Geo ... @@ -252,7 +252,7 @@ sudo gitlab-rake gitlab:geo:check The following sections outline troubleshooting steps for fixing replication errors. -### Message: "ERROR: replication slots can only be used if max_replication_slots > 0"? +### Message: `ERROR: replication slots can only be used if max_replication_slots > 0`? This means that the `max_replication_slots` PostgreSQL variable needs to be set on the **primary** database. In GitLab 9.4, we have made this setting @@ -263,7 +263,7 @@ Be sure to restart PostgreSQL for this to take effect. See the [PostgreSQL replication setup][database-pg-replication] guide for more details. -### Message: "FATAL: could not start WAL streaming: ERROR: replication slot "geo_secondary_my_domain_com" does not exist"? +### Message: `FATAL: could not start WAL streaming: ERROR: replication slot "geo_secondary_my_domain_com" does not exist`? This occurs when PostgreSQL does not have a replication slot for the **secondary** node by that name. diff --git a/doc/administration/gitaly/index.md b/doc/administration/gitaly/index.md index c12826c80cd..1bd027ac0c9 100644 --- a/doc/administration/gitaly/index.md +++ b/doc/administration/gitaly/index.md @@ -777,7 +777,7 @@ two checks. The result of both of these checks is cached. see if we can access filesystem underneath the Gitaly server directly. If so, use the Rugged patch. -To see if GitLab Rails can access the repo filesystem directly, we use +To see if GitLab Rails can access the repo filesystem directly, we use the following heuristic: - Gitaly ensures that the filesystem has a metadata file in its root @@ -1010,7 +1010,7 @@ unset https_proxy When updating the `gitaly['listen_addr']` or `gitaly['prometheus_listen_addr']` values, Gitaly may continue to listen on the old address after a `sudo gitlab-ctl reconfigure`. -When this occurs, performing a `sudo gitlab-ctl restart` will resolve the issue. This will no longer be necessary after [this issue](https://gitlab.com/gitlab-org/gitaly/issues/2521) is resolved. +When this occurs, performing a `sudo gitlab-ctl restart` will resolve the issue. This will no longer be necessary after [this issue](https://gitlab.com/gitlab-org/gitaly/issues/2521) is resolved. ### Praefect diff --git a/doc/administration/high_availability/README.md b/doc/administration/high_availability/README.md index e05a34a9c3e..c74beb11241 100644 --- a/doc/administration/high_availability/README.md +++ b/doc/administration/high_availability/README.md @@ -78,24 +78,41 @@ References: ## GitLab components and configuration instructions -The GitLab application depends on the following [components](../../development/architecture.md#component-diagram) -and services. They are included in the reference architectures along with our -recommendations for their use and configuration. They are presented in the order -in which you would typically configure them. - -| Component | Description | Configuration Instructions | -|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------| -| [Load Balancer(s)](load_balancer.md)[^6] | Handles load balancing for the GitLab nodes where required. | [Load balancer HA configuration](load_balancer.md) | -| [Consul](../../development/architecture.md#consul)[^3] | Service discovery and health checks/failover | [Consul HA configuration](consul.md) **(PREMIUM ONLY)** | -| [PostgreSQL](../../development/architecture.md#postgresql) | Database | [Database HA configuration](database.md) | -| [PgBouncer](../../development/architecture.md#pgbouncer) | Database Pool Manager | [PgBouncer HA configuration](pgbouncer.md) **(PREMIUM ONLY)** | -| [Redis](../../development/architecture.md#redis)[^3] with Redis Sentinel | Key/Value store for shared data with HA watcher service | [Redis HA configuration](redis.md) | -| [Gitaly](../../development/architecture.md#gitaly)[^2] [^5] [^7] | Recommended high-level storage for Git repository data. | [Gitaly HA configuration](gitaly.md) | -| [Sidekiq](../../development/architecture.md#sidekiq) | Asynchronous/Background jobs | | -| [Cloud Object Storage service](object_storage.md)[^4] | Recommended store for shared data objects such as LFS, Uploads, Artifacts, etc... | [Cloud Object Storage configuration](object_storage.md) | -| [GitLab application nodes](../../development/architecture.md#unicorn)[^1] | (Unicorn / Puma, Workhorse) - Web-requests (UI, API, Git over HTTP) | [GitLab app HA/scaling configuration](gitlab.md) | -| [NFS](nfs.md)[^5] [^7] | Shared disk storage service. Can be used as an alternative for Gitaly or Object Storage. Required for GitLab Pages. | [NFS configuration](nfs.md) | -| [Prometheus](../../development/architecture.md#prometheus) and [Grafana](../../development/architecture.md#grafana) | GitLab environment monitoring | [Monitoring node for scaling/HA](monitoring_node.md) | +The GitLab application depends on the following [components](../../development/architecture.md#component-diagram). +It can also depend on several third party services depending on +your environment setup. Here we'll detail both in the order in which +you would typically configure them along with our recommendations for +their use and configuration. + +### Third party services + +Here's some details of several third party services a typical environment +will depend on. The services can be provided by numerous applications +or providers and further advice can be given on how best to select. +These should be configured first, before the [GitLab components](#gitlab-components). + +| Component | Description | Configuration instructions | +|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| +| [Load Balancer(s)](load_balancer.md)[^6] | Handles load balancing for the GitLab nodes where required | [Load balancer HA configuration](load_balancer.md) | +| [Cloud Object Storage service](object_storage.md)[^4] | Recommended store for shared data objects | [Cloud Object Storage configuration](object_storage.md) | +| [NFS](nfs.md)[^5] [^7] | Shared disk storage service. Can be used as an alternative for Gitaly or Object Storage. Required for GitLab Pages | [NFS configuration](nfs.md) | + +### GitLab components + +Next are all of the components provided directly by GitLab. As mentioned +earlier, they are presented in the typical order you would configure +them. + +| Component | Description | Configuration instructions | +|---------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------|---------------------------------------------------------------| +| [Consul](../../development/architecture.md#consul)[^3] | Service discovery and health checks/failover | [Consul HA configuration](consul.md) **(PREMIUM ONLY)** | +| [PostgreSQL](../../development/architecture.md#postgresql) | Database | [Database HA configuration](database.md) | +| [PgBouncer](../../development/architecture.md#pgbouncer) | Database Pool Manager | [PgBouncer HA configuration](pgbouncer.md) **(PREMIUM ONLY)** | +| [Redis](../../development/architecture.md#redis)[^3] with Redis Sentinel | Key/Value store for shared data with HA watcher service | [Redis HA configuration](redis.md) | +| [Gitaly](../../development/architecture.md#gitaly)[^2] [^5] [^7] | Recommended high-level storage for Git repository data | [Gitaly HA configuration](gitaly.md) | +| [Sidekiq](../../development/architecture.md#sidekiq) | Asynchronous/Background jobs | | +| [GitLab application nodes](../../development/architecture.md#unicorn)[^1] | (Unicorn / Puma, Workhorse) - Web-requests (UI, API, Git over HTTP) | [GitLab app HA/scaling configuration](gitlab.md) | +| [Prometheus](../../development/architecture.md#prometheus) and [Grafana](../../development/architecture.md#grafana) | GitLab environment monitoring | [Monitoring node for scaling/HA](monitoring_node.md) | In some cases, components can be combined on the same nodes to reduce complexity as well. diff --git a/doc/administration/high_availability/monitoring_node.md b/doc/administration/high_availability/monitoring_node.md index d293fc350fa..a12b865cb91 100644 --- a/doc/administration/high_availability/monitoring_node.md +++ b/doc/administration/high_availability/monitoring_node.md @@ -74,8 +74,8 @@ Omnibus: ## Migrating to Service Discovery Once monitoring using Service Discovery is enabled with `consul['monitoring_service_discovery'] = true`, -ensure that `prometheus['scrape_configs']` is not set in `/etc/gitlab/gitlab.rb`. Setting both -`consul['monitoring_service_discovery'] = true` and `prometheus['scrape_configs']` in `/etc/gitlab/gitlab.rb` +ensure that `prometheus['scrape_configs']` is not set in `/etc/gitlab/gitlab.rb`. Setting both +`consul['monitoring_service_discovery'] = true` and `prometheus['scrape_configs']` in `/etc/gitlab/gitlab.rb` will result in errors.