Commit ade0dc8b authored by Suzanne Selhorn's avatar Suzanne Selhorn

Updated agent to lowercase

Related to: https://gitlab.com/gitlab-org/technical-writing/-/issues/528
We want to standardize on lowercase
See the recommended word list for details
parent 6f0018b1
...@@ -349,7 +349,7 @@ Component statuses are linked to configuration documentation for each component. ...@@ -349,7 +349,7 @@ Component statuses are linked to configuration documentation for each component.
| [GitLab Exporter](#gitlab-exporter) | Generates a variety of GitLab metrics | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | CE & EE | | [GitLab Exporter](#gitlab-exporter) | Generates a variety of GitLab metrics | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ | ❌ | CE & EE |
| [GitLab Geo Node](#gitlab-geo) | Geographically distributed GitLab nodes | ⚙ | ⚙ | ❌ | ❌ | ✅ | ❌ | ⚙ | EE Only | | [GitLab Geo Node](#gitlab-geo) | Geographically distributed GitLab nodes | ⚙ | ⚙ | ❌ | ❌ | ✅ | ❌ | ⚙ | EE Only |
| [GitLab Pages](#gitlab-pages) | Hosts static websites | ⚙ | ⚙ | ❌ | ❌ | ✅ | ⚙ | ⚙ | CE & EE | | [GitLab Pages](#gitlab-pages) | Hosts static websites | ⚙ | ⚙ | ❌ | ❌ | ✅ | ⚙ | ⚙ | CE & EE |
| [GitLab Agent](#gitlab-agent) | Integrate Kubernetes clusters in a cloud-native way | ⚙ | ⚙ | ⚙ | ❌ | ❌ | ⤓ | ⚙ | EE Only | | [GitLab agent](#gitlab-agent) | Integrate Kubernetes clusters in a cloud-native way | ⚙ | ⚙ | ⚙ | ❌ | ❌ | ⤓ | ⚙ | EE Only |
| [GitLab self-monitoring: Alertmanager](#alertmanager) | Deduplicates, groups, and routes alerts from Prometheus | ⚙ | ⚙ | ✅ | ⚙ | ✅ | ❌ | ❌ | CE & EE | | [GitLab self-monitoring: Alertmanager](#alertmanager) | Deduplicates, groups, and routes alerts from Prometheus | ⚙ | ⚙ | ✅ | ⚙ | ✅ | ❌ | ❌ | CE & EE |
| [GitLab self-monitoring: Grafana](#grafana) | Metrics dashboard | ✅ | ✅ | ⚙ | ⤓ | ✅ | ❌ | ⚙ | CE & EE | | [GitLab self-monitoring: Grafana](#grafana) | Metrics dashboard | ✅ | ✅ | ⚙ | ⤓ | ✅ | ❌ | ⚙ | CE & EE |
| [GitLab self-monitoring: Jaeger](#jaeger) | View traces generated by the GitLab instance | ❌ | ⚙ | ⚙ | ❌ | ❌ | ⤓ | ⚙ | CE & EE | | [GitLab self-monitoring: Jaeger](#jaeger) | View traces generated by the GitLab instance | ❌ | ⚙ | ⚙ | ❌ | ❌ | ⤓ | ⚙ | CE & EE |
...@@ -499,14 +499,14 @@ Geo is a premium feature built to help speed up the development of distributed t ...@@ -499,14 +499,14 @@ Geo is a premium feature built to help speed up the development of distributed t
GitLab Exporter is a process designed in house that allows us to export metrics about GitLab application internals to Prometheus. You can read more [in the project's README](https://gitlab.com/gitlab-org/gitlab-exporter). GitLab Exporter is a process designed in house that allows us to export metrics about GitLab application internals to Prometheus. You can read more [in the project's README](https://gitlab.com/gitlab-org/gitlab-exporter).
#### GitLab Agent #### GitLab agent
- [Project page](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent) - [Project page](https://gitlab.com/gitlab-org/cluster-integration/gitlab-agent)
- Configuration: - Configuration:
- [Omnibus](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template) - [Omnibus](https://gitlab.com/gitlab-org/omnibus-gitlab/blob/master/files/gitlab-config-template/gitlab.rb.template)
- [Charts](https://docs.gitlab.com/charts/charts/gitlab/kas/index.html) - [Charts](https://docs.gitlab.com/charts/charts/gitlab/kas/index.html)
The [GitLab Agent](../user/clusters/agent/index.md) is an active in-cluster The [GitLab agent](../user/clusters/agent/index.md) is an active in-cluster
component for solving GitLab and Kubernetes integration tasks in a secure and component for solving GitLab and Kubernetes integration tasks in a secure and
cloud-native way. cloud-native way.
......
...@@ -8,10 +8,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -8,10 +8,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w
The [certificate-based Kubernetes integration with GitLab](../index.md) The [certificate-based Kubernetes integration with GitLab](../index.md)
was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8)
in GitLab 14.5. To connect your clusters, use the [GitLab 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) <!-- 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. If you don't have a cluster yet, create one and connect it to GitLab through the agent.
You can also create a new cluster from GitLab using [Infrastructure as Code](../../iac/index.md#create-a-new-cluster-through-iac). You can also create a new cluster from GitLab using [Infrastructure as Code](../../iac/index.md#create-a-new-cluster-through-iac).
--> -->
......
...@@ -79,8 +79,8 @@ contains other variables that you can override according to your needs: ...@@ -79,8 +79,8 @@ contains other variables that you can override according to your needs:
- `TF_VAR_cluster_version`: Set the version of Kubernetes. - `TF_VAR_cluster_version`: Set the version of Kubernetes.
- `TF_VAR_instance_type`: Set the instance type for the Kubernetes nodes. - `TF_VAR_instance_type`: Set the instance type for the Kubernetes nodes.
- `TF_VAR_instance_count`: Set the number of Kubernetes nodes. - `TF_VAR_instance_count`: Set the number of Kubernetes nodes.
- `TF_VAR_agent_version`: Set the version of the GitLab Agent. - `TF_VAR_agent_version`: Set the version of the GitLab agent.
- `TF_VAR_agent_namespace`: Set the Kubernetes namespace for the GitLab Agent. - `TF_VAR_agent_namespace`: Set the Kubernetes namespace for the GitLab agent.
View the [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) and the [Kubernetes Terraform provider](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs) documentation for further resource options. View the [AWS Terraform provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs) and the [Kubernetes Terraform provider](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs) documentation for further resource options.
......
...@@ -11,9 +11,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -11,9 +11,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w
WARNING: WARNING:
The process described on this page uses cluster certificates to connect the The process described on this page uses cluster certificates to connect the
new cluster to GitLab, [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. new cluster to GitLab, [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
You can still create a cluster and then connect it to GitLab through the [Agent](../index.md). You can still create a cluster and then connect it to GitLab through the [agent](../index.md).
[An issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/343660) [An issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/343660)
to migrate this functionality to the [Agent](../index.md). to migrate this functionality to the [agent](../index.md).
Learn how to create a new cluster on Google Kubernetes Engine (GKE) through Learn how to create a new cluster on Google Kubernetes Engine (GKE) through
[Infrastructure as Code (IaC)](../../index.md). [Infrastructure as Code (IaC)](../../index.md).
......
...@@ -9,10 +9,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -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. > [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. 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, the 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. prune (delete) objects from the cluster.
The 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. `gitops.manifest_projects` configuration section. The inventory object has to be stored somewhere in the cluster.
The default behavior is: The default behavior is:
...@@ -20,10 +20,10 @@ The default behavior is: ...@@ -20,10 +20,10 @@ The default behavior is:
explicitly, the inventory object is stored in the `default` namespace. 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. - The `name` is generated from the numeric project ID of the manifest project and the numeric agent ID.
This way, the Agent constructs the name and location where the inventory object is This way, the agent constructs the name and location where the inventory object is
stored in the cluster. stored in the cluster.
The 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. - Change `gitops.manifest_projects[].default_namespace` parameter.
- Move manifests into another project. - Move manifests into another project.
...@@ -57,13 +57,13 @@ metadata: ...@@ -57,13 +57,13 @@ metadata:
## Using GitOps with pre-existing Kubernetes objects ## Using GitOps with pre-existing Kubernetes objects
The 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, objects from the files to the cluster, it tracks them in an inventory object. If an object already exists,
The 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. Check the table below with the available options and when to use them.
`inventory_policy` value | Description | `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. | `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_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 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. |
...@@ -11,7 +11,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -11,7 +11,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
WARNING: WARNING:
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. To connect clusters to GitLab, This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. To connect clusters to GitLab,
use the [GitLab Agent](../../clusters/agent/index.md). use the [GitLab agent](../../clusters/agent/index.md).
Similar to [project-level](../../project/clusters/index.md) Similar to [project-level](../../project/clusters/index.md)
and [group-level](../../group/clusters/index.md) Kubernetes clusters, and [group-level](../../group/clusters/index.md) Kubernetes clusters,
......
...@@ -19,7 +19,7 @@ Kubernetes Service (EKS). ...@@ -19,7 +19,7 @@ Kubernetes Service (EKS).
## Connect an existing EKS cluster ## Connect an existing EKS cluster
If you already have an EKS cluster and want to connect it to GitLab, If you already have an EKS cluster and want to connect it to GitLab,
use the [GitLab Agent](../../clusters/agent/index.md). use the [GitLab agent](../../clusters/agent/index.md).
## Create a new EKS cluster ## Create a new EKS cluster
......
...@@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
WARNING: WARNING:
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
To connect your cluster to GitLab, use the [GitLab Agent](../../clusters/agent/index.md) To connect your cluster to GitLab, use the [GitLab agent](../../clusters/agent/index.md)
instead. instead.
If you have an existing Kubernetes cluster, you can add it to a project, group, If you have an existing Kubernetes cluster, you can add it to a project, group,
......
...@@ -19,7 +19,7 @@ hosted on Google Kubernetes Engine (GKE). ...@@ -19,7 +19,7 @@ hosted on Google Kubernetes Engine (GKE).
## Connect an existing GKE cluster ## Connect an existing GKE cluster
If you already have a GKE cluster and want to connect it to GitLab, If you already have a GKE cluster and want to connect it to GitLab,
use the [GitLab Agent](../../clusters/agent/index.md). use the [GitLab agent](../../clusters/agent/index.md).
## Create a new GKE cluster from GitLab ## Create a new GKE cluster from GitLab
......
...@@ -49,7 +49,7 @@ supports connecting existing clusters using the certificate-based connection met ...@@ -49,7 +49,7 @@ supports connecting existing clusters using the certificate-based connection met
## Add existing cluster ## Add existing cluster
As of GitLab 14.0, use the [GitLab Agent](../../clusters/agent/index.md) As of GitLab 14.0, use the [GitLab agent](../../clusters/agent/index.md)
to connect your cluster to GitLab. to connect your cluster to GitLab.
Alternatively, you can [add an existing cluster](add_existing_cluster.md) Alternatively, you can [add an existing cluster](add_existing_cluster.md)
...@@ -57,7 +57,7 @@ through the certificate-based method, but we don't recommend using this method f ...@@ -57,7 +57,7 @@ through the certificate-based method, but we don't recommend using this method f
## Configure your cluster ## Configure your cluster
As of GitLab 14.0, use the [GitLab Agent](../../clusters/agent/index.md) As of GitLab 14.0, use the [GitLab agent](../../clusters/agent/index.md)
to configure your cluster. to configure your cluster.
## Disable a cluster ## Disable a cluster
......
...@@ -11,7 +11,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -11,7 +11,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
WARNING: WARNING:
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
To connect your cluster to GitLab, use the [GitLab Agent](../../clusters/agent/index.md) To connect your cluster to GitLab, use the [GitLab agent](../../clusters/agent/index.md)
instead. instead.
When creating a cluster in GitLab, you are asked if you would like to create either: When creating a cluster in GitLab, you are asked if you would like to create either:
......
...@@ -10,8 +10,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -10,8 +10,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
WARNING: WARNING:
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
To connect your cluster to GitLab, use the [GitLab Agent](../../clusters/agent/index.md). To connect your cluster to GitLab, use the [GitLab agent](../../clusters/agent/index.md).
To deploy with the Agent, use the [CI/CD Tunnel](../../clusters/agent/ci_cd_tunnel.md). To deploy with the agent, use the [CI/CD workflow](../../clusters/agent/ci_cd_tunnel.md).
A Kubernetes cluster can be the destination for a deployment job. If A Kubernetes cluster can be the destination for a deployment job. If
......
...@@ -12,7 +12,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -12,7 +12,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
WARNING: WARNING:
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
To connect your cluster to GitLab, use the [GitLab Agent](../../../user/clusters/agent/index.md). To connect your cluster to GitLab, use the [GitLab agent](../../../user/clusters/agent/index.md).
To manage applications, use the [Cluster Project Management Template](../../../user/clusters/management_project_template.md). To manage applications, use the [Cluster Project Management Template](../../../user/clusters/management_project_template.md).
You can choose to allow GitLab to manage your cluster for you. If your cluster You can choose to allow GitLab to manage your cluster for you. If your cluster
......
...@@ -12,7 +12,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -12,7 +12,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
WARNING: WARNING:
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8)
in GitLab 14.5. To connect clusters to GitLab, use the in GitLab 14.5. To connect clusters to GitLab, use the
[GitLab Agent](../../clusters/agent/index.md). [GitLab agent](../../clusters/agent/index.md).
[Project-level](../../infrastructure/clusters/connect/index.md#cluster-levels-deprecated) Kubernetes clusters [Project-level](../../infrastructure/clusters/connect/index.md#cluster-levels-deprecated) Kubernetes clusters
allow you to connect a Kubernetes cluster to a project in GitLab. allow you to connect a Kubernetes cluster to a project in GitLab.
......
...@@ -13,7 +13,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -13,7 +13,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
WARNING: WARNING:
Using multiple Kubernetes clusters for a single project **with cluster Using multiple Kubernetes clusters for a single project **with cluster
certificates** was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. certificates** was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
To connect clusters to GitLab, use the [GitLab Agent](../../../user/clusters/agent/index.md). To connect clusters to GitLab, use the [GitLab agent](../../../user/clusters/agent/index.md).
You can associate more than one Kubernetes cluster to your You can associate more than one Kubernetes cluster to your
project. That way you can have different clusters for different environments, project. That way you can have different clusters for different environments,
......
...@@ -20,7 +20,7 @@ type: howto, reference ...@@ -20,7 +20,7 @@ type: howto, reference
WARNING: WARNING:
This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5. This feature was [deprecated](https://gitlab.com/groups/gitlab-org/configure/-/epics/8) in GitLab 14.5.
[An epic exists](https://gitlab.com/groups/gitlab-org/-/epics/2493) [An epic exists](https://gitlab.com/groups/gitlab-org/-/epics/2493)
to add this functionality to the [Agent](../index.md). to add this functionality to the [agent](../index.md).
GitLab deploy boards offer a consolidated view of the current health and GitLab deploy boards offer a consolidated view of the current health and
status of each CI [environment](../../ci/environments/index.md) running on [Kubernetes](https://kubernetes.io), displaying the status status of each CI [environment](../../ci/environments/index.md) running on [Kubernetes](https://kubernetes.io), displaying the status
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment