diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-01-11 18:08:21 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-01-11 18:08:21 +0300 |
commit | ed94a4dd903dc4d20cbc1bce330b9c1b7a5f7fbf (patch) | |
tree | e77f48da26680f6e949604cab506cf137515b05c /doc | |
parent | fc0afaf7da2156e91e615662272811eee56d034a (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ci/yaml/index.md | 4 | ||||
-rw-r--r-- | doc/development/documentation/styleguide/word_list.md | 12 | ||||
-rw-r--r-- | doc/integration/jira/dvcs.md | 12 | ||||
-rw-r--r-- | doc/topics/autodevops/customize.md | 120 | ||||
-rw-r--r-- | doc/user/namespace/index.md | 7 | ||||
-rw-r--r-- | doc/user/workspace/index.md | 12 |
6 files changed, 100 insertions, 67 deletions
diff --git a/doc/ci/yaml/index.md b/doc/ci/yaml/index.md index 0718ae93915..b768bab3180 100644 --- a/doc/ci/yaml/index.md +++ b/doc/ci/yaml/index.md @@ -3289,7 +3289,9 @@ Use `retry:when` with `retry:max` to retry jobs for only specific failure cases. - `always`: Retry on any failure (default). - `unknown_failure`: Retry when the failure reason is unknown. -- `script_failure`: Retry when the script failed. +- `script_failure`: Retry when: + - The script failed. + - The runner failed to pull the Docker image. For `docker`, `docker+machine`, `kubernetes` [executors](https://docs.gitlab.com/runner/executors/). - `api_failure`: Retry on API failure. - `stuck_or_timeout_failure`: Retry when the job got stuck or timed out. - `runner_system_failure`: Retry if there is a runner system failure (for example, job setup failed). diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index c7bdbbbea31..f774f5bd0cc 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -186,6 +186,10 @@ Instead, use **assign**. For example: - Assign the issue to an epic. - Assign a user to the issue. +## authenticated user + +Use **authenticated user** instead of other variations, like **signed in user** or **logged in user**. + ## below Try to avoid **below** when referring to an example or table in a documentation page. If required, use **following** instead. For example: @@ -691,6 +695,10 @@ Do not use **limitations**. Use **known issues** instead. Do not use **log in** or **log on**. Use [sign in](#sign-in) instead. If the user interface has **Log in**, you can use it. +## logged-in user, logged in user + +Use **authenticated user** instead of **logged-in user** or **logged in user**. + ## lower Do not use **lower** when talking about version numbers. @@ -1075,6 +1083,10 @@ You can use **single sign-on**. Use **register** instead of **sign up** when talking about creating an account. +## signed-in user, signed in user + +Use **authenticated user** instead of **signed-in user** or **signed in user**. + ## simply, simple Do not use **simply** or **simple**. If the user doesn't find the process to be simple, we lose their trust. ([Vale](../testing.md#vale) rule: [`Simplicity.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Simplicity.yml)) diff --git a/doc/integration/jira/dvcs.md b/doc/integration/jira/dvcs.md index 7f431de1323..1300eb21ced 100644 --- a/doc/integration/jira/dvcs.md +++ b/doc/integration/jira/dvcs.md @@ -284,3 +284,15 @@ To resolve the issue, enable the relevant feature: 1. On the left sidebar, select **Settings > General**. 1. Expand **Visibility, project features, permissions**. 1. Use the toggles to enable the features as needed. + +### Find webhook logs in a DVCS-linked project + +To find webhook logs in a DVCS-linked project: + +1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, select **Settings > Webhooks**. +1. Scroll down to **Project Hooks**. +1. Next to the log that points to your Jira instance, select **Edit**. +1. Scroll down to **Recent events**. + +If you can't find webhook logs in your project, check your DVCS setup for problems. diff --git a/doc/topics/autodevops/customize.md b/doc/topics/autodevops/customize.md index 43769410eba..fbc01bee6f1 100644 --- a/doc/topics/autodevops/customize.md +++ b/doc/topics/autodevops/customize.md @@ -12,6 +12,30 @@ You can customize components of Auto DevOps to fit your needs. For example, you - Enable staging and canary deployments with a custom [CI/CD configuration](#customize-gitlab-ciyml). - Extend Auto DevOps with the [GitLab API](#extend-auto-devops-with-the-api). +## Auto DevOps banner + +When Auto DevOps is not enabled, a banner displays for users with at +least the Maintainer role: + +![Auto DevOps banner](img/autodevops_banner_v12_6.png) + +The banner can be disabled for: + +- A user, when they dismiss it themselves. +- A project, by explicitly [disabling Auto DevOps](index.md#enable-or-disable-auto-devops). +- An entire GitLab instance: + - By an administrator running the following in a Rails console: + + ```ruby + Feature.enable(:auto_devops_banner_disabled) + ``` + + - Through the REST API with an administrator access token: + + ```shell + curl --data "value=true" --header "PRIVATE-TOKEN: <personal_access_token>" "https://gitlab.example.com/api/v4/features/auto_devops_banner_disabled" + ``` + ## Custom buildpacks You can customize your buildpacks when either: @@ -58,7 +82,7 @@ To use only a single custom buildpack, you should provide the project CI/CD vari ## Custom Dockerfiles -> Support for `DOCKERFILE_PATH` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35662) in GitLab 13.2 +> `DOCKERFILE_PATH` [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35662) in GitLab 13.2. If you have a Dockerfile in the root of your project repository, Auto DevOps builds a Docker image based on the Dockerfile. This can be @@ -198,7 +222,7 @@ To override settings like `replicaCount`, use the `REPLICAS` [build and deployme ### Customize `helm upgrade` -The `helm upgrade` command is used by the [auto-deploy-image](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image). +The [auto-deploy-image](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image) uses the `helm upgrade` command. To customize this command, pass it options with the `HELM_UPGRADE_EXTRA_ARGS` CI/CD variable. For example, to disable pre- and post-upgrade hooks when `helm upgrade` runs: @@ -239,28 +263,14 @@ To remove behaviors from the Auto DevOps pipeline: into your project. 1. Edit your copy of the template as needed. -## Use multiple Kubernetes clusters - -See [Multiple Kubernetes clusters for Auto DevOps](multiple_clusters_auto_devops.md). - -## Customizing the Kubernetes namespace - -In GitLab 14.5 and earlier, you could use `environment:kubernetes:namespace` -to specify a namespace for the environment. -However, this feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8), -along with certificate-based integration. - -You should now use the `KUBE_NAMESPACE` environment variable and -[limit its environment scope](../../ci/environments/index.md#scope-environments-with-specs). - -## Use individual components of Auto DevOps +### Use individual components of Auto DevOps If you only require a subset of the features offered by Auto DevOps, you can include individual Auto DevOps jobs in your own `.gitlab-ci.yml`. Be sure to also define the stage required by each job in your `.gitlab-ci.yml` file. -For example, to make use of [Auto Build](stages.md#auto-build), you can add the following to +For example, to use [Auto Build](stages.md#auto-build), you can add the following to your `.gitlab-ci.yml`: ```yaml @@ -278,12 +288,26 @@ From [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213336), Auto DevOps templates that use the [`only`](../../ci/yaml/index.md#only--except) or [`except`](../../ci/yaml/index.md#only--except) syntax have switched to the [`rules`](../../ci/yaml/index.md#rules) syntax. -If your `.gitlab-ci.yml` extends these Auto DevOps templates and overrides the `only` or -`except` keywords, you must migrate your templates to use the +If your `.gitlab-ci.yml` extends these Auto DevOps templates and overrides `only` or +`except`, migrate your templates to the [`rules`](../../ci/yaml/index.md#rules) syntax. -If you cannot migrate just yet, you can alternatively pin your templates to +If you cannot migrate, you can pin your templates to the [GitLab 12.10 based templates](https://gitlab.com/gitlab-org/auto-devops-v12-10). +## Use multiple Kubernetes clusters + +See [Multiple Kubernetes clusters for Auto DevOps](multiple_clusters_auto_devops.md). + +## Customizing the Kubernetes namespace + +In GitLab 14.5 and earlier, you could use `environment:kubernetes:namespace` +to specify a namespace for the environment. +However, this feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8), +along with certificate-based integration. + +You should now use the `KUBE_NAMESPACE` environment variable and +[limit its environment scope](../../ci/environments/index.md#scope-environments-with-specs). + ## Use images hosted in a local Docker registry You can configure many Auto DevOps jobs to run in an [offline environment](../../user/application_security/offline_deployments/index.md): @@ -307,10 +331,13 @@ You can configure many Auto DevOps jobs to run in an [offline environment](../.. ## PostgreSQL database support -To support applications requiring a database, -[PostgreSQL](https://www.postgresql.org/) is provisioned by default. The credentials to access -the database are preconfigured, but can be customized by setting the associated -[CI/CD variables](cicd_variables.md). You can use these credentials to define a `DATABASE_URL`: +To support applications that require a database, +[PostgreSQL](https://www.postgresql.org/) is provisioned by default. +The credentials to access the database are preconfigured. + +To customize the credentials, set the associated +[CI/CD variables](cicd_variables.md). You can also +define a custom `DATABASE_URL`: ```yaml postgres://user:password@postgres-host:postgres-port/postgres-database @@ -318,23 +345,20 @@ postgres://user:password@postgres-host:postgres-port/postgres-database ### Upgrading PostgreSQL -The version of the chart used to provision PostgreSQL: - -- Is 8.2.1 in GitLab 13.0 and later, but can be set back to 0.7.1 if needed. -- Can be set to from 0.7.1 to 8.2.1 in GitLab 12.9 and 12.10. -- Is 0.7.1 in GitLab 12.8 and earlier. +GitLab uses chart version 8.2.1 to provision PostgreSQL by default. +You can set the version from 0.7.1 to 8.2.1. -GitLab encourages users to [migrate their database](upgrading_postgresql.md) +If you use an older chart version, you should [migrate your database](upgrading_postgresql.md) to the newer PostgreSQL. The CI/CD variable `AUTO_DEVOPS_POSTGRES_CHANNEL` that controls default provisioned -PostgreSQL was changed to `2` in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/210499). +PostgreSQL changed to `2` in [GitLab 13.0](https://gitlab.com/gitlab-org/gitlab/-/issues/210499). To use the old PostgreSQL, set the `AUTO_DEVOPS_POSTGRES_CHANNEL` variable to `1`. ### Customize values for PostgreSQL Helm Chart -> [Introduced](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/issues/113) in auto-deploy-image v2, in GitLab 13.8. +> [Introduced](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image/-/issues/113) in GitLab 13.8 with auto-deploy-image v2. To set custom values, do one of the following: @@ -347,9 +371,9 @@ To set custom values, do one of the following: ### Use external PostgreSQL database providers -Auto DevOps provides out-of-the-box support for a PostgreSQL container for -production environments. However, you might want to use an external managed provider (such as -AWS Relational Database Service) for PostgreSQL. +Auto DevOps provides out-of-the-box support for a PostgreSQL container +for production environments. However, you might want to use an +external managed provider like AWS Relational Database Service. To use an external managed provider: @@ -368,27 +392,3 @@ To use an external managed provider: ``` 1. Ensure your Kubernetes cluster has network access to where PostgreSQL is hosted. - -## Auto DevOps banner - -The following Auto DevOps banner displays for users with Maintainer or greater -permissions on new projects when Auto DevOps is not enabled: - -![Auto DevOps banner](img/autodevops_banner_v12_6.png) - -The banner can be disabled for: - -- A user, when they dismiss it themselves. -- A project, by explicitly [disabling Auto DevOps](index.md#enable-or-disable-auto-devops). -- An entire GitLab instance: - - By an administrator running the following in a Rails console: - - ```ruby - Feature.enable(:auto_devops_banner_disabled) - ``` - - - Through the REST API with an administrator access token: - - ```shell - curl --data "value=true" --header "PRIVATE-TOKEN: <personal_access_token>" "https://gitlab.example.com/api/v4/features/auto_devops_banner_disabled" - ``` diff --git a/doc/user/namespace/index.md b/doc/user/namespace/index.md index bc7ec25b19c..7463b8f1099 100644 --- a/doc/user/namespace/index.md +++ b/doc/user/namespace/index.md @@ -35,3 +35,10 @@ To determine whether you're viewing a group or personal namespace, you can view | A user named `alex`. | `https://gitlab.example.com/alex` | `alex` | | A group named `alex-team`. | `https://gitlab.example.com/alex-team` | `alex-team` | | A group named `alex-team` with a subgroup named `marketing`. | `https://gitlab.example.com/alex-team/marketing` | `alex-team/marketing` | + +## Naming limitations for namespaces + +When choosing a name for your namespace, keep in mind the [character limitations](../reserved_names.md#limitations-on-project-and-group-names) and [reserved group names](../reserved_names.md#reserved-group-names). + +NOTE: +If your namespace contains a `.`, you will encounter issues with the validation of your SSL certificates and the source path when [publishing Terraform modules](../packages/terraform_module_registry/index.md#publish-a-terraform-module). diff --git a/doc/user/workspace/index.md b/doc/user/workspace/index.md index 3806c78589a..e4e1edd6346 100644 --- a/doc/user/workspace/index.md +++ b/doc/user/workspace/index.md @@ -4,7 +4,7 @@ group: Organization info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Workspace +# Organization DISCLAIMER: This page contains information related to upcoming products, features, and functionality. @@ -15,9 +15,9 @@ The development, release, and timing of any products, features, or functionality sole discretion of GitLab Inc. NOTE: -Workspace is in development. +Organization is in development. -Workspace will be above the [top-level namespaces](../namespace/index.md) for you to manage +Organization will be above the [top-level namespaces](../namespace/index.md) for you to manage everything you do as a GitLab administrator, including: - Defining and applying settings to all of your groups, subgroups, and projects. @@ -26,11 +26,11 @@ everything you do as a GitLab administrator, including: Our goal is to reach feature parity between SaaS and self-managed installations, with all [Admin Area settings](/ee/user/admin_area/settings/index.md) moving to either: -- Groups. Available in the Workspace, top-level groups, and subgroups. +- Groups. Available in the Organization, and subgroups. - Hardware Controls. For functionality that does not apply to groups, Hardware Controls are only applicable to self-managed installations. There is one Hardware Controls section per installation. -For more information about the state of workspace development, +For more information about the state of organization development, see [epic 9265](https://gitlab.com/groups/gitlab-org/-/epics/9265). <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> @@ -39,4 +39,4 @@ For a video introduction to the new hierarchy concept for groups and projects fo ## Related topics -- [Workspace developer documentation](../../development/workspace/index.md) +- [Organization developer documentation](../../development/workspace/index.md) |