Skip to content

G
gitlab-ce
Commit a374131b authored by Rémy Coutable's avatar Rémy Coutable
Browse files
Options

Update development Review Apps documentation with the latest changes 

Signed-off-by: default avatarRémy Coutable <remy@rymai.me>
parent 9649c2ef
Hide whitespace changes
Inline Side-by-side
Showing with 82 additions and 80 deletions
doc/development/testing_guide/review_apps.md
View file @ a374131b
...@@ -6,7 +6,7 @@ Review Apps are automatically deployed by each pipeline, both in ...@@ -6,7 +6,7 @@ Review Apps are automatically deployed by each pipeline, both in
## How does it work? ## How does it work?
### CD/CD architecture diagram ### CI/CD architecture diagram
![Review Apps CI/CD architecture](img/review_apps_cicd_architecture.png) ![Review Apps CI/CD architecture](img/review_apps_cicd_architecture.png)
...@@ -14,23 +14,29 @@ Review Apps are automatically deployed by each pipeline, both in ...@@ -14,23 +14,29 @@ Review Apps are automatically deployed by each pipeline, both in
<summary>Show mermaid source</summary> <summary>Show mermaid source</summary>
<pre> <pre>
graph TD graph TD
B1 -.->|2. once gitlab:assets:compile is done,<br />triggers a CNG-mirror pipeline and wait for it to be done| A2 build-qa-image -.->|once the `prepare` stage is done| gitlab:assets:compile
C1 -.->|2. once review-build-cng is done,<br />Helm deploys the Review App using the Cloud<br/>Native images built by the CNG-mirror pipeline| A3 review-build-cng -->|triggers a CNG-mirror pipeline and wait for it to be done| CNG-mirror
review-build-cng -.->|once the `test` stage is done| review-deploy
subgraph gitlab-ce/ee `test` stage review-deploy -.->|once the `review` stage is done| review-qa-smoke
A1[gitlab:assets:compile]
B1[review-build-cng] -->|1. wait for| A1 subgraph 1. gitlab-ce/ee `prepare` stage
C1[review-deploy] -->|1. wait for| B1 build-qa-image
D1[review-qa-smoke] -->|1. wait for| C1
D1[review-qa-smoke] -.->|2. once review-deploy is done| E1>gitlab-qa runs the smoke<br/>suite against the Review App]
end end
subgraph CNG-mirror pipeline subgraph 2. gitlab-ce/ee `test` stage
A2>Cloud Native images are built]; gitlab:assets:compile -->|plays dependent job once done| review-build-cng
end end
subgraph GCP `gitlab-review-apps` project subgraph 3. gitlab-ce/ee `review` stage
A3>"Cloud Native images are deployed to the<br />`review-apps-ce` or `review-apps-ee` Kubernetes (GKE) cluster"]; review-deploy["review-deploy<br /><br />Helm deploys the Review App using the Cloud<br/>Native images built by the CNG-mirror pipeline.<br /><br />Cloud Native images are deployed to the `review-apps-ce` or `review-apps-ee`<br />Kubernetes (GKE) cluster, in the GCP `gitlab-review-apps` project."]
end
subgraph 4. gitlab-ce/ee `qa` stage
review-qa-smoke[review-qa-smoke<br /><br />gitlab-qa runs the smoke suite against the Review App.]
end
subgraph CNG-mirror pipeline
CNG-mirror>Cloud Native images are built];
end end
</pre> </pre>
</details> </details>
...@@ -38,40 +44,37 @@ subgraph GCP `gitlab-review-apps` project ...@@ -38,40 +44,37 @@ subgraph GCP `gitlab-review-apps` project
### Detailed explanation ### Detailed explanation
1. On every [pipeline][gitlab-pipeline] during the `test` stage, the 1. On every [pipeline][gitlab-pipeline] during the `test` stage, the
[`review-build-cng`][review-build-cng] and [`gitlab:assets:compile`][gitlab:assets:compile] job is automatically started.
[`review-deploy`][review-deploy] jobs are automatically started. - Once it's done, it starts the [`review-build-cng`][review-build-cng]
- The [`review-deploy`][review-deploy] job waits for the manual job since the [`CNG-mirror`][cng-mirror] pipeline triggered in the
[`review-build-cng`][review-build-cng] job to finish. following step depends on it.
- The [`review-build-cng`][review-build-cng] job waits for the 1. The [`review-build-cng`][review-build-cng] job [triggers a pipeline][cng-mirror-pipeline]
[`gitlab:assets:compile`][gitlab:assets:compile] job to finish since the in the [`CNG-mirror`][cng-mirror] project.
[`CNG-mirror`][cng-mirror] pipeline triggered in the following step depends on it. - The [`CNG-mirror`][cng-mirror-pipeline] pipeline creates the Docker images of
1. Once the [`gitlab:assets:compile`][gitlab:assets:compile] job is done, each component (e.g. `gitlab-rails-ee`, `gitlab-shell`, `gitaly` etc.)
[`review-build-cng`][review-build-cng] [triggers a pipeline][cng-pipeline] based on the commit from the [GitLab pipeline][gitlab-pipeline] and stores
in the [`CNG-mirror`][cng-mirror] project. them in its [registry][cng-mirror-registry].
- The [`CNG-mirror`][cng-pipeline] pipeline creates the Docker images of - We use the [`CNG-mirror`][cng-mirror] project so that the `CNG`, (**C**loud
each component (e.g. `gitlab-rails-ee`, `gitlab-shell`, `gitaly` etc.) **N**ative **G**itLab), project's registry is not overloaded with a
based on the commit from the [GitLab pipeline][gitlab-pipeline] and store lot of transient Docker images.
them in its [registry][cng-mirror-registry]. - Note that the official CNG images are built by the `cloud-native-image`
- We use the [`CNG-mirror`][cng-mirror] project so that the `CNG`, (**C**loud job, which runs only for tags, and triggers itself a [`CNG`][cng] pipeline.
**N**ative **G**itLab), project's registry is not overloaded with a 1. Once the `test` stage is done, the [`review-deploy`][review-deploy] job
lot of transient Docker images. deploys the Review App using [the official GitLab Helm chart][helm-chart] to
1. Once the [`review-build-cng`][review-build-cng] job is done, the the [`review-apps-ce`][review-apps-ce] / [`review-apps-ee`][review-apps-ee]
[`review-deploy`][review-deploy] job deploys the Review App using Kubernetes cluster on GCP.
[the official GitLab Helm chart][helm-chart] to the - The actual scripts used to deploy the Review App can be found at
[`review-apps-ce`][review-apps-ce] / [`review-apps-ee`][review-apps-ee] [`scripts/review_apps/review-apps.sh`][review-apps.sh].
Kubernetes cluster on GCP. - These scripts are basically
- The actual scripts used to deploy the Review App can be found at [our official Auto DevOps scripts][Auto-DevOps.gitlab-ci.yml] where the
[`scripts/review_apps/review-apps.sh`][review-apps.sh]. default CNG images are overridden with the images built and stored in the
- These scripts are basically [`CNG-mirror` project's registry][cng-mirror-registry].
[our official Auto DevOps scripts][Auto-DevOps.gitlab-ci.yml] where the - Since we're using [the official GitLab Helm chart][helm-chart], this means
default CNG images are overridden with the images built and stored in the you get a dedicated environment for your branch that's very close to what
[`CNG-mirror` project's registry][cng-mirror-registry]. it would look in production.
- Since we're using [the official GitLab Helm chart][helm-chart], this means
you get a dedicated environment for your branch that's very close to what
it would look in production.
1. Once the [`review-deploy`][review-deploy] job succeeds, you should be able to 1. Once the [`review-deploy`][review-deploy] job succeeds, you should be able to
use your Review App thanks to the direct link to it from the MR widget. To log use your Review App thanks to the direct link to it from the MR widget. To log
into the Review App, see "Log into my Review App?" below. into the Review App, see "Log into my Review App?" below.
**Additional notes:** **Additional notes:**
...@@ -82,71 +85,69 @@ subgraph GCP `gitlab-review-apps` project ...@@ -82,71 +85,69 @@ subgraph GCP `gitlab-review-apps` project
- If the Review App deployment fails, you can simply retry it (there's no need - If the Review App deployment fails, you can simply retry it (there's no need
to run the [`review-stop`][gitlab-ci-yml] job first). to run the [`review-stop`][gitlab-ci-yml] job first).
- The manual [`review-stop`][gitlab-ci-yml] in the `test` stage can be used to - The manual [`review-stop`][gitlab-ci-yml] in the `test` stage can be used to
stop a Review App manually, and is also started by GitLab once a branch is stop a Review App manually, and is also started by GitLab once a merge
deleted. request's branch is deleted after being merged.
- Review Apps are cleaned up regularly using a pipeline schedule that runs - Review Apps are cleaned up regularly via a pipeline schedule that runs
the [`schedule:review-cleanup`][gitlab-ci-yml] job. the [`schedule:review-cleanup`][gitlab-ci-yml] job.
## QA runs ## QA runs
On every [pipeline][gitlab-pipeline] during the `test` stage, the On every [pipeline][gitlab-pipeline] in the `qa` stage (which comes after the
`review-qa-smoke` job is automatically started: it runs the QA smoke suite. `review` stage), the `review-qa-smoke` job is automatically started and it runs
You can also manually start the `review-qa-all`: it runs the QA full suite. the QA smoke suite.
Note that both jobs first wait for the `review-deploy` job to be finished. You can also manually start the `review-qa-all`: it runs the full QA suite.
## Performance Metrics ## Performance Metrics
On every [pipeline][gitlab-pipeline] during the `test` stage, the On every [pipeline][gitlab-pipeline] in the `qa` stage, the
`review-performance` job is automatically started: this job does basic `review-performance` job is automatically started: this job does basic
browser performance testing using [Sitespeed.io Container](https://docs.gitlab.com/ee/user/project/merge_requests/browser_performance_testing.html) . browser performance testing using a
[Sitespeed.io Container](https://docs.gitlab.com/ee/user/project/merge_requests/browser_performance_testing.html).
This job waits for the `review-deploy` job to be finished. ## How to:
## How to? ### Log into my Review App
### Log into my Review App?
The default username is `root` and its password can be found in the 1Password The default username is `root` and its password can be found in the 1Password
secure note named **gitlab-{ce,ee} Review App's root password**. secure note named **gitlab-{ce,ee} Review App's root password**.
### Enable a feature flag for my Review App? ### Enable a feature flag for my Review App
1. Open your Review App and log in as documented above. 1. Open your Review App and log in as documented above.
1. Create a personal access token. 1. Create a personal access token.
1. Enable the feature flag using the [Feature flag API](../../api/features.md). 1. Enable the feature flag using the [Feature flag API](../../api/features.md).
### Find my Review App slug? ### Find my Review App slug
1. Open the `review-deploy` job. 1. Open the `review-deploy` job.
1. Look for `Checking for previous deployment of review-*`. 1. Look for `Checking for previous deployment of review-*`.
1. For instance for `Checking for previous deployment of review-qa-raise-e-12chm0`, 1. For instance for `Checking for previous deployment of review-qa-raise-e-12chm0`,
your Review App slug would be `review-qa-raise-e-12chm0` in this case. your Review App slug would be `review-qa-raise-e-12chm0` in this case.
### Run a Rails console? ### Run a Rails console
1. [Filter Workloads by your Review App slug](https://console.cloud.google.com/kubernetes/workload?project=gitlab-review-apps) 1. [Filter Workloads by your Review App slug](https://console.cloud.google.com/kubernetes/workload?project=gitlab-review-apps)
, e.g. `review-29951-issu-id2qax`. , e.g. `review-qa-raise-e-12chm0`.
1. Find and open the `task-runner` Deployment, e.g. `review-29951-issu-id2qax-task-runner`. 1. Find and open the `task-runner` Deployment, e.g. `review-qa-raise-e-12chm0-task-runner`.
1. Click on the Pod in the "Managed pods" section, e.g. `review-29951-issu-id2qax-task-runner-d5455cc8-2lsvz`. 1. Click on the Pod in the "Managed pods" section, e.g. `review-qa-raise-e-12chm0-task-runner-d5455cc8-2lsvz`.
1. Click on the `KUBECTL` dropdown, then `Exec` -> `task-runner`. 1. Click on the `KUBECTL` dropdown, then `Exec` -> `task-runner`.
1. Replace `-c task-runner -- ls` with `-it -- gitlab-rails console` from the 1. Replace `-c task-runner -- ls` with `-it -- gitlab-rails console` from the
default command or default command or
- Run `kubectl exec --namespace review-apps-ce review-29951-issu-id2qax-task-runner-d5455cc8-2lsvz -it -- gitlab-rails console` - Run `kubectl exec --namespace review-apps-ce review-qa-raise-e-12chm0-task-runner-d5455cc8-2lsvz -it -- gitlab-rails console` and
and - Replace `review-apps-ce` with `review-apps-ee` if the Review App
- Replace `review-apps-ce` with `review-apps-ee` if the Review App is running EE, and
is running EE, and - Replace `review-qa-raise-e-12chm0-task-runner-d5455cc8-2lsvz`
- Replace `review-29951-issu-id2qax-task-runner-d5455cc8-2lsvz` with your Pod's name.
with your Pod's name.
### Dig into a Pod's logs? ### Dig into a Pod's logs
1. [Filter Workloads by your Review App slug](https://console.cloud.google.com/kubernetes/workload?project=gitlab-review-apps) 1. [Filter Workloads by your Review App slug](https://console.cloud.google.com/kubernetes/workload?project=gitlab-review-apps),
, e.g. `review-1979-1-mul-dnvlhv`. e.g. `review-qa-raise-e-12chm0`.
1. Find and open the `migrations` Deployment, e.g. 1. Find and open the `migrations` Deployment, e.g.
`review-1979-1-mul-dnvlhv-migrations.1`. `review-qa-raise-e-12chm0-migrations.1`.
1. Click on the Pod in the "Managed pods" section, e.g. 1. Click on the Pod in the "Managed pods" section, e.g.
`review-1979-1-mul-dnvlhv-migrations.1-nqwtx`. `review-qa-raise-e-12chm0-migrations.1-nqwtx`.
1. Click on the `Container logs` link. 1. Click on the `Container logs` link.
## Frequently Asked Questions ## Frequently Asked Questions
...@@ -182,7 +183,8 @@ find a way to limit it to only us.** ...@@ -182,7 +183,8 @@ find a way to limit it to only us.**
[review-build-cng]: https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/149511623 [review-build-cng]: https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/149511623
[review-deploy]: https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/149511624 [review-deploy]: https://gitlab.com/gitlab-org/gitlab-ce/-/jobs/149511624
[cng-mirror]: https://gitlab.com/gitlab-org/build/CNG-mirror [cng-mirror]: https://gitlab.com/gitlab-org/build/CNG-mirror
[cng-pipeline]: https://gitlab.com/gitlab-org/build/CNG-mirror/pipelines/44364657 [cng]: https://gitlab.com/gitlab-org/build/CNG
[cng-mirror-pipeline]: https://gitlab.com/gitlab-org/build/CNG-mirror/pipelines/44364657
[cng-mirror-registry]: https://gitlab.com/gitlab-org/build/CNG-mirror/container_registry [cng-mirror-registry]: https://gitlab.com/gitlab-org/build/CNG-mirror/container_registry
[helm-chart]: https://gitlab.com/charts/gitlab/ [helm-chart]: https://gitlab.com/charts/gitlab/
[review-apps-ce]: https://console.cloud.google.com/kubernetes/clusters/details/us-central1-a/review-apps-ce?project=gitlab-review-apps [review-apps-ce]: https://console.cloud.google.com/kubernetes/clusters/details/us-central1-a/review-apps-ce?project=gitlab-review-apps
......
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
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7