diff options
Diffstat (limited to 'doc/user/infrastructure')
| -rw-r--r-- | doc/user/infrastructure/clusters/connect/index.md | 2 | ||||
| -rw-r--r-- | doc/user/infrastructure/clusters/deploy/inventory_object.md | 14 | ||||
| -rw-r--r-- | doc/user/infrastructure/clusters/index.md | 9 | ||||
| -rw-r--r-- | doc/user/infrastructure/iac/index.md | 9 | ||||
| -rw-r--r-- | doc/user/infrastructure/iac/mr_integration.md | 4 | ||||
| -rw-r--r-- | doc/user/infrastructure/iac/terraform_state.md | 8 | ||||
| -rw-r--r-- | doc/user/infrastructure/index.md | 4 | ||||
| -rw-r--r-- | doc/user/infrastructure/mr_integration.md | 9 | ||||
| -rw-r--r-- | doc/user/infrastructure/terraform_state.md | 9 |
9 files changed, 28 insertions, 40 deletions
diff --git a/doc/user/infrastructure/clusters/connect/index.md b/doc/user/infrastructure/clusters/connect/index.md index 21387998a17..9e57622875d 100644 --- a/doc/user/infrastructure/clusters/connect/index.md +++ b/doc/user/infrastructure/clusters/connect/index.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w The [certificate-based Kubernetes integration with GitLab](../index.md) was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) -in GitLab 14.5. To connect your clusters, use the [GitLab Kubernetes Agent](../../../clusters/agent/index.md). +in GitLab 14.5. To connect your clusters, use the [GitLab Agent](../../../clusters/agent/index.md). <!-- TBA: (We need to resolve https://gitlab.com/gitlab-org/gitlab/-/issues/343660 before adding this line) If you don't have a cluster yet, create one and connect it to GitLab through the Agent. diff --git a/doc/user/infrastructure/clusters/deploy/inventory_object.md b/doc/user/infrastructure/clusters/deploy/inventory_object.md index d5840641aab..47063dcae96 100644 --- a/doc/user/infrastructure/clusters/deploy/inventory_object.md +++ b/doc/user/infrastructure/clusters/deploy/inventory_object.md @@ -9,10 +9,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332227) in GitLab 14.0. An inventory object is a `ConfigMap` object for keeping track of the set of objects applied to a cluster. -When you remove objects from a manifest repository, GitLab Kubernetes Agent uses a corresponding inventory object to +When you remove objects from a manifest repository, the Agent uses a corresponding inventory object to prune (delete) objects from the cluster. -The GitLab Kubernetes Agent creates an inventory object for each manifest project specified in the +The Agent creates an inventory object for each manifest project specified in the `gitops.manifest_projects` configuration section. The inventory object has to be stored somewhere in the cluster. The default behavior is: @@ -20,10 +20,10 @@ The default behavior is: explicitly, the inventory object is stored in the `default` namespace. - The `name` is generated from the numeric project ID of the manifest project and the numeric agent ID. - This way the GitLab Kubernetes Agent constructs the name and local where the inventory object is + This way the Agent constructs the name and local where the inventory object is stored in the cluster. -The GitLab Kubernetes Agent cannot locate the existing inventory object if you: +The Agent cannot locate the existing inventory object if you: - Change `gitops.manifest_projects[].default_namespace` parameter. - Move manifests into another project. @@ -57,13 +57,13 @@ metadata: ## Using GitOps with pre-existing Kubernetes objects -The GitLab Kubernetes Agent treats manifest files in the manifest repository as the source of truth. When it applies +The Agent treats manifest files in the manifest repository as the source of truth. When it applies objects from the files to the cluster, it tracks them in an inventory object. If an object already exists, -GitLab Kubernetes Agent behaves differently based on the `gitops.manifest_projects[].inventory_policy` configuration. +The Agent behaves differently based on the `gitops.manifest_projects[].inventory_policy` configuration. Check the table below with the available options and when to use them. `inventory_policy` value | Description | ------------------------ | ------------------------------------------------------------------------------------------- | `must_match` | This is the default policy. A live object must have the `config.k8s.io/owning-inventory` annotation set to the same value as the `cli-utils.sigs.k8s.io/inventory-id` label on the corresponding inventory object to be updated. Object is not updated and an error is reported if the values don't match or the object doesn't have the annotation. | `adopt_if_no_inventory` | This mode allows to "adopt" an object if it doesn't have the `config.k8s.io/owning-inventory` annotation. Use this mode if you want to start managing existing objects using the GitOps feature. Once all objects have been "adopted", we recommend you to put the setting back into the default `must_match` mode to avoid any unexpected adoptions. | -`adopt_all` | This mode allows to "adopt" an object even if it has the `config.k8s.io/owning-inventory` annotation set to a different value. This mode can be useful if you want to migrate a set of objects from one agent to another one or from some other tool to the GitLab Kubernetes Agent. Once all objects have been "adopted", we recommend you to put the setting back into the default `must_match` mode to avoid any unexpected adoptions. | +`adopt_all` | This mode allows to "adopt" an object even if it has the `config.k8s.io/owning-inventory` annotation set to a different value. This mode can be useful if you want to migrate a set of objects from one agent to another one or from some other tool to the Agent. Once all objects have been "adopted", we recommend you to put the setting back into the default `must_match` mode to avoid any unexpected adoptions. | diff --git a/doc/user/infrastructure/clusters/index.md b/doc/user/infrastructure/clusters/index.md index 06a77912876..144a8cd2d31 100644 --- a/doc/user/infrastructure/clusters/index.md +++ b/doc/user/infrastructure/clusters/index.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Kubernetes clusters **(FREE)** -To connect clusters to GitLab, use the [GitLab Kubernetes Agent](../../clusters/agent/index.md). +To connect clusters to GitLab, use the [GitLab Agent](../../clusters/agent/index.md). ## Certificate-based Kubernetes integration (DEPRECATED) @@ -24,7 +24,7 @@ It had the following issues: - Users were constantly reporting issues with features based on this model. For this reason, we started to build features based on a new model, the -[GitLab Kubernetes Agent](../../clusters/agent/index.md). +[GitLab Agent](../../clusters/agent/index.md). Maintaining both methods in parallel caused a lot of confusion and significantly increased the complexity to use, develop, maintain, and document them. For this reason, we decided to deprecate them to focus on the @@ -38,7 +38,7 @@ Follow this [epic](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) for updates. You can find technical information about why we moved away from cluster certificates into -the Kubernetes Agent model on the [Agent's blueprint documentation](../../../architecture/blueprints/gitlab_to_kubernetes_communication/index.md). +the GitLab Agent model on the [Agent's blueprint documentation](../../../architecture/blueprints/gitlab_to_kubernetes_communication/index.md). ## Deprecated features @@ -52,13 +52,12 @@ the Kubernetes Agent model on the [Agent's blueprint documentation](../../../arc - [Cluster integrations](../../clusters/integrations.md) - [Cluster cost management](../../clusters/cost_management.md) - [Cluster environments](../../clusters/environments.md) -- [Canary Deployments](../../project/canary_deployments.md) +- [Advanced traffic control with Canary Ingress](../../project/canary_deployments.md#advanced-traffic-control-with-canary-ingress-deprecated) - [Serverless](../../project/clusters/serverless/index.md) - [Deploy Boards](../../project/deploy_boards.md) - [Pod logs](../../project/clusters/kubernetes_pod_logs.md) - [Clusters health](manage/clusters_health.md) - [Crossplane integration](../../clusters/crossplane.md) -- [Auto Deploy](../../../topics/autodevops/stages.md#auto-deploy) - [Web terminals](../../../administration/integration/terminal.md) ### Cluster levels diff --git a/doc/user/infrastructure/iac/index.md b/doc/user/infrastructure/iac/index.md index 89df9c1d18f..15a680e2193 100644 --- a/doc/user/infrastructure/iac/index.md +++ b/doc/user/infrastructure/iac/index.md @@ -96,10 +96,17 @@ owned by GitLab, where everyone can contribute. The [documentation of the provider](https://registry.terraform.io/providers/gitlabhq/gitlab/latest/docs) is available as part of the official Terraform provider documentations. -## Create a new cluster through IaC +## Create a new cluster through IaC (DEPRECATED) Learn how to [create a new cluster on Google Kubernetes Engine (GKE)](../clusters/connect/new_gke_cluster.md). +NOTE: +The linked tutorial connects the cluster to GitLab through cluster certificates, +and this method was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) +in GitLab 14.5. You can still create a cluster through IaC and then connect it to GitLab +through the [Agent](../../clusters/agent/index.md), the default and fully supported +method to connect clusters to GitLab. + ## Troubleshooting ### `gitlab_group_share_group` resources not detected when subgroup state is refreshed diff --git a/doc/user/infrastructure/iac/mr_integration.md b/doc/user/infrastructure/iac/mr_integration.md index e92b2d919ae..ab59f8ad64b 100644 --- a/doc/user/infrastructure/iac/mr_integration.md +++ b/doc/user/infrastructure/iac/mr_integration.md @@ -10,7 +10,7 @@ Collaborating around Infrastructure as Code (IaC) changes requires both code cha ## Output Terraform Plan information into a merge request -Using the [GitLab Terraform Report artifact](../../../ci/yaml/index.md#artifactsreportsterraform), +Using the [GitLab Terraform Report artifact](../../../ci/yaml/artifacts_reports.md#artifactsreportsterraform), you can expose details from `terraform plan` runs directly into a merge request widget, enabling you to see statistics about the resources that Terraform creates, modifies, or destroys. @@ -62,7 +62,7 @@ To manually configure a GitLab Terraform Report artifact: 1. Define a `script` that runs `terraform plan` and `terraform show`. These commands pipe the output and convert the relevant bits into a store variable `PLAN_JSON`. This JSON is used to create a - [GitLab Terraform Report artifact](../../../ci/yaml/index.md#artifactsreportsterraform). + [GitLab Terraform Report artifact](../../../ci/yaml/artifacts_reports.md#artifactsreportsterraform). The Terraform report obtains a Terraform `tfplan.json` file. The collected Terraform plan report is uploaded to GitLab as an artifact, and is shown in merge requests. diff --git a/doc/user/infrastructure/iac/terraform_state.md b/doc/user/infrastructure/iac/terraform_state.md index 84d1edbe2f7..a45ef02622f 100644 --- a/doc/user/infrastructure/iac/terraform_state.md +++ b/doc/user/infrastructure/iac/terraform_state.md @@ -17,7 +17,7 @@ to securely store the state files in local storage (the default) or WARNING: Using local storage (the default) on clustered deployments of GitLab will result in a split state across nodes, making subsequent executions of Terraform inconsistent. -You are highly advised to use a remote storage in that case. +You are highly advised to use a remote storage resource in that case. The GitLab managed Terraform state backend can store your Terraform state easily and securely, and spares you from setting up additional remote resources like @@ -28,7 +28,7 @@ Amazon S3 or Google Cloud Storage. Its features include: - Locking and unlocking state. - Remote Terraform plan and apply execution. -A GitLab **administrator** must [setup the Terraform state storage configuration](../../../administration/terraform_state.md) +A GitLab **administrator** must [set up the Terraform state storage configuration](../../../administration/terraform_state.md) before using this feature. ## Permissions for using Terraform @@ -89,7 +89,7 @@ local machine, this is a simple way to get started: ``` If you already have a GitLab-managed Terraform state, you can use the `terraform init` command -with the prepopulated parameters values: +with the pre-populated parameters values: 1. On the top bar, select **Menu > Projects** and find your project. 1. On the left sidebar, select **Infrastructure > Terraform**. @@ -300,7 +300,7 @@ any changes that are required for your infrastructure. All Terraform commands should now work. If you ever set or change modules or backend configuration for Terraform, -rerun this command to reinitialize your working directory. If you forget, other +re-run this command to reinitialize your working directory. If you forget, other commands will detect it and remind you to do so if necessary. ``` diff --git a/doc/user/infrastructure/index.md b/doc/user/infrastructure/index.md index 3bb518596cc..d8e75928675 100644 --- a/doc/user/infrastructure/index.md +++ b/doc/user/infrastructure/index.md @@ -30,11 +30,11 @@ Learn more about how GitLab can help you run [Infrastructure as Code](iac/index. ## Integrated Kubernetes management The GitLab integration with Kubernetes helps you to install, configure, manage, deploy, and troubleshoot -cluster applications. With the GitLab Kubernetes Agent, you can connect clusters behind a firewall, +cluster applications. With the GitLab Agent, you can connect clusters behind a firewall, have real-time access to API endpoints, perform pull-based or push-based deployments for production and non-production environments, and much more. -Learn more about the [GitLab Kubernetes Agent](../clusters/agent/index.md). +Learn more about the [GitLab Agent](../clusters/agent/index.md). ## Runbooks in GitLab diff --git a/doc/user/infrastructure/mr_integration.md b/doc/user/infrastructure/mr_integration.md deleted file mode 100644 index 81e8f7cbd33..00000000000 --- a/doc/user/infrastructure/mr_integration.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -redirect_to: 'iac/mr_integration.md' -remove_date: '2021-11-26' ---- - -This document was moved to [another location](iac/mr_integration.md). - -<!-- This redirect file can be deleted after <2021-11-26>. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/user/infrastructure/terraform_state.md b/doc/user/infrastructure/terraform_state.md deleted file mode 100644 index e71291d502e..00000000000 --- a/doc/user/infrastructure/terraform_state.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -redirect_to: 'iac/terraform_state.md' -remove_date: '2021-11-26' ---- - -This document was moved to [another location](iac/terraform_state.md). - -<!-- This redirect file can be deleted after <2021-11-26>. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> |