diff options
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/application_security/security_dashboard/img/pipeline_security_dashboard_v13_2.png | bin | 79103 -> 70913 bytes | |||
| -rw-r--r-- | doc/user/clusters/crossplane.md | 24 | ||||
| -rw-r--r-- | doc/user/clusters/management_project.md | 2 | ||||
| -rw-r--r-- | doc/user/gitlab_com/index.md | 14 | ||||
| -rw-r--r-- | doc/user/group/clusters/index.md | 4 | ||||
| -rw-r--r-- | doc/user/project/clusters/add_remove_clusters.md | 6 | ||||
| -rw-r--r-- | doc/user/project/clusters/index.md | 4 | ||||
| -rw-r--r-- | doc/user/project/clusters/serverless/aws.md | 12 | ||||
| -rw-r--r-- | doc/user/project/clusters/serverless/index.md | 36 | ||||
| -rw-r--r-- | doc/user/project/integrations/prometheus.md | 101 | ||||
| -rw-r--r-- | doc/user/project/operations/alert_management.md | 1 | ||||
| -rw-r--r-- | doc/user/project/operations/img/alert_list_v13_1.png | bin | 24192 -> 38265 bytes | |||
| -rw-r--r-- | doc/user/project/pages/getting_started/pages_from_scratch.md | 86 | ||||
| -rw-r--r-- | doc/user/project/pages/introduction.md | 18 | ||||
| -rw-r--r-- | doc/user/project/requirements/index.md | 6 |
15 files changed, 152 insertions, 162 deletions
diff --git a/doc/user/application_security/security_dashboard/img/pipeline_security_dashboard_v13_2.png b/doc/user/application_security/security_dashboard/img/pipeline_security_dashboard_v13_2.png Binary files differindex d935af96212..44fa8dc0a58 100644 --- a/doc/user/application_security/security_dashboard/img/pipeline_security_dashboard_v13_2.png +++ b/doc/user/application_security/security_dashboard/img/pipeline_security_dashboard_v13_2.png diff --git a/doc/user/clusters/crossplane.md b/doc/user/clusters/crossplane.md index 3a430ad55bd..e3c71f9f313 100644 --- a/doc/user/clusters/crossplane.md +++ b/doc/user/clusters/crossplane.md @@ -55,18 +55,18 @@ export REGION=us-central1 # the GCP region where the GKE cluster is provisioned. labels: rbac.authorization.k8s.io/aggregate-to-edit: "true" rules: - - apiGroups: - - database.crossplane.io - resources: - - postgresqlinstances - verbs: - - get - - list - - create - - update - - delete - - patch - - watch + - apiGroups: + - database.crossplane.io + resources: + - postgresqlinstances + verbs: + - get + - list + - create + - update + - delete + - patch + - watch ``` 1. Apply the cluster role to the cluster: diff --git a/doc/user/clusters/management_project.md b/doc/user/clusters/management_project.md index c8755af29a3..892d2bce184 100644 --- a/doc/user/clusters/management_project.md +++ b/doc/user/clusters/management_project.md @@ -97,7 +97,7 @@ Development, Staging, and Production cluster respectively. ```yaml stages: -- deploy + - deploy configure development cluster: stage: deploy diff --git a/doc/user/gitlab_com/index.md b/doc/user/gitlab_com/index.md index a59b9cf80e5..ae16e176bab 100644 --- a/doc/user/gitlab_com/index.md +++ b/doc/user/gitlab_com/index.md @@ -337,9 +337,9 @@ Windows Shared Runners: ```yaml .shared_windows_runners: tags: - - shared-windows - - windows - - windows-1809 + - shared-windows + - windows + - windows-1809 stages: - build @@ -352,17 +352,17 @@ before_script: build: extends: - - .shared_windows_runners + - .shared_windows_runners stage: build script: - - echo "running scripts in the build job" + - echo "running scripts in the build job" test: extends: - - .shared_windows_runners + - .shared_windows_runners stage: test script: - - echo "running scripts in the test job" + - echo "running scripts in the test job" ``` #### Limitations and known issues diff --git a/doc/user/group/clusters/index.md b/doc/user/group/clusters/index.md index 5cdac7ae892..8dcc08bce46 100644 --- a/doc/user/group/clusters/index.md +++ b/doc/user/group/clusters/index.md @@ -127,8 +127,8 @@ And the following environments are set in [`.gitlab-ci.yml`](../../../ci/yaml/RE ```yaml stages: -- test -- deploy + - test + - deploy test: stage: test diff --git a/doc/user/project/clusters/add_remove_clusters.md b/doc/user/project/clusters/add_remove_clusters.md index fbd2814ea75..d2de512c62b 100644 --- a/doc/user/project/clusters/add_remove_clusters.md +++ b/doc/user/project/clusters/add_remove_clusters.md @@ -227,9 +227,9 @@ To add a Kubernetes cluster to your project, group, or instance: kind: ClusterRole name: cluster-admin subjects: - - kind: ServiceAccount - name: gitlab-admin - namespace: kube-system + - kind: ServiceAccount + name: gitlab-admin + namespace: kube-system ``` 1. Apply the service account and cluster role binding to your cluster: diff --git a/doc/user/project/clusters/index.md b/doc/user/project/clusters/index.md index 2c532ac24c8..16d78751f40 100644 --- a/doc/user/project/clusters/index.md +++ b/doc/user/project/clusters/index.md @@ -99,8 +99,8 @@ And the following environments are set in ```yaml stages: -- test -- deploy + - test + - deploy test: stage: test diff --git a/doc/user/project/clusters/serverless/aws.md b/doc/user/project/clusters/serverless/aws.md index 15f7e14fda9..595d8fb3895 100644 --- a/doc/user/project/clusters/serverless/aws.md +++ b/doc/user/project/clusters/serverless/aws.md @@ -392,29 +392,19 @@ want to store your package: image: python:latest stages: - - deploy production: - stage: deploy - before_script: - - pip3 install awscli --upgrade - - pip3 install aws-sam-cli --upgrade - script: - - sam build - - sam package --output-template-file packaged.yaml --s3-bucket <S3_bucket_name> - - sam deploy --template-file packaged.yaml --stack-name gitlabpoc --s3-bucket <S3_bucket_name> --capabilities CAPABILITY_IAM --region us-east-1 - environment: production - ``` +``` Let’s examine the configuration file more closely: diff --git a/doc/user/project/clusters/serverless/index.md b/doc/user/project/clusters/serverless/index.md index d00f05fca66..71d03653a32 100644 --- a/doc/user/project/clusters/serverless/index.md +++ b/doc/user/project/clusters/serverless/index.md @@ -143,24 +143,24 @@ You must do the following: labels: rbac.authorization.k8s.io/aggregate-to-edit: "true" rules: - - apiGroups: - - serving.knative.dev - resources: - - configurations - - configurationgenerations - - routes - - revisions - - revisionuids - - autoscalers - - services - verbs: - - get - - list - - create - - update - - delete - - patch - - watch + - apiGroups: + - serving.knative.dev + resources: + - configurations + - configurationgenerations + - routes + - revisions + - revisionuids + - autoscalers + - services + verbs: + - get + - list + - create + - update + - delete + - patch + - watch ``` Then run the following command: diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 337f9461e9a..1ebba7b2871 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -290,17 +290,17 @@ For example: panel_groups: - group: 'Group Title' panels: - - type: area-chart - title: "Chart Title" - y_label: "Y-Axis" - y_axis: - format: number - precision: 0 - metrics: - - id: my_metric_id - query_range: 'http_requests_total' - label: "Instance: {{instance}}, method: {{method}}" - unit: "count" + - type: area-chart + title: "Chart Title" + y_label: "Y-Axis" + y_axis: + format: number + precision: 0 + metrics: + - id: my_metric_id + query_range: 'http_requests_total' + label: "Instance: {{instance}}, method: {{method}}" + unit: "count" ``` The above sample dashboard would display a single area chart. Each file should @@ -641,25 +641,24 @@ To add a stacked column panel type to a dashboard, look at the following sample dashboard: 'Dashboard title' priority: 1 panel_groups: -- group: 'Group Title' - priority: 5 - panels: - - type: 'stacked-column' - title: "Stacked column" - y_label: "y label" - x_label: 'x label' - metrics: - - id: memory_1 - query_range: 'memory_query' - label: "memory query 1" - unit: "count" - series_name: 'group 1' - - id: memory_2 - query_range: 'memory_query_2' - label: "memory query 2" - unit: "count" - series_name: 'group 2' - + - group: 'Group Title' + priority: 5 + panels: + - type: 'stacked-column' + title: "Stacked column" + y_label: "y label" + x_label: 'x label' + metrics: + - id: memory_1 + query_range: 'memory_query' + label: "memory query 1" + unit: "count" + series_name: 'group 1' + - id: memory_2 + query_range: 'memory_query_2' + label: "memory query 2" + unit: "count" + series_name: 'group 2' ```  @@ -681,10 +680,10 @@ panel_groups: - title: "Single Stat" type: "single-stat" metrics: - - id: 10 - query: 'max(go_memstats_alloc_bytes{job="prometheus"})' - unit: MB - label: "Total" + - id: 10 + query: 'max(go_memstats_alloc_bytes{job="prometheus"})' + unit: MB + label: "Total" ``` Note the following properties: @@ -711,10 +710,10 @@ panel_groups: type: "single-stat" max_value: 100 metrics: - - id: 10 - query: 'max(go_memstats_alloc_bytes{job="prometheus"})' - unit: '%' - label: "Total" + - id: 10 + query: 'max(go_memstats_alloc_bytes{job="prometheus"})' + unit: '%' + label: "Total" ``` For example, if you have a query value of `53.6`, adding `%` as the unit results in a single stat value of `53.6%`, but if the maximum expected value of the query is `120`, the value would be `44.6%`. Adding the `max_value` causes the correct percentage value to display. @@ -733,10 +732,10 @@ panel_groups: - title: "Heatmap" type: "heatmap" metrics: - - id: 10 - query: 'sum(rate(nginx_upstream_responses_total{upstream=~"%{kube_namespace}-%{ci_environment_slug}-.*"}[60m])) by (status_code)' - unit: req/sec - label: "Status code" + - id: 10 + query: 'sum(rate(nginx_upstream_responses_total{upstream=~"%{kube_namespace}-%{ci_environment_slug}-.*"}[60m])) by (status_code)' + unit: req/sec + label: "Status code" ``` Note the following properties: @@ -846,11 +845,11 @@ templating: type: custom options: values: - - value: 'value option 1' # The value that will replace the variable in queries. - text: 'Option 1' # (Optional) Text that will appear in the UI dropdown. - - value: 'value_option_2' - text: 'Option 2' - default: true # (Optional) This option should be the default value of this variable. + - value: 'value option 1' # The value that will replace the variable in queries. + text: 'Option 1' # (Optional) Text that will appear in the UI dropdown. + - value: 'value_option_2' + text: 'Option 2' + default: true # (Optional) This option should be the default value of this variable. ``` ##### `metric_label_values` variable type @@ -1030,10 +1029,10 @@ To send GitLab alert notifications, copy the *URL* and *Authorization Key* into receivers: name: gitlab webhook_configs: - - http_config: - bearer_token: 9e1cbfcd546896a9ea8be557caf13a76 - send_resolved: true - url: http://192.168.178.31:3001/root/manual_prometheus/prometheus/alerts/notify.json + - http_config: + bearer_token: 9e1cbfcd546896a9ea8be557caf13a76 + send_resolved: true + url: http://192.168.178.31:3001/root/manual_prometheus/prometheus/alerts/notify.json ... ``` diff --git a/doc/user/project/operations/alert_management.md b/doc/user/project/operations/alert_management.md index 7b6e40c7179..75ca5a7e74b 100644 --- a/doc/user/project/operations/alert_management.md +++ b/doc/user/project/operations/alert_management.md @@ -85,6 +85,7 @@ Each alert contains the following metrics: - **Start time** - How long ago the alert fired. This field uses the standard GitLab pattern of `X time ago`, but is supported by a granular date/time tooltip depending on the user's locale. - **Alert description** - The description of the alert, which attempts to capture the most meaningful data. - **Event count** - The number of times that an alert has fired. +- **Issue** - A link to the incident issue that has been created for the alert. - **Status** - The [current status](#alert-management-statuses) of the alert. ### Alert Management list sorting diff --git a/doc/user/project/operations/img/alert_list_v13_1.png b/doc/user/project/operations/img/alert_list_v13_1.png Binary files differindex 7cda00a25ad..7a1a5f5191e 100644 --- a/doc/user/project/operations/img/alert_list_v13_1.png +++ b/doc/user/project/operations/img/alert_list_v13_1.png diff --git a/doc/user/project/pages/getting_started/pages_from_scratch.md b/doc/user/project/pages/getting_started/pages_from_scratch.md index 23d22e9fa66..86523ab9d10 100644 --- a/doc/user/project/pages/getting_started/pages_from_scratch.md +++ b/doc/user/project/pages/getting_started/pages_from_scratch.md @@ -101,9 +101,9 @@ with GitLab Pages: ```yaml pages: script: - - gem install bundler - - bundle install - - bundle exec jekyll build + - gem install bundler + - bundle install + - bundle exec jekyll build ``` ## Specify the `public` directory for output @@ -116,9 +116,9 @@ Jekyll uses destination (`-d`) to specify an output directory for the built webs ```yaml pages: script: - - gem install bundler - - bundle install - - bundle exec jekyll build -d public + - gem install bundler + - bundle install + - bundle exec jekyll build -d public ``` ## Specify the `public` directory for artifacts @@ -130,12 +130,12 @@ in the `public` directory: ```yaml pages: script: - - gem install bundler - - bundle install - - bundle exec jekyll build -d public + - gem install bundler + - bundle install + - bundle exec jekyll build -d public artifacts: paths: - - public + - public ``` Paste this into `.gitlab-ci.yml` file, so it now looks like this: @@ -145,12 +145,12 @@ image: ruby:2.7 pages: script: - - gem install bundler - - bundle install - - bundle exec jekyll build -d public + - gem install bundler + - bundle install + - bundle exec jekyll build -d public artifacts: paths: - - public + - public ``` Now save and commit the `.gitlab-ci.yml` file. You can watch the pipeline run @@ -181,12 +181,12 @@ workflow: pages: script: - - gem install bundler - - bundle install - - bundle exec jekyll build -d public + - gem install bundler + - bundle install + - bundle exec jekyll build -d public artifacts: paths: - - public + - public ``` Then configure the pipeline to run the job for the master branch only. @@ -200,12 +200,12 @@ workflow: pages: script: - - gem install bundler - - bundle install - - bundle exec jekyll build -d public + - gem install bundler + - bundle install + - bundle exec jekyll build -d public artifacts: paths: - - public + - public rules: - if: '$CI_COMMIT_BRANCH == "master"' ``` @@ -232,12 +232,12 @@ workflow: pages: stage: deploy script: - - gem install bundler - - bundle install - - bundle exec jekyll build -d public + - gem install bundler + - bundle install + - bundle exec jekyll build -d public artifacts: paths: - - public + - public rules: - if: '$CI_COMMIT_BRANCH == "master"' ``` @@ -255,24 +255,24 @@ workflow: pages: stage: deploy script: - - gem install bundler - - bundle install - - bundle exec jekyll build -d public + - gem install bundler + - bundle install + - bundle exec jekyll build -d public artifacts: paths: - - public + - public rules: - if: '$CI_COMMIT_BRANCH == "master"' test: stage: test script: - - gem install bundler - - bundle install - - bundle exec jekyll build -d test + - gem install bundler + - bundle install + - bundle exec jekyll build -d test artifacts: paths: - - test + - test rules: - if: '$CI_COMMIT_BRANCH != "master"' ``` @@ -310,20 +310,20 @@ before_script: pages: stage: deploy script: - - bundle exec jekyll build -d public + - bundle exec jekyll build -d public artifacts: paths: - - public + - public rules: - if: '$CI_COMMIT_BRANCH == "master"' test: stage: test script: - - bundle exec jekyll build -d test + - bundle exec jekyll build -d test artifacts: paths: - - test + - test rules: - if: '$CI_COMMIT_BRANCH != "master"' ``` @@ -345,7 +345,7 @@ workflow: cache: paths: - - vendor/ + - vendor/ before_script: - gem install bundler @@ -354,20 +354,20 @@ before_script: pages: stage: deploy script: - - bundle exec jekyll build -d public + - bundle exec jekyll build -d public artifacts: paths: - - public + - public rules: - if: '$CI_COMMIT_BRANCH == "master"' test: stage: test script: - - bundle exec jekyll build -d test + - bundle exec jekyll build -d test artifacts: paths: - - test + - test rules: - if: '$CI_COMMIT_BRANCH != "master"' ``` diff --git a/doc/user/project/pages/introduction.md b/doc/user/project/pages/introduction.md index 6177a81dbea..a6923779f24 100644 --- a/doc/user/project/pages/introduction.md +++ b/doc/user/project/pages/introduction.md @@ -118,14 +118,14 @@ is so `cp` doesn't also copy `public/` to itself in an infinite loop: ```yaml pages: script: - - mkdir .public - - cp -r * .public - - mv .public public + - mkdir .public + - cp -r * .public + - mv .public public artifacts: paths: - - public + - public only: - - master + - master ``` ### `.gitlab-ci.yml` for a static site generator @@ -161,13 +161,13 @@ image: ruby:2.6 pages: script: - - gem install jekyll - - jekyll build -d public/ + - gem install jekyll + - jekyll build -d public/ artifacts: paths: - - public + - public only: - - pages + - pages ``` See an example that has different files in the [`master` branch](https://gitlab.com/pages/jekyll-branched/tree/master) diff --git a/doc/user/project/requirements/index.md b/doc/user/project/requirements/index.md index 53eda76aa37..ae22dbc7e72 100644 --- a/doc/user/project/requirements/index.md +++ b/doc/user/project/requirements/index.md @@ -162,9 +162,9 @@ requirements, add a rule which checks `CI_HAS_OPEN_REQUIREMENTS` CI variable. ```yaml requirements_confirmation: rules: - - if: "$CI_HAS_OPEN_REQUIREMENTS" == "true" - when: manual - - when: never + - if: "$CI_HAS_OPEN_REQUIREMENTS" == "true" + when: manual + - when: never allow_failure: false script: - mkdir tmp |
