diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-10 03:10:01 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-10 03:10:01 +0000 |
commit | f9317c6ad25735ecff6ed7dd474b9cddd930c603 (patch) | |
tree | 1d9a6dd91473674998c1995c341a51176757d80e /doc | |
parent | 1b47b087e6c36f8dc38162d7712f01173c7b85cf (diff) | |
download | gitlab-ce-f9317c6ad25735ecff6ed7dd474b9cddd930c603.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/job_artifacts.md | 45 | ||||
-rw-r--r-- | doc/api/merge_requests.md | 16 | ||||
-rw-r--r-- | doc/ci/environments/index.md | 5 | ||||
-rw-r--r-- | doc/development/documentation/styleguide/word_list.md | 13 | ||||
-rw-r--r-- | doc/update/deprecations.md | 8 |
5 files changed, 50 insertions, 37 deletions
diff --git a/doc/administration/job_artifacts.md b/doc/administration/job_artifacts.md index 46a9ee11679..53584e1ff8b 100644 --- a/doc/administration/job_artifacts.md +++ b/doc/administration/job_artifacts.md @@ -2,20 +2,18 @@ stage: Verify group: Testing info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments -type: reference, howto --- # Jobs artifacts administration **(FREE SELF)** This is the administration documentation. For the user guide see [pipelines/job_artifacts](../ci/pipelines/job_artifacts.md). -Artifacts is a list of files and directories which are attached to a job after it -finishes. This feature is enabled by default in all GitLab installations. Keep reading -if you want to know how to disable it. +An artifact is a list of files and directories attached to a job after it +finishes. This feature is enabled by default in all GitLab installations. ## Disabling job artifacts -To disable artifacts site-wide, follow the steps below. +To disable artifacts site-wide: **In Omnibus installations:** @@ -41,7 +39,7 @@ To disable artifacts site-wide, follow the steps below. ## Storing job artifacts GitLab Runner can upload an archive containing the job artifacts to GitLab. By default, -this is done when the job succeeds, but can also be done on failure, or always, via the +this is done when the job succeeds, but can also be done on failure, or always, with the [`artifacts:when`](../ci/yaml/index.md#artifactswhen) parameter. Most artifacts are compressed by GitLab Runner before being sent to the coordinator. The exception to this is @@ -84,8 +82,6 @@ _The artifacts are stored by default in ### Using object storage -> Introduced in GitLab 11.0: Support for `direct_upload` to S3. - If you don't want to use the local disk where GitLab is installed to store the artifacts, you can use an object storage like AWS S3 instead. This configuration relies on valid AWS credentials to be configured already. @@ -108,7 +104,9 @@ In GitLab 13.2 and later, we recommend using the [consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration). This section describes the earlier configuration format. -For source installations the following settings are nested under `artifacts:` and then `object_store:`. On Omnibus GitLab installs they are prefixed by `artifacts_object_store_`. +For source installations the following settings are nested under `artifacts:` +and then `object_store:`. On Omnibus GitLab installs they are prefixed by +`artifacts_object_store_`. | Setting | Default | Description | |---------------------|---------|-------------| @@ -143,8 +141,9 @@ _The artifacts are stored by default in } ``` - NOTE: For GitLab 9.4+, if you're using AWS IAM profiles, be sure to omit the - AWS access key and secret access key/value pairs. For example: + NOTE: + If you're using AWS IAM profiles, omit the AWS access key and secret access + key/value pairs. For example: ```ruby gitlab_rails['artifacts_object_store_connection'] = { @@ -161,7 +160,7 @@ _The artifacts are stored by default in gitlab-rake gitlab:artifacts:migrate ``` -1. Optional: Verify all files migrated properly. +1. Optional. Verify all files migrated properly. From [PostgreSQL console](https://docs.gitlab.com/omnibus/settings/database.html#connecting-to-the-bundled-postgresql-database) (`sudo gitlab-psql -d gitlabhq_production`) verify `objectstg` below (where `file_store=2`) has count of all artifacts: @@ -503,13 +502,13 @@ If you need to manually remove job artifacts associated with multiple jobs while - `3.months.ago` - `1.year.ago` - `erase_erasable_artifacts!` is a synchronous method, and upon execution, the artifacts are removed immediately. - They are not scheduled via some background queue. + `erase_erasable_artifacts!` is a synchronous method, and upon execution the artifacts are immediately removed; + they are not scheduled by a background queue. #### Delete job artifacts and logs from jobs completed before a specific date WARNING: -These commands remove data permanently from the database and from disk. We +These commands remove data permanently from both the database and from disk. We highly recommend running them only under the guidance of a Support Engineer, or running them in a test environment with a backup of the instance ready to be restored, just in case. @@ -517,7 +516,7 @@ restored, just in case. If you need to manually remove **all** job artifacts associated with multiple jobs, **including job logs**, this can be done from the Rails console (`sudo gitlab-rails console`): -1. Select jobs to be deleted: +1. Select the jobs to be deleted: To select jobs with artifacts for a single project: @@ -538,7 +537,7 @@ If you need to manually remove **all** job artifacts associated with multiple jo admin_user = User.find_by(username: 'username') ``` -1. Erase job artifacts and logs older than a specific date: +1. Erase the job artifacts and logs older than a specific date: ```ruby builds_to_clear = builds_with_artifacts.where("finished_at < ?", 1.week.ago) @@ -563,34 +562,34 @@ If you need to manually remove **all** job artifacts associated with multiple jo ### Error `Downloading artifacts from coordinator... not found` -When a job tries to download artifacts from an earlier job, you might receive an error similar to: +When a job attempts to download artifacts from an earlier job, you might receive an error message similar to: ```plaintext Downloading artifacts from coordinator... not found id=12345678 responseStatus=404 Not Found ``` -This might be caused by a `gitlab.rb` file with the following configuration: +This can be caused by a `gitlab.rb` file with the following configuration: ```ruby gitlab_rails['artifacts_object_store_background_upload'] = false gitlab_rails['artifacts_object_store_direct_upload'] = true ``` -To prevent this, comment out or remove those lines, or switch to their [default values](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template), +To prevent this, comment out or remove those lines, or switch to their [default values](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template), and then run `sudo gitlab-ctl reconfigure`. ### Job artifact upload fails with error 500 If you are using object storage for artifacts and a job artifact fails to upload, -you can check: +review: -- The job log for an error similar to: +- The job log for an error message similar to: ```plaintext WARNING: Uploading artifacts as "archive" to coordinator... failed id=12345 responseStatus=500 Internal Server Error status=500 token=abcd1234 ``` -- The [workhorse log](logs.md#workhorse-logs) for an error similar to: +- The [workhorse log](logs.md#workhorse-logs) for an error message similar to: ```json {"error":"MissingRegion: could not find region configuration","level":"error","msg":"error uploading S3 session","time":"2021-03-16T22:10:55-04:00"} diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index f9f1b8b1bb5..fa713558684 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -1,15 +1,11 @@ --- stage: Create group: Code Review -info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments" -type: reference, api +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Merge requests API **(FREE)** -> - `author_id`, `author_username`, and `assignee_id` were [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5. -> - `my_reaction_emoji` was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0. -> - For the `scope` attribute, `created-by-me` and `assigned-to-me` were [deprecated](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935) in favor of `created_by_me` and `assigned_to_me` in GitLab 11.0. > - `with_labels_details` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) in GitLab 12.7. > - `author_username` and `author_username` were [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 12.10. > - `reference` was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) in GitLab 12.10 in favour of `references`. @@ -52,8 +48,6 @@ still apply. ## List merge requests -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5. - Get all merge requests the authenticated user has access to. By default it returns only merge requests created by the current user. To get all merge requests, use parameter `scope=all`. @@ -467,14 +461,14 @@ Parameters: | `updated_after` | datetime | no | Return merge requests updated on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). | | `updated_before` | datetime | no | Return merge requests updated on or before the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`). | | `scope` | string | no | Return merge requests for the given scope: `created_by_me`, `assigned_to_me` or `all`. | -| `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5)_. | +| `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. | | `author_username` | string | no | Returns merge requests created by the given `username`. Mutually exclusive with `author_id`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 12.10)_. | -| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5)_. | +| `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. | | `approver_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | | `approved_by_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | | `reviewer_id` | integer | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`. | | `reviewer_username` | string | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. | -| `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0)_. | +| `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. | | `source_branch` | string | no | Return merge requests with the given source branch. | | `target_branch` | string | no | Return merge requests with the given target branch. | | `search` | string | no | Search merge requests against their `title` and `description`. | @@ -976,8 +970,6 @@ Parameters: ## List MR pipelines -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15454) in GitLab 10.5. - Get a list of merge request pipelines. ```plaintext diff --git a/doc/ci/environments/index.md b/doc/ci/environments/index.md index 8e88c5f89e8..561507cab97 100644 --- a/doc/ci/environments/index.md +++ b/doc/ci/environments/index.md @@ -773,10 +773,11 @@ fetch = +refs/environments/*:refs/remotes/origin/environments/* ### Archive Old Deployments -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/73628) in GitLab 14.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/73628) in GitLab 14.5. +> - [Enabled on GitLab.com and self-managed](https://gitlab.com/gitlab-org/gitlab/-/issues/337507) in GitLab 14.6. FLAG: -On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, ask an administrator to [enable the feature flag](../../administration/feature_flags.md) named `deployments_archive`. On GitLab.com, this feature will be rolled out gradually. +On self-managed GitLab, by default this feature is available. To hide the feature per project or for your entire instance, ask an administrator to [disable the feature flag](../../administration/feature_flags.md) named `deployments_archive`. On GitLab.com, this feature is available. When a new deployment happens in your project, GitLab creates [a special Git-ref to the deployment](#check-out-deployments-locally). diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index b55c7a5dd30..5a497da0ea9 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -511,6 +511,19 @@ In this example, **only** modifies the noun **projects**. The sentence means you In this example, **only** modifies the verb **create**. This sentence means that you can't perform other actions, like deleting private projects, or adding users to them. +## override + +Use **override** to indicate temporary replacement. + +For example, a value might be overridden when a job runs. The +original value does not change. + +## overwrite + +Use **overwrite** to indicate permanent replacement. + +For example, a log file might overwrite a log file of the same name. + ## Owner When writing about the Owner role: diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index 20c6d692cf6..df25146e836 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -110,6 +110,14 @@ In milestone 15.0, we will completely remove `Version` from `PackageType`. Announced: 2021-11-22 +### Deprecate legacy approval status names from License Compliance API + +We deprecated legacy names for approval status of license policy (blacklisted, approved) in the `managed_licenses` API but they are still used in our API queries and responses. They will be removed in 15.0. + +If you are using our License Compliance API you should stop using the `approved` and `blacklisted` query parameters, they are now `allowed` and `denied`. In 15.0 the responses will also stop using `approved` and `blacklisted` so you need to adjust any of your custom tools to use the old and new values so they do not break with the 15.0 release. + +Announced: 2021-12-22 + ### Deprecate support for SLES 12 SP2 Long term service and support (LTSS) for SUSE Linux Enterprise Server (SLES) 12 SP2 [ended on March 31, 2021](https://www.suse.com/lifecycle/). The CA certificates on SP2 include the expired DST root certificate, and it's not getting new CA certificate package updates. We have implemented some [workarounds](https://gitlab.com/gitlab-org/gitlab-omnibus-builder/-/merge_requests/191), but we will not be able to continue to keep the build running properly. |