diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-01-28 21:14:12 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-01-28 21:14:12 +0300 |
commit | de3e5b677261e4cdd9fbad6fbe461c9c605cbfa6 (patch) | |
tree | a5216f78aed35cdcbd3a933b9b22be7dffec9b62 /doc/user | |
parent | 3837dbda3736815b7d6dab0f880698ea0cddef3c (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/clusters/agent/install/index.md | 5 | ||||
-rw-r--r-- | doc/user/infrastructure/iac/terraform_state.md | 18 | ||||
-rw-r--r-- | doc/user/packages/package_registry/index.md | 2 | ||||
-rw-r--r-- | doc/user/permissions.md | 22 | ||||
-rw-r--r-- | doc/user/project/clusters/add_eks_clusters.md | 4 | ||||
-rw-r--r-- | doc/user/project/clusters/add_existing_cluster.md | 4 | ||||
-rw-r--r-- | doc/user/project/clusters/multiple_kubernetes_clusters.md | 4 | ||||
-rw-r--r-- | doc/user/project/import/bitbucket_server.md | 8 | ||||
-rw-r--r-- | doc/user/project/issues/managing_issues.md | 2 | ||||
-rw-r--r-- | doc/user/project/quick_actions.md | 2 | ||||
-rw-r--r-- | doc/user/search/index.md | 9 |
11 files changed, 61 insertions, 19 deletions
diff --git a/doc/user/clusters/agent/install/index.md b/doc/user/clusters/agent/install/index.md index 6b03d1742e5..532501e69d4 100644 --- a/doc/user/clusters/agent/install/index.md +++ b/doc/user/clusters/agent/install/index.md @@ -13,7 +13,10 @@ onto your cluster. ## Prerequisites -- An existing Kubernetes cluster. +- An existing Kubernetes cluster. If you don't have a cluster yet, you can create a new cluster on cloud providers, such as: + - [Google Kubernetes Engine (GKE)](https://cloud.google.com/kubernetes-engine/docs/quickstart) + - [Amazon Elastic Kubernetes Service (EKS)](https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html) + - [Digital Ocean](https://docs.digitalocean.com/products/kubernetes/quickstart/) - On self-managed GitLab instances, a GitLab administrator needs to set up the [GitLab Agent Server (KAS)](../../../../administration/clusters/kas.md). ## Installation steps diff --git a/doc/user/infrastructure/iac/terraform_state.md b/doc/user/infrastructure/iac/terraform_state.md index 9665dc11db7..a57d094d59c 100644 --- a/doc/user/infrastructure/iac/terraform_state.md +++ b/doc/user/infrastructure/iac/terraform_state.md @@ -384,6 +384,24 @@ Additional improvements to the [graphical interface for managing state files](https://gitlab.com/groups/gitlab-org/-/epics/4563) are planned. +## Manage individual Terraform state versions + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207347) in GitLab 13.4. + +Individual state versions can be managed using the GitLab REST API. + +Users with the [Developer role](../../permissions.md) can retrieve state versions using their serial number. To retrieve a version: + +```shell +curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/projects/<your_project_id>/terraform/state/<your_state_name>/versions/<version-serial>" +``` + +Users with the [Maintainer role](../../permissions.md) can remove state versions using their serial number. To remove a version: + +```shell +curl --header "Private-Token: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/<your_project_id>/terraform/state/<your_state_name>/versions/<version-serial>" +``` + ## Remove a state file Users with Maintainer and greater [permissions](../../permissions.md) can use the diff --git a/doc/user/packages/package_registry/index.md b/doc/user/packages/package_registry/index.md index 73dc15b8a92..55bfc56fc88 100644 --- a/doc/user/packages/package_registry/index.md +++ b/doc/user/packages/package_registry/index.md @@ -89,7 +89,7 @@ You can view which pipeline published the package, and the commit and user who t ## Reduce storage usage For information on reducing your storage use for the Package Registry, see -[Reduce Dependency Proxy storage use](reduce_package_registry_storage.md). +[Reduce Package Registry storage use](reduce_package_registry_storage.md). ## Disable the Package Registry diff --git a/doc/user/permissions.md b/doc/user/permissions.md index 8ceedcec724..c01f8d5588e 100644 --- a/doc/user/permissions.md +++ b/doc/user/permissions.md @@ -81,8 +81,9 @@ The following table lists project permissions available for each role: | [Clusters](infrastructure/clusters/index.md):<br>View clusters | | | ✓ | ✓ | ✓ | | [Clusters](infrastructure/clusters/index.md):<br>Manage clusters | | | | ✓ | ✓ | | [Container Registry](packages/container_registry/index.md):<br>Create, edit, delete cleanup policies | | | ✓ | ✓ | ✓ | -| [Container Registry](packages/container_registry/index.md):<br>Remove a container registry image | | | ✓ | ✓ | ✓ | -| [Container Registry](packages/container_registry/index.md):<br>Update container registry | | | ✓ | ✓ | ✓ | +| [Container Registry](packages/container_registry/index.md):<br>Push an image to the Container Registry | | | ✓ | ✓ | ✓ | +| [Container Registry](packages/container_registry/index.md):<br>Pull an image from the Container Registry | ✓ (*21*) | ✓ (*21*) | ✓ | ✓ | ✓ | +| [Container Registry](packages/container_registry/index.md):<br>Remove a Container Registry image | | | ✓ | ✓ | ✓ | | [GitLab Pages](project/pages/index.md):<br>View Pages protected by [access control](project/pages/introduction.md#gitlab-pages-access-control) | ✓ | ✓ | ✓ | ✓ | ✓ | | [GitLab Pages](project/pages/index.md):<br>Manage | | | | ✓ | ✓ | | [GitLab Pages](project/pages/index.md):<br>Manage GitLab Pages domains and certificates | | | | ✓ | ✓ | @@ -130,9 +131,10 @@ The following table lists project permissions available for each role: | [Metrics dashboards](../operations/metrics/dashboards/index.md):<br>Manage user-starred metrics dashboards (*7*) | ✓ | ✓ | ✓ | ✓ | ✓ | | [Metrics dashboards](../operations/metrics/dashboards/index.md):<br>View metrics dashboard annotations | | ✓ | ✓ | ✓ | ✓ | | [Metrics dashboards](../operations/metrics/dashboards/index.md):<br>Create/edit/delete metrics dashboard annotations | | | ✓ | ✓ | ✓ | -| [Package registry](packages/index.md):<br>Pull package | ✓ (*1*) | ✓ | ✓ | ✓ | ✓ | -| [Package registry](packages/index.md):<br>Publish package | | | ✓ | ✓ | ✓ | -| [Package registry](packages/index.md):<br>Delete package | | | | ✓ | ✓ | +| [Package registry](packages/index.md):<br>Pull a package | ✓ (*1*) | ✓ | ✓ | ✓ | ✓ | +| [Package registry](packages/index.md):<br>Publish a package | | | ✓ | ✓ | ✓ | +| [Package registry](packages/index.md):<br>Delete a package | | | | ✓ | ✓ | +| [Package registry](packages/index.md):<br>Delete a file associated with a package | | | | ✓ | ✓ | | [Project operations](../operations/index.md):<br>View [Error Tracking](../operations/error_tracking.md) list | | ✓ | ✓ | ✓ | ✓ | | [Project operations](../operations/index.md):<br>Manage [Feature Flags](../operations/feature_flags.md) **(PREMIUM)** | | | ✓ | ✓ | ✓ | | [Project operations](../operations/index.md):<br>Manage [Error Tracking](../operations/error_tracking.md) | | | | ✓ | ✓ | @@ -239,6 +241,7 @@ The following table lists project permissions available for each role: 1. In projects that accept contributions from external members, users can create, edit, and close their own merge requests. 1. Authors and assignees of issues can modify the title and description even if they don't have the Reporter role. 1. Authors and assignees can close and reopen issues even if they don't have the Reporter role. +1. The ability to view the Container Registry and pull images is controlled by the [Container Registry's visibility permissions](packages/container_registry/index.md#container-registry-visibility-permissions). ## Project features permissions @@ -284,7 +287,8 @@ read through the documentation on [permissions and access to confidential issues ### Container Registry visibility permissions -Find the visibility permissions for the Container Registry, as described in the +The ability to view the Container Registry and pull images is controlled by the Container Registry's +visibility permissions. Find these permissions for the Container Registry as described in the [related documentation](packages/container_registry/index.md#container-registry-visibility-permissions). ## Group members permissions @@ -310,8 +314,11 @@ The following table lists group permissions available for each role: | Create/edit group epic **(PREMIUM)** | | ✓ | ✓ | ✓ | ✓ | | Create/edit/delete epic boards **(PREMIUM)** | | ✓ | ✓ | ✓ | ✓ | | Manage group labels | | ✓ | ✓ | ✓ | ✓ | +| Publish [packages](packages/index.md) | | | ✓ | ✓ | ✓ | | Pull [packages](packages/index.md) | | ✓ | ✓ | ✓ | ✓ | -| View a container registry | | ✓ | ✓ | ✓ | ✓ | +| Delete [packages](packages/index.md | | | | ✓ | ✓ | +| Pull a Container Registry image | ✓ (7) | ✓ | ✓ | ✓ | ✓ | +| Remove a Container Registry image | | | ✓ | ✓ | ✓ | | View Group DevOps Adoption **(ULTIMATE)** | | ✓ | ✓ | ✓ | ✓ | | View metrics dashboard annotations | | ✓ | ✓ | ✓ | ✓ | | View Productivity analytics **(PREMIUM)** | | ✓ | ✓ | ✓ | ✓ | @@ -322,7 +329,6 @@ The following table lists group permissions available for each role: | Create/edit/delete metrics dashboard annotations | | | ✓ | ✓ | ✓ | | Enable/disable a dependency proxy | | | ✓ | ✓ | ✓ | | Purge the dependency proxy for a group | | | | | ✓ | -| Publish [packages](packages/index.md) | | | ✓ | ✓ | ✓ | | Use security dashboard **(ULTIMATE)** | | | ✓ | ✓ | ✓ | | View group Audit Events | | | ✓ (7) | ✓ (7) | ✓ | | Create subgroup | | | | ✓ (1) | ✓ | diff --git a/doc/user/project/clusters/add_eks_clusters.md b/doc/user/project/clusters/add_eks_clusters.md index a5473629d4f..f435de617b0 100644 --- a/doc/user/project/clusters/add_eks_clusters.md +++ b/doc/user/project/clusters/add_eks_clusters.md @@ -34,7 +34,7 @@ Prerequisites: - An [Amazon Web Services](https://aws.amazon.com/) account. - Permissions to manage IAM resources. -For instance-level clusters, see [additional requirements for self-managed instances](#additional-requirements-for-self-managed-instances). **(FREE SELF)** +For instance-level clusters, see [additional requirements for self-managed instances](#additional-requirements-for-self-managed-instances). To create new Kubernetes clusters for your project, group, or instance through the certificate-based method: @@ -256,7 +256,7 @@ IAM user in the Amazon AWS console, and follow these steps: #### EKS access key and ID -> Instance profiles were [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291015) in GitLab 13.7. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291015) instance profiles in GitLab 13.7. If you're using GitLab 13.7 or later, you can use instance profiles to dynamically retrieve temporary credentials from AWS when needed. diff --git a/doc/user/project/clusters/add_existing_cluster.md b/doc/user/project/clusters/add_existing_cluster.md index acc5ed4cb30..0c3827bcbb1 100644 --- a/doc/user/project/clusters/add_existing_cluster.md +++ b/doc/user/project/clusters/add_existing_cluster.md @@ -4,7 +4,7 @@ group: Configure 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 --- -# Connect existing clusters through cluster certificates **(DEPRECATED)** +# Connect existing clusters through cluster certificates (DEPRECATED) **(FREE)** > [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. @@ -27,7 +27,7 @@ To add any cluster to GitLab, you need: - Either a GitLab.com account or an account for a self-managed installation running GitLab 12.5 or later. - The Maintainer role for group-level and project-level clusters. -- Access to the Admin area for instance-level clusters. **(FREE SELF)** +- Access to the Admin area for instance-level clusters. - A Kubernetes cluster. - Cluster administration access to the cluster with `kubectl`. diff --git a/doc/user/project/clusters/multiple_kubernetes_clusters.md b/doc/user/project/clusters/multiple_kubernetes_clusters.md index 12527853b40..a56eaa9b953 100644 --- a/doc/user/project/clusters/multiple_kubernetes_clusters.md +++ b/doc/user/project/clusters/multiple_kubernetes_clusters.md @@ -6,8 +6,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Multiple clusters per project with cluster certificates (DEPRECATED) **(FREE)** -> - Introduced in [GitLab Premium](https://about.gitlab.com/pricing/) 10.3 -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35094) to GitLab Free in 13.2. +> - Introduced in GitLab 10.3 +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35094) from GitLab Premium to GitLab Free in 13.2. > - [Deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. WARNING: diff --git a/doc/user/project/import/bitbucket_server.md b/doc/user/project/import/bitbucket_server.md index da47b673c29..65d830e0b1c 100644 --- a/doc/user/project/import/bitbucket_server.md +++ b/doc/user/project/import/bitbucket_server.md @@ -126,6 +126,14 @@ For information on automating user, group, and project import API calls, see ## Troubleshooting +### LFS objects not imported + +If the project import completes but LFS objects can't be downloaded or cloned, you may be using a +password or personal access token containing special characters. For more information, see +[this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/337769). + +### General + If the GUI-based import tool does not work, you can try to: - Use the [GitLab Import API](../../../api/import.md#import-repository-from-bitbucket-server) Bitbucket server endpoint. diff --git a/doc/user/project/issues/managing_issues.md b/doc/user/project/issues/managing_issues.md index 03286ff3617..c800511dedb 100644 --- a/doc/user/project/issues/managing_issues.md +++ b/doc/user/project/issues/managing_issues.md @@ -300,6 +300,8 @@ When you move an issue, it's closed and copied to the target project. The original issue is not deleted. A system note, which indicates where it came from and went to, is added to both issues. +Be careful when moving an issue to a project with different access rules. Before moving the issue, make sure it does not contain sensitive data. + Prerequisites: - You must have at least the [Reporter role](../../permissions.md) for the project. diff --git a/doc/user/project/quick_actions.md b/doc/user/project/quick_actions.md index 21a080de404..918b089bfd2 100644 --- a/doc/user/project/quick_actions.md +++ b/doc/user/project/quick_actions.md @@ -78,7 +78,7 @@ threads. Some quick actions might not be available to all subscription tiers. | `/lock` | **{check-circle}** Yes | **{check-circle}** Yes | **{dotted-circle}** No | Lock the discussions. | | `/merge` | **{dotted-circle}** No | **{check-circle}** Yes | **{dotted-circle}** No | Merge changes. Depending on the project setting, this may be [when the pipeline succeeds](merge_requests/merge_when_pipeline_succeeds.md), or adding to a [Merge Train](../../ci/pipelines/merge_trains.md). | | `/milestone %milestone` | **{check-circle}** Yes | **{check-circle}** Yes | **{dotted-circle}** No | Set milestone. | -| `/move <path/to/project>` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Move this issue to another project. | +| `/move <path/to/project>` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Move this issue to another project. Be careful when moving an issue to a project with different access rules. Before moving the issue, make sure it does not contain sensitive data. | | `/parent_epic <epic>` | **{dotted-circle}** No | **{dotted-circle}** No | **{check-circle}** Yes | Set parent epic to `<epic>`. The `<epic>` value should be in the format of `&epic`, `group&epic`, or a URL to an epic ([introduced in GitLab 12.1](https://gitlab.com/gitlab-org/gitlab/-/issues/10556)). | | `/promote` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Promote issue to epic. | | `/promote_to_incident` | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Promote issue to incident ([introduced in GitLab 14.5](https://gitlab.com/gitlab-org/gitlab/-/issues/296787)). | diff --git a/doc/user/search/index.md b/doc/user/search/index.md index 2c13d06a91d..408b55a6fe7 100644 --- a/doc/user/search/index.md +++ b/doc/user/search/index.md @@ -270,8 +270,13 @@ search, or choose a specific group or project. To search through code or other documents in a single project, you can use the search field on the top-right of your screen while the project page is open. -Code search shows only the first result in the file. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327052) -in GitLab 14.7, you can access Git blame from any line that returned a result from the code search: +Code search shows only the first result in the file. + +#### Git blame from code search **(PREMIUM)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/327052) in GitLab 14.7. + +You can access Git blame from any line that returned a result from the code search: ![code search results](img/code_search.png) |