Commit f72d0515 authored by Marcin Sedlak-Jakubowski's avatar Marcin Sedlak-Jakubowski

Merge branch 'selhorn-deploy-boards-lowercase' into 'master'

Made all instances of deploy board lowercase

See merge request gitlab-org/gitlab!68610
parents 8949b9dd cce42a0c
...@@ -577,9 +577,9 @@ panel_groups: ...@@ -577,9 +577,9 @@ panel_groups:
See [Environment Dashboard](../ci/environments/environments_dashboard.md#adding-a-project-to-the-dashboard) for the maximum number of displayed projects. See [Environment Dashboard](../ci/environments/environments_dashboard.md#adding-a-project-to-the-dashboard) for the maximum number of displayed projects.
## Environment data on Deploy Boards ## Environment data on deploy boards
[Deploy Boards](../user/project/deploy_boards.md) load information from Kubernetes about [Deploy boards](../user/project/deploy_boards.md) load information from Kubernetes about
Pods and Deployments. However, data over 10 MB for a certain environment read from Pods and Deployments. However, data over 10 MB for a certain environment read from
Kubernetes won't be shown. Kubernetes won't be shown.
......
...@@ -732,7 +732,7 @@ the `review/feature-1` spec takes precedence over `review/*` and `*` specs. ...@@ -732,7 +732,7 @@ the `review/feature-1` spec takes precedence over `review/*` and `*` specs.
- [Use GitLab CI to deploy to multiple environments (blog post)](https://about.gitlab.com/blog/2021/02/05/ci-deployment-and-environments/) - [Use GitLab CI to deploy to multiple environments (blog post)](https://about.gitlab.com/blog/2021/02/05/ci-deployment-and-environments/)
- [Review Apps](../review_apps/index.md): Use dynamic environments to deploy your code for every branch. - [Review Apps](../review_apps/index.md): Use dynamic environments to deploy your code for every branch.
- [Deploy Boards](../../user/project/deploy_boards.md): View the status of your applications running on Kubernetes. - [Deploy boards](../../user/project/deploy_boards.md): View the status of your applications running on Kubernetes.
- [Protected environments](protected_environments.md): Determine who can deploy code to your environments. - [Protected environments](protected_environments.md): Determine who can deploy code to your environments.
- [Environments Dashboard](../environments/environments_dashboard.md): View a summary of each - [Environments Dashboard](../environments/environments_dashboard.md): View a summary of each
environment's operational health. **(PREMIUM)** environment's operational health. **(PREMIUM)**
......
...@@ -107,7 +107,7 @@ Its feature set is listed on the table below according to DevOps stages. ...@@ -107,7 +107,7 @@ Its feature set is listed on the table below according to DevOps stages.
| [Auto Deploy](../topics/autodevops/stages.md#auto-deploy) | Deploy your application to a production environment in a Kubernetes cluster. | | [Auto Deploy](../topics/autodevops/stages.md#auto-deploy) | Deploy your application to a production environment in a Kubernetes cluster. |
| [Building Docker images](docker/using_docker_build.md) | Maintain Docker-based projects using GitLab CI/CD. | | [Building Docker images](docker/using_docker_build.md) | Maintain Docker-based projects using GitLab CI/CD. |
| [Canary Deployments](../user/project/canary_deployments.md) | Ship features to only a portion of your pods and let a percentage of your user base to visit the temporarily deployed feature. | | [Canary Deployments](../user/project/canary_deployments.md) | Ship features to only a portion of your pods and let a percentage of your user base to visit the temporarily deployed feature. |
| [Deploy Boards](../user/project/deploy_boards.md) | Check the current health and status of each CI/CD environment running on Kubernetes. | | [Deploy boards](../user/project/deploy_boards.md) | Check the current health and status of each CI/CD environment running on Kubernetes. |
| [Feature Flags](../operations/feature_flags.md) **(PREMIUM)** | Deploy your features behind Feature Flags. | | [Feature Flags](../operations/feature_flags.md) **(PREMIUM)** | Deploy your features behind Feature Flags. |
| [GitLab Pages](../user/project/pages/index.md) | Deploy static websites. | | [GitLab Pages](../user/project/pages/index.md) | Deploy static websites. |
| [GitLab Releases](../user/project/releases/index.md) | Add release notes to Git tags. | | [GitLab Releases](../user/project/releases/index.md) | Add release notes to Git tags. |
......
...@@ -244,7 +244,7 @@ you to common environment tasks: ...@@ -244,7 +244,7 @@ you to common environment tasks:
- **Stop environment** (**{stop}**) - For more information, see - **Stop environment** (**{stop}**) - For more information, see
[Stopping an environment](../../ci/environments/index.md#stop-an-environment) [Stopping an environment](../../ci/environments/index.md#stop-an-environment)
GitLab displays the [Deploy Board](../../user/project/deploy_boards.md) below the GitLab displays the [deploy board](../../user/project/deploy_boards.md) below the
environment's information, with squares representing pods in your environment's information, with squares representing pods in your
Kubernetes cluster, color-coded to show their status. Hovering over a square on Kubernetes cluster, color-coded to show their status. Hovering over a square on
the deploy board displays the state of the deployment, and selecting the square the deploy board displays the state of the deployment, and selecting the square
......
...@@ -36,7 +36,7 @@ In order to: ...@@ -36,7 +36,7 @@ In order to:
[deploy to a Kubernetes cluster](../project/clusters/index.md#deploying-to-a-kubernetes-cluster) [deploy to a Kubernetes cluster](../project/clusters/index.md#deploying-to-a-kubernetes-cluster)
successfully. successfully.
- Show pod usage correctly, you must - Show pod usage correctly, you must
[enable Deploy Boards](../project/deploy_boards.md#enabling-deploy-boards). [enable deploy boards](../project/deploy_boards.md#enabling-deploy-boards).
After you have successful deployments to your group-level or instance-level cluster: After you have successful deployments to your group-level or instance-level cluster:
......
...@@ -66,7 +66,7 @@ With GitLab Enterprise Edition, you can also: ...@@ -66,7 +66,7 @@ With GitLab Enterprise Edition, you can also:
- [Mirror a repository](project/repository/repository_mirroring.md) from elsewhere on your local server. - [Mirror a repository](project/repository/repository_mirroring.md) from elsewhere on your local server.
- View your entire CI/CD pipeline involving more than one project with [Multiple-Project Pipelines](../ci/pipelines/multi_project_pipelines.md). - View your entire CI/CD pipeline involving more than one project with [Multiple-Project Pipelines](../ci/pipelines/multi_project_pipelines.md).
- [Lock files](project/file_lock.md) to prevent conflicts. - [Lock files](project/file_lock.md) to prevent conflicts.
- View the current health and status of each CI environment running on Kubernetes with [Deploy Boards](project/deploy_boards.md). - View the current health and status of each CI environment running on Kubernetes with [deploy boards](project/deploy_boards.md).
- Leverage continuous delivery method with [Canary Deployments](project/canary_deployments.md). - Leverage continuous delivery method with [Canary Deployments](project/canary_deployments.md).
- Scan your code for vulnerabilities and [display them in merge requests](application_security/sast/index.md). - Scan your code for vulnerabilities and [display them in merge requests](application_security/sast/index.md).
......
...@@ -26,7 +26,7 @@ percentage of users are affected and the change can either be fixed or quickly ...@@ -26,7 +26,7 @@ percentage of users are affected and the change can either be fixed or quickly
reverted. reverted.
Leveraging [Kubernetes' Canary deployments](https://kubernetes.io/docs/concepts/cluster-administration/manage-deployment/#canary-deployments), visualize your canary Leveraging [Kubernetes' Canary deployments](https://kubernetes.io/docs/concepts/cluster-administration/manage-deployment/#canary-deployments), visualize your canary
deployments right inside the [Deploy Board](deploy_boards.md), without the need to leave GitLab. deployments right inside the [deploy board](deploy_boards.md), without the need to leave GitLab.
## Use cases ## Use cases
...@@ -47,9 +47,9 @@ this document. ...@@ -47,9 +47,9 @@ this document.
## Enabling Canary Deployments ## Enabling Canary Deployments
Canary deployments require that you properly configure Deploy Boards: Canary deployments require that you properly configure deploy boards:
1. Follow the steps to [enable Deploy Boards](deploy_boards.md#enabling-deploy-boards). 1. Follow the steps to [enable deploy boards](deploy_boards.md#enabling-deploy-boards).
1. To track canary deployments you need to label your Kubernetes deployments and 1. To track canary deployments you need to label your Kubernetes deployments and
pods with `track: canary`. To get started quickly, you can use the [Auto Deploy](../../topics/autodevops/stages.md#auto-deploy) pods with `track: canary`. To get started quickly, you can use the [Auto Deploy](../../topics/autodevops/stages.md#auto-deploy)
template for canary deployments that GitLab provides. template for canary deployments that GitLab provides.
...@@ -61,13 +61,13 @@ This allows GitLab to discover whether a deployment is stable or canary (tempora ...@@ -61,13 +61,13 @@ This allows GitLab to discover whether a deployment is stable or canary (tempora
Once all of the above are set up and the pipeline has run at least once, Once all of the above are set up and the pipeline has run at least once,
navigate to the environments page under **Pipelines > Environments**. navigate to the environments page under **Pipelines > Environments**.
As the pipeline executes, Deploy Boards clearly mark canary pods, enabling As the pipeline executes, deploy boards clearly mark canary pods, enabling
quick and easy insight into the status of each environment and deployment. quick and easy insight into the status of each environment and deployment.
Canary deployments are marked with a yellow dot in the Deploy Board so that you Canary deployments are marked with a yellow dot in the deploy board so that you
can easily notice them. can easily notice them.
![Canary deployments on Deploy Board](img/deploy_boards_canary_deployments.png) ![Canary deployments on deploy board](img/deploy_boards_canary_deployments.png)
### Advanced traffic control with Canary Ingress ### Advanced traffic control with Canary Ingress
...@@ -104,17 +104,17 @@ Here's an example setup flow from scratch: ...@@ -104,17 +104,17 @@ Here's an example setup flow from scratch:
#### How to check the current traffic weight on a Canary Ingress #### How to check the current traffic weight on a Canary Ingress
1. Visit the [Deploy Board](../../user/project/deploy_boards.md). 1. Visit the [deploy board](../../user/project/deploy_boards.md).
1. View the current weights on the right. 1. View the current weights on the right.
![Rollout Status Canary Ingress](img/canary_weight.png) ![Rollout Status Canary Ingress](img/canary_weight.png)
#### How to change the traffic weight on a Canary Ingress #### How to change the traffic weight on a Canary Ingress
You can change the traffic weight within your environment's Deploy Board by using [GraphiQL](../../api/graphql/getting_started.md#graphiql), You can change the traffic weight within your environment's deploy board by using [GraphiQL](../../api/graphql/getting_started.md#graphiql),
or by sending requests to the [GraphQL API](../../api/graphql/getting_started.md#command-line). or by sending requests to the [GraphQL API](../../api/graphql/getting_started.md#command-line).
To use your [Deploy Board](../../user/project/deploy_boards.md): To use your [deploy board](../../user/project/deploy_boards.md):
1. Navigate to **Deployments > Environments** for your project. 1. Navigate to **Deployments > Environments** for your project.
1. Set the new weight with the dropdown on the right side. 1. Set the new weight with the dropdown on the right side.
......
...@@ -30,7 +30,7 @@ features such as: ...@@ -30,7 +30,7 @@ features such as:
- Use [role-based or attribute-based access controls](cluster_access.md). - Use [role-based or attribute-based access controls](cluster_access.md).
- Run serverless workloads on [Kubernetes with Knative](serverless/index.md). - Run serverless workloads on [Kubernetes with Knative](serverless/index.md).
- Connect GitLab to in-cluster applications using [cluster integrations](../../clusters/integrations.md). - Connect GitLab to in-cluster applications using [cluster integrations](../../clusters/integrations.md).
- Use [Deploy Boards](../deploy_boards.md) to see the health and status of each CI [environment](../../../ci/environments/index.md) running on your Kubernetes cluster. - Use [deploy boards](../deploy_boards.md) to see the health and status of each CI [environment](../../../ci/environments/index.md) running on your Kubernetes cluster.
- Use [Canary deployments](../canary_deployments.md) to update only a portion of your fleet with the latest version of your application. - Use [Canary deployments](../canary_deployments.md) to update only a portion of your fleet with the latest version of your application.
- View your [Kubernetes podlogs](kubernetes_pod_logs.md) directly in GitLab. - View your [Kubernetes podlogs](kubernetes_pod_logs.md) directly in GitLab.
- Connect to your cluster through GitLab [web terminals](deploy_to_cluster.md#web-terminals-for-kubernetes-clusters). - Connect to your cluster through GitLab [web terminals](deploy_to_cluster.md#web-terminals-for-kubernetes-clusters).
......
...@@ -46,15 +46,15 @@ a [metrics dashboard](../../../operations/metrics/index.md) and select **View lo ...@@ -46,15 +46,15 @@ a [metrics dashboard](../../../operations/metrics/index.md) and select **View lo
[permissions](../../permissions.md#project-members-permissions) in the project. [permissions](../../permissions.md#project-members-permissions) in the project.
1. To navigate to the **Log Explorer** from the sidebar menu, go to **Monitor > Logs** 1. To navigate to the **Log Explorer** from the sidebar menu, go to **Monitor > Logs**
([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22011) in GitLab 12.5.). ([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22011) in GitLab 12.5.).
1. To navigate to the **Log Explorer** from a specific pod on a [Deploy Board](../deploy_boards.md): 1. To navigate to the **Log Explorer** from a specific pod on a [deploy board](../deploy_boards.md):
1. Go to **Deployments > Environments** and find the environment 1. Go to **Deployments > Environments** and find the environment
which contains the desired pod, like `production`. which contains the desired pod, like `production`.
1. On the **Environments** page, you should see the status of the environment's 1. On the **Environments** page, you should see the status of the environment's
pods with [Deploy Boards](../deploy_boards.md). pods with [deploy boards](../deploy_boards.md).
1. When mousing over the list of pods, GitLab displays a tooltip with the exact pod name 1. When mousing over the list of pods, GitLab displays a tooltip with the exact pod name
and status. and status.
![Deploy Boards pod list](img/pod_logs_deploy_board.png) ![deploy boards pod list](img/pod_logs_deploy_board.png)
1. Click on the desired pod to display the **Log Explorer**. 1. Click on the desired pod to display the **Log Explorer**.
### Logs view ### Logs view
......
...@@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
type: howto, reference type: howto, reference
--- ---
# Deploy Boards **(FREE)** # Deploy boards **(FREE)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1589) in [GitLab Premium](https://about.gitlab.com/pricing/) 9.0. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1589) in [GitLab Premium](https://about.gitlab.com/pricing/) 9.0.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212320) to GitLab Free in 13.8. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212320) to GitLab Free in 13.8.
...@@ -16,7 +16,7 @@ type: howto, reference ...@@ -16,7 +16,7 @@ type: howto, reference
> This is [fixed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60525) in > This is [fixed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60525) in
> GitLab 13.12. > GitLab 13.12.
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
of the pods in the deployment. Developers and other teammates can view the of the pods in the deployment. Developers and other teammates can view the
progress and status of a rollout, pod by pod, in the workflow they already use progress and status of a rollout, pod by pod, in the workflow they already use
...@@ -28,23 +28,23 @@ environments by using [Auto DevOps](../../topics/autodevops/index.md). ...@@ -28,23 +28,23 @@ environments by using [Auto DevOps](../../topics/autodevops/index.md).
## Overview ## Overview
With Deploy Boards you can gain more insight into deploys with benefits such as: With deploy boards you can gain more insight into deploys with benefits such as:
- Following a deploy from the start, not just when it's done - Following a deploy from the start, not just when it's done
- Watching the rollout of a build across multiple servers - Watching the rollout of a build across multiple servers
- Finer state detail (Succeeded, Running, Failed, Pending, Unknown) - Finer state detail (Succeeded, Running, Failed, Pending, Unknown)
- See [Canary Deployments](canary_deployments.md) - See [Canary Deployments](canary_deployments.md)
Here's an example of a Deploy Board of the production environment. Here's an example of a deploy board of the production environment.
![Deploy Boards landing page](img/deploy_boards_landing_page.png) ![deploy boards landing page](img/deploy_boards_landing_page.png)
The squares represent pods in your Kubernetes cluster that are associated with The squares represent pods in your Kubernetes cluster that are associated with
the given environment. Hovering above each square you can see the state of a the given environment. Hovering above each square you can see the state of a
deploy rolling out. The percentage is the percent of the pods that are updated deploy rolling out. The percentage is the percent of the pods that are updated
to the latest release. to the latest release.
Since Deploy Boards are tightly coupled with Kubernetes, there is some required Since deploy boards are tightly coupled with Kubernetes, there is some required
knowledge. In particular, you should be familiar with: knowledge. In particular, you should be familiar with:
- [Kubernetes pods](https://kubernetes.io/docs/concepts/workloads/pods/) - [Kubernetes pods](https://kubernetes.io/docs/concepts/workloads/pods/)
...@@ -54,7 +54,7 @@ knowledge. In particular, you should be familiar with: ...@@ -54,7 +54,7 @@ knowledge. In particular, you should be familiar with:
## Use cases ## Use cases
Since the Deploy Board is a visual representation of the Kubernetes pods for a Since the deploy board is a visual representation of the Kubernetes pods for a
specific environment, there are a lot of use cases. To name a few: specific environment, there are a lot of use cases. To name a few:
- You want to promote what's running in staging, to production. You go to the - You want to promote what's running in staging, to production. You go to the
...@@ -73,9 +73,9 @@ specific environment, there are a lot of use cases. To name a few: ...@@ -73,9 +73,9 @@ specific environment, there are a lot of use cases. To name a few:
list, find the [Review App](../../ci/review_apps/index.md) you're interested in, and click the list, find the [Review App](../../ci/review_apps/index.md) you're interested in, and click the
manual action to deploy it to staging. manual action to deploy it to staging.
## Enabling Deploy Boards ## Enabling deploy boards
To display the Deploy Boards for a specific [environment](../../ci/environments/index.md) you should: To display the deploy boards for a specific [environment](../../ci/environments/index.md) you should:
1. Have [defined an environment](../../ci/environments/index.md) with a deploy stage. 1. Have [defined an environment](../../ci/environments/index.md) with a deploy stage.
...@@ -83,7 +83,7 @@ To display the Deploy Boards for a specific [environment](../../ci/environments/ ...@@ -83,7 +83,7 @@ To display the Deploy Boards for a specific [environment](../../ci/environments/
NOTE: NOTE:
If you're using OpenShift, ensure that you're using the `Deployment` resource If you're using OpenShift, ensure that you're using the `Deployment` resource
instead of `DeploymentConfiguration`. Otherwise, the Deploy Boards don't render instead of `DeploymentConfiguration`. Otherwise, the deploy boards don't render
correctly. For more information, read the correctly. For more information, read the
[OpenShift docs](https://docs.openshift.com/container-platform/3.7/dev_guide/deployments/kubernetes_deployments.html#kubernetes-deployments-vs-deployment-configurations) [OpenShift docs](https://docs.openshift.com/container-platform/3.7/dev_guide/deployments/kubernetes_deployments.html#kubernetes-deployments-vs-deployment-configurations)
and [GitLab issue #4584](https://gitlab.com/gitlab-org/gitlab/-/issues/4584). and [GitLab issue #4584](https://gitlab.com/gitlab-org/gitlab/-/issues/4584).
...@@ -114,17 +114,17 @@ To display the Deploy Boards for a specific [environment](../../ci/environments/ ...@@ -114,17 +114,17 @@ To display the Deploy Boards for a specific [environment](../../ci/environments/
If you use GCP to manage clusters, you can see the deployment details in GCP itself by navigating to **Workloads > deployment name > Details**: If you use GCP to manage clusters, you can see the deployment details in GCP itself by navigating to **Workloads > deployment name > Details**:
![Deploy Boards Kubernetes Label](img/deploy_boards_kubernetes_label.png) ![deploy boards Kubernetes Label](img/deploy_boards_kubernetes_label.png)
Once all of the above are set up and the pipeline has run at least once, Once all of the above are set up and the pipeline has run at least once,
navigate to the environments page under **Deployments > Environments**. navigate to the environments page under **Deployments > Environments**.
Deploy Boards are visible by default. You can explicitly click Deploy boards are visible by default. You can explicitly click
the triangle next to their respective environment name in order to hide them. the triangle next to their respective environment name in order to hide them.
### Example manifest file ### Example manifest file
The following example is an extract of a Kubernetes manifest deployment file, using the two annotations `app.gitlab.com/env` and `app.gitlab.com/app` to enable the **Deploy Boards**: The following example is an extract of a Kubernetes manifest deployment file, using the two annotations `app.gitlab.com/env` and `app.gitlab.com/app` to enable the **deploy boards**:
```yaml ```yaml
apiVersion: apps/v1 apiVersion: apps/v1
......
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