Use Mermaid Markdown for testing guide docs
* Remove PNGs in favor of dynamically rendered graphs * Eliminate <b> styling because this is no longer supported * Change <br /> to <br> because the latter is only supported * Add quotes around subgraph titles
This commit is contained in:
parent
cbe51cce7a
commit
a3e18e7c97
|
@ -65,28 +65,24 @@ Below you can read more about how to use it and how does it work.
|
||||||
Currently, we are using _multi-project pipeline_-like approach to run QA
|
Currently, we are using _multi-project pipeline_-like approach to run QA
|
||||||
pipelines.
|
pipelines.
|
||||||
|
|
||||||
![QA on merge requests CI/CD architecture](../img/qa_on_merge_requests_cicd_architecture.png)
|
```mermaid
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Show mermaid source</summary>
|
|
||||||
<pre>
|
|
||||||
graph LR
|
graph LR
|
||||||
A1 -.->|1. Triggers an omnibus-gitlab pipeline and wait for it to be done| A2
|
A1 -.->|1. Triggers an omnibus-gitlab pipeline and wait for it to be done| A2
|
||||||
B2[<b>`Trigger-qa` stage</b><br />`Trigger:qa-test` job] -.->|2. Triggers a gitlab-qa pipeline and wait for it to be done| A3
|
B2[`Trigger-qa` stage<br>`Trigger:qa-test` job] -.->|2. Triggers a gitlab-qa pipeline and wait for it to be done| A3
|
||||||
|
|
||||||
subgraph gitlab-ce/ee pipeline
|
subgraph "gitlab-ce/ee pipeline"
|
||||||
A1[<b>`test` stage</b><br />`package-and-qa` job]
|
A1[`test` stage<br>`package-and-qa` job]
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph omnibus-gitlab pipeline
|
subgraph "omnibus-gitlab pipeline"
|
||||||
A2[<b>`Trigger-docker` stage</b><br />`Trigger:gitlab-docker` job] -->|once done| B2
|
A2[`Trigger-docker` stage<br>`Trigger:gitlab-docker` job] -->|once done| B2
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph gitlab-qa pipeline
|
subgraph "gitlab-qa pipeline"
|
||||||
A3>QA jobs run] -.->|3. Reports back the pipeline result to the `package-and-qa` job<br />and post the result on the original commit tested| A1
|
A3>QA jobs run] -.->|3. Reports back the pipeline result to the `package-and-qa` job<br>and post the result on the original commit tested| A1
|
||||||
end
|
end
|
||||||
</pre>
|
```
|
||||||
</details>
|
|
||||||
|
|
||||||
1. Developer triggers a manual action, that can be found in CE / EE merge
|
1. Developer triggers a manual action, that can be found in CE / EE merge
|
||||||
requests. This starts a chain of pipelines in multiple projects.
|
requests. This starts a chain of pipelines in multiple projects.
|
||||||
|
|
Binary file not shown.
Before Width: | Height: | Size: 63 KiB |
Binary file not shown.
Before Width: | Height: | Size: 133 KiB |
|
@ -8,38 +8,33 @@ Review Apps are automatically deployed by each pipeline, both in
|
||||||
|
|
||||||
### CI/CD architecture diagram
|
### CI/CD architecture diagram
|
||||||
|
|
||||||
![Review Apps CI/CD architecture](img/review_apps_cicd_architecture.png)
|
```mermaid
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Show mermaid source</summary>
|
|
||||||
<pre>
|
|
||||||
graph TD
|
graph TD
|
||||||
build-qa-image -.->|once the `prepare` stage is done| gitlab:assets:compile
|
build-qa-image -.->|once the `prepare` stage is done| gitlab:assets:compile
|
||||||
review-build-cng -->|triggers a CNG-mirror pipeline and wait for it to be done| CNG-mirror
|
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
|
review-build-cng -.->|once the `test` stage is done| review-deploy
|
||||||
review-deploy -.->|once the `review` stage is done| review-qa-smoke
|
review-deploy -.->|once the `review` stage is done| review-qa-smoke
|
||||||
|
|
||||||
subgraph 1. gitlab-ce/ee `prepare` stage
|
subgraph "1. gitlab-ce/ee `prepare` stage"
|
||||||
build-qa-image
|
build-qa-image
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph 2. gitlab-ce/ee `test` stage
|
subgraph "2. gitlab-ce/ee `test` stage"
|
||||||
gitlab:assets:compile -->|plays dependent job once done| review-build-cng
|
gitlab:assets:compile -->|plays dependent job once done| review-build-cng
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph 3. gitlab-ce/ee `review` stage
|
subgraph "3. gitlab-ce/ee `review` stage"
|
||||||
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."]
|
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
|
end
|
||||||
|
|
||||||
subgraph 4. gitlab-ce/ee `qa` stage
|
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.]
|
review-qa-smoke[review-qa-smoke<br><br>gitlab-qa runs the smoke suite against the Review App.]
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph CNG-mirror pipeline
|
subgraph "CNG-mirror pipeline"
|
||||||
CNG-mirror>Cloud Native images are built];
|
CNG-mirror>Cloud Native images are built];
|
||||||
end
|
end
|
||||||
</pre>
|
```
|
||||||
</details>
|
|
||||||
|
|
||||||
### Detailed explanation
|
### Detailed explanation
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue