diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-21 12:09:01 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-21 12:09:01 +0300 |
commit | a53d2c37c4934f564caa94543dd4cf5af1703e2d (patch) | |
tree | a028dc39771a4612a9845ab700a73af2d6f3f51b /doc | |
parent | 18b8435318887d3fc6e9f9d305967a953cdd7d3f (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/.linting/vale/styles/gitlab/OxfordComma.yml | 2 | ||||
-rw-r--r-- | doc/.linting/vale/styles/gitlab/SentenceSpacing.yml | 36 | ||||
-rw-r--r-- | doc/README.md | 2 | ||||
-rw-r--r-- | doc/administration/git_protocol.md | 26 | ||||
-rw-r--r-- | doc/administration/job_artifacts.md | 10 | ||||
-rw-r--r-- | doc/api/groups.md | 2 | ||||
-rw-r--r-- | doc/ci/parent_child_pipelines.md | 46 | ||||
-rw-r--r-- | doc/user/application_security/container_scanning/index.md | 6 | ||||
-rw-r--r-- | doc/user/group/issues_analytics/index.md | 5 |
9 files changed, 88 insertions, 47 deletions
diff --git a/doc/.linting/vale/styles/gitlab/OxfordComma.yml b/doc/.linting/vale/styles/gitlab/OxfordComma.yml index c9f4d2895d1..4b37ba8c2b9 100644 --- a/doc/.linting/vale/styles/gitlab/OxfordComma.yml +++ b/doc/.linting/vale/styles/gitlab/OxfordComma.yml @@ -8,4 +8,4 @@ message: Use a comma before the last "and" or "or" in a list of four or more ite link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation level: warning raw: - - '(?:[\w-_` ]+,){2,}(?:[\w-_` ]+) (and|or)' + - '(?:[\w-_` ]+,){2,}(?:[\w-_` ]+) (and |or )' diff --git a/doc/.linting/vale/styles/gitlab/SentenceSpacing.yml b/doc/.linting/vale/styles/gitlab/SentenceSpacing.yml index 5efc6ceeef5..0fc8bfedadc 100644 --- a/doc/.linting/vale/styles/gitlab/SentenceSpacing.yml +++ b/doc/.linting/vale/styles/gitlab/SentenceSpacing.yml @@ -1,32 +1,12 @@ --- -# `extends` indicates the Vale extension point being used. -# Full list of styles: https://errata-ai.github.io/vale/styles/ +# Checks the presence of more than one space between sentences or clauses. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ extends: existence - -# Existence rules can display the matched strings in the user message. -message: "'%s' should have one space between sentences." - -# Should a result be flagged as a suggestion, warning, or error? -# Results that fall below the MinAlertLevel set in -# https://gitlab.com/gitlab-org/gitlab/blob/master/.vale.ini won't be shown. -level: suggestion - -# Should a match be case-insensitive or case-sensitive? -# Acceptable values are 'true' or 'false' -# This value is irrelevant when testing non-alphabetical characters -#ignorecase: true - -# Should this rule be limited to a specific scope? If yes, uncomment the line. -# Possible scopes: https://errata-ai.github.io/vale/formats/#available-scopes -# scope: heading - -# Should this rule ignore normal word boundaries, such as \b ? -# Acceptable values are 'true' or 'false' -nonword: true - -# What is the source for this rule? +message: "'%s' should have one space between sentences or clauses." link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation - +level: warning +nonword: true tokens: - - '[a-z][.?!][A-Z]' - - '[.?!] {2,}[A-Z]' + - '[a-z][.?!,][A-Z]' + - '[.?!,] {2,}[\w]' diff --git a/doc/README.md b/doc/README.md index 132351f5353..3efba168f48 100644 --- a/doc/README.md +++ b/doc/README.md @@ -112,7 +112,7 @@ The following documentation relates to the DevOps **Plan** stage: | [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),<br/>[issue and merge request templates](user/project/description_templates.md),<br/>and [moving issues](user/project/issues/managing_issues.md#moving-issues) | Project issues, restricting access to issues, create templates for submitting new issues and merge requests, and moving issues between projects. | +| [Issues](user/project/issues/index.md), including [confidential issues](user/project/issues/confidential_issues.md),<br/>[issue and merge request templates](user/project/description_templates.md),<br/>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. | | [Labels](user/project/labels.md) | Categorize issues or merge requests with descriptive labels. | | [Milestones](user/project/milestones/index.md) | Set milestones for delivery of issues and merge requests, with optional due date. | | [Project Issue Board](user/project/issue_board.md) | Display issues on a Scrum or Kanban board. | diff --git a/doc/administration/git_protocol.md b/doc/administration/git_protocol.md index 2e5c362a3ab..b15c3160459 100644 --- a/doc/administration/git_protocol.md +++ b/doc/administration/git_protocol.md @@ -4,17 +4,9 @@ description: "Set and configure Git protocol v2" # Configuring Git Protocol v2 -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/46555) in GitLab 11.4. -> Temporarily disabled (see [confidential issue](../user/project/issues/confidential_issues.md) -> `https://gitlab.com/gitlab-org/gitlab-foss/issues/55769`) in GitLab 11.5.8, 11.6.6, 11.7.1, and 11.8+. - -NOTE: **Note:** -Git protocol v2 support has been temporarily disabled -because a feature used to hide certain internal references does not function when it -is enabled, and this has a security impact. Once this problem has been resolved, -protocol v2 support will be re-enabled. For more information, see the -[confidential issue](../user/project/issues/confidential_issues.md) -`https://gitlab.com/gitlab-org/gitlab-foss/issues/55769`. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/46555) in GitLab 11.4. +> - [Temporarily disabled](https://gitlab.com/gitlab-org/gitlab-foss/issues/55769) in GitLab 11.5.8, 11.6.6, 11.7.1, and 11.8+. +> - [Re-enabled](https://gitlab.com/gitlab-org/gitlab/issues/27828) in GitLab 12.8. Git protocol v2 improves the v1 wire protocol in several ways and is enabled by default in GitLab for HTTP requests. In order to enable SSH, @@ -110,3 +102,15 @@ debug1: Sending env GIT_PROTOCOL = version=2 For the server side, you can use the [same examples from HTTP](#http-connections), changing the URL to use SSH. + +### Observe Git protocol version of connections + +To observe what Git protocol versions are being used in a +production environment, you can use the following Prometheus query: + +```prometheus +sum(rate(gitaly_git_protocol_requests_total[1m])) by (grpc_method,git_protocol,grpc_service) +``` + +You can view what Git protocol versions are being used on GitLab.com at +<https://dashboards.gitlab.com/d/pqlQq0xik/git-protocol-versions>. diff --git a/doc/administration/job_artifacts.md b/doc/administration/job_artifacts.md index 441ad2186f6..0c0be1da3c0 100644 --- a/doc/administration/job_artifacts.md +++ b/doc/administration/job_artifacts.md @@ -160,6 +160,11 @@ _The artifacts are stored by default in gitlab-rake gitlab:artifacts:migrate ``` +CAUTION: **CAUTION:** +JUnit test report artifact (`junit.xml.gz`) migration +[is not supported](https://gitlab.com/gitlab-org/gitlab/issues/27698) +by the `gitlab:artifacts:migrate` script. + **In installations from source:** _The artifacts are stored by default in @@ -188,6 +193,11 @@ _The artifacts are stored by default in sudo -u git -H bundle exec rake gitlab:artifacts:migrate RAILS_ENV=production ``` +CAUTION: **CAUTION:** +JUnit test report artifact (`junit.xml.gz`) migration +[is not supported](https://gitlab.com/gitlab-org/gitlab/issues/27698) +by the `gitlab:artifacts:migrate` script. + ### Migrating from object storage to local storage In order to migrate back to local storage: diff --git a/doc/api/groups.md b/doc/api/groups.md index 946626859f8..14e04b9dd17 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -498,7 +498,7 @@ Parameters: ## Transfer project to group -Transfer a project to the Group namespace. Available only to instance administrators. Transferring projects may fail when tagged packages exist in the project's repository. +Transfer a project to the Group namespace. Available only to instance administrators. Transferring projects may fail when tagged packages exist in the project's repository. ``` POST /groups/:id/projects/:project_id diff --git a/doc/ci/parent_child_pipelines.md b/doc/ci/parent_child_pipelines.md index 387f2e69606..f8d100b83b8 100644 --- a/doc/ci/parent_child_pipelines.md +++ b/doc/ci/parent_child_pipelines.md @@ -80,6 +80,52 @@ microservice_a: strategy: depend ``` +## Merge Request child pipelines + +To trigger a child pipeline as a [Merge Request Pipeline](merge_request_pipelines/index.md) we need to: + +- Set the trigger job to run on merge requests: + +```yaml +# parent .gitlab-ci.yml +microservice_a: + trigger: + include: path/to/microservice_a.yml + rules: + - if: $CI_MERGE_REQUEST_ID +``` + +- Configure the child pipeline by either: + + - Setting all jobs in the child pipeline to evaluate in the context of a merge request: + + ```yaml + # child path/to/microservice_a.yml + workflow: + rules: + - if: $CI_MERGE_REQUEST_ID + + job1: + script: ... + + job2: + script: ... + ``` + + - Alternatively, setting the rule per job. For example, to create only `job1` in + the context of merge request pipelines: + + ```yaml + # child path/to/microservice_a.yml + job1: + script: ... + rules: + - if: $CI_MERGE_REQUEST_ID + + job2: + script: ... + ``` + ## Limitations A parent pipeline can trigger many child pipelines, but a child pipeline cannot trigger diff --git a/doc/user/application_security/container_scanning/index.md b/doc/user/application_security/container_scanning/index.md index 8fc3ea4ee98..861c0e53103 100644 --- a/doc/user/application_security/container_scanning/index.md +++ b/doc/user/application_security/container_scanning/index.md @@ -176,7 +176,7 @@ using environment variables. | `CI_APPLICATION_TAG` | Docker respository tag for the image to be scanned. | `$CI_COMMIT_SHA` | | `CLAIR_DB_IMAGE` | The Docker image name and tag for the [Postgres server hosting the vulnerabilities definitions](https://hub.docker.com/r/arminc/clair-db). It can be useful to override this value with a specific version, for example, to provide a consistent set of vulnerabilities for integration testing purposes, or to refer to a locally hosted vulnerabilities database for an on-premise air-gapped installation. | `arminc/clair-db:latest` | | `CLAIR_DB_IMAGE_TAG` | (**DEPRECATED - use `CLAIR_DB_IMAGE` instead**) The Docker image tag for the [Postgres server hosting the vulnerabilities definitions](https://hub.docker.com/r/arminc/clair-db). It can be useful to override this value with a specific version, for example, to provide a consistent set of vulnerabilities for integration testing purposes. | `latest` | -| `DOCKERFILE_PATH` | The path to the `Dockerfile` to be used for generating remediations. By default, the scanner will look for a file named `Dockerfile` in the root directory of the project, so this variable should only be configured if your `Dockerfile` is in a non-standard location, such as a subdirectory. See [Solutions for vulnerabilities](#solutions-for-vulnerabilities-auto-remediation) for more details. | `Dockerfile` | +| `DOCKERFILE_PATH` | The path to the `Dockerfile` to be used for generating remediations. By default, the scanner will look for a file named `Dockerfile` in the root directory of the project, so this variable should only be configured if your `Dockerfile` is in a non-standard location, such as a subdirectory. See [Solutions for vulnerabilities](#solutions-for-vulnerabilities-auto-remediation) for more details. | `Dockerfile` | ## Security Dashboard @@ -352,7 +352,7 @@ the report JSON unless stated otherwise. Presence of optional fields depends on |------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `version` | Report syntax version used to generate this JSON. | | `vulnerabilities` | Array of vulnerability objects. | -| `vulnerabilities[].category` | Where this vulnerability belongs (SAST, Container Scanning etc.). For Container Scanning, it will always be `container_scanning`. | +| `vulnerabilities[].category` | Where this vulnerability belongs (for example, SAST or Container Scanning). For Container Scanning, it will always be `container_scanning`. | | `vulnerabilities[].message` | A short text that describes the vulnerability, it may include occurrence's specific information. Optional. | | `vulnerabilities[].description` | A long text that describes the vulnerability. Optional. | | `vulnerabilities[].cve` | A fingerprint string value that represents a concrete occurrence of the vulnerability. It's used to determine whether two vulnerability occurrences are same or different. May not be 100% accurate. **This is NOT a [CVE](https://cve.mitre.org/)**. | @@ -388,7 +388,7 @@ the report JSON unless stated otherwise. Presence of optional fields depends on ### docker: Error response from daemon: failed to copy xattrs When the GitLab Runner uses the Docker executor and NFS is used -(e.g., `/var/lib/docker` is on an NFS mount), Container Scanning might fail with +(for example, `/var/lib/docker` is on an NFS mount), Container Scanning might fail with an error like the following: ```text diff --git a/doc/user/group/issues_analytics/index.md b/doc/user/group/issues_analytics/index.md index 6c710885b98..4477b9bb1e6 100644 --- a/doc/user/group/issues_analytics/index.md +++ b/doc/user/group/issues_analytics/index.md @@ -4,13 +4,14 @@ type: reference # Issues Analytics **(PREMIUM)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/7478) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/7478) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/196561) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.9 at the project level. Issues Analytics is a bar graph which illustrates the number of issues created each month. The default timespan is 13 months, which includes the current month, and the 12 months prior. -To access the chart, navigate to a group's sidebar and select **Analytics > Issues Analytics**. +To access the chart, navigate to your group or project sidebar and select **{chart}** **Analytics > Issues Analytics**. Hover over each bar to see the total number of issues. |