diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-02 09:10:53 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-02 09:10:53 +0300 |
commit | e0a63a4b4d818171c17b75ef1e6d348cb287af9f (patch) | |
tree | f6f31af898634ea51ade70e279cc33d463493039 /doc | |
parent | 8f57ac0a38b7045f241dc5ad29fcde3f6eae3a40 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/object_storage.md | 32 | ||||
-rw-r--r-- | doc/ci/yaml/README.md | 74 |
2 files changed, 57 insertions, 49 deletions
diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index 85c3a4aa767..c7116acc87e 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -739,22 +739,7 @@ following command: Feature.disable(:use_workhorse_s3_client) ``` -### Multi-threaded copying - -GitLab uses the [S3 Upload Part Copy API](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) -to accelerate the copying of files within a bucket. Ceph S3 [prior to Kraken 11.0.2](https://ceph.com/releases/kraken-11-0-2-released/) -does not support this and [returns a 404 error when files are copied during the upload process](https://gitlab.com/gitlab-org/gitlab/-/issues/300604). - -The feature can be disabled using the `:s3_multithreaded_uploads` -feature flag. To disable the feature, ask a GitLab administrator with -[Rails console access](feature_flags.md#how-to-enable-and-disable-features-behind-flags) -to run the following command: - -```ruby -Feature.disable(:s3_multithreaded_uploads) -``` - -### IAM Permissions +#### IAM Permissions To set up an instance profile: @@ -782,3 +767,18 @@ To set up an instance profile: 1. [Attach this role](https://aws.amazon.com/premiumsupport/knowledge-center/attach-replace-ec2-instance-profile/) to the EC2 instance hosting your GitLab instance. 1. Configure GitLab to use it via the `use_iam_profile` configuration option. + +### Multi-threaded copying + +GitLab uses the [S3 Upload Part Copy API](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) +to accelerate the copying of files within a bucket. Ceph S3 [prior to Kraken 11.0.2](https://ceph.com/releases/kraken-11-0-2-released/) +does not support this and [returns a 404 error when files are copied during the upload process](https://gitlab.com/gitlab-org/gitlab/-/issues/300604). + +The feature can be disabled using the `:s3_multithreaded_uploads` +feature flag. To disable the feature, ask a GitLab administrator with +[Rails console access](feature_flags.md#how-to-enable-and-disable-features-behind-flags) +to run the following command: + +```ruby +Feature.disable(:s3_multithreaded_uploads) +``` diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 51ddf5d3dd1..821aa77e86a 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -2428,10 +2428,7 @@ Soon GitLab Runner picks up and starts the job. ### `environment` Use `environment` to define the [environment](../environments/index.md) that a job deploys to. -If `environment` is specified and no environment under that name exists, a new -one is created automatically. - -In its simplest form, the `environment` keyword can be defined like: +For example: ```yaml deploy to production: @@ -2440,34 +2437,20 @@ deploy to production: environment: production ``` -In the above example, the `deploy to production` job is marked as doing a -deployment to the `production` environment. - -#### `environment:name` +You can assign a value to the `environment` keyword by using: -The `environment: name` keyword can use any of the defined CI/CD [variables](#variables), -including predefined, secure, or variables defined in the `.gitlab-ci.yml` file. +- Plain text, like `production`. +- Variables, including CI/CD variables, predefined, secure, or variables + defined in the `.gitlab-ci.yml` file. You can't use variables defined in a `script` section. -The `environment` name can contain: - -- letters -- digits -- spaces -- `-` -- `_` -- `/` -- `$` -- `{` -- `}` +If you specify an `environment` and no environment with that name exists, +an environment is created. -Common names are `qa`, `staging`, and `production`, but you can use whatever -name works with your workflow. +#### `environment:name` -Instead of defining the name of the environment right after the `environment` -keyword, it's also possible to define it as a separate value. For that, use -the `name` keyword under `environment`: +Set a name for an [environment](../environments/index.md). For example: ```yaml deploy to production: @@ -2477,18 +2460,32 @@ deploy to production: name: production ``` -#### `environment:url` +Common environment names are `qa`, `staging`, and `production`, but you can use any +name you want. + +You can assign a value to the `name` keyword by using: -The `environment:url` keyword can use any of the defined CI/CD [variables](#variables), -including predefined, secure, or variables defined in the `.gitlab-ci.yml` file. +- Plain text, like `staging`. +- Variables, including CI/CD variables, predefined, secure, or variables + defined in the `.gitlab-ci.yml` file. You can't use variables defined in a `script` section. -This optional value exposes buttons that take you to the defined URL +The environment `name` can contain: -In this example, if the job finishes successfully, it creates buttons -in the merge requests and in the environments/deployments pages that point -to `https://prod.example.com`. +- Letters +- Digits +- Spaces +- `-` +- `_` +- `/` +- `$` +- `{` +- `}` + +#### `environment:url` + +Set a URL for an [environment](../environments/index.md). For example: ```yaml deploy to production: @@ -2499,6 +2496,17 @@ deploy to production: url: https://prod.example.com ``` +After the job completes, you can access the URL by using a button in the merge request, +environment, or deployment pages. + +You can assign a value to the `url` keyword by using: + +- Plain text, like `https://prod.example.com`. +- Variables, including CI/CD variables, predefined, secure, or variables + defined in the `.gitlab-ci.yml` file. + +You can't use variables defined in a `script` section. + #### `environment:on_stop` > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/22191) in GitLab 8.13. |