Update docs.

DvDty · Jan 28, 2024 · 381e9a7 · 381e9a7
1 parent 8097043
commit 381e9a7
Show file tree

Hide file tree

Showing 4 changed files with 57 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -12,24 +12,25 @@ Main focus is to provide the development team strong CI:
  - Highly automated
  - Fast
 
-|                                                                                                              | Push to main | Push on other branches | Pull requests |
-|--------------------------------------------------------------------------------------------------------------|--------------|------------------------|---------------|
-| [Gitleaks](https://github.com/DvDty/branch-deploy/blob/main/.github/workflows/main-branch-build.yaml#L8-L26) |       ✅      |            ✅           |       ✅       |
-| [Code linter](https://github.com/DvDty/branch-deploy/blob/main/.github/workflows/main-branch-build.yaml#L28-L64)                                                                                              |              |                        |       ✅       |
-| Build docker image                                                                                           |       ✅      |            ✅           |       ✅       |
-| Push image to Docker Hub                                                                                     |       ✅      |            ✅           |               |
-| Scan image before pushing                                                                                    |       ✅      |                        |       ✅       |
-| Unit tests                                                                                                   |       ✅      |                        |       ✅       |
-| Feature tests                                                                                                |       ✅      |                        |       ✅       |
-| Static code analysis                                                                                         |       ✅      |                        |       ✅       |
-| Sonar Cloud analysis                                                                                         |       ✅      |                        |       ✅       |
-| Database migrations                                                                                          |       ✅      |                        |       ✅       |
-| Check code coverage                                                                                          |       ✅      |                        |       ✅       |
-| Store code coverage report                                                                                   |       ✅      |                        |               |
-| Deploy to minikube                                                                                           |       ✅      |                        |       ✅       |
+|                                                                                                                            | Push to main | Push on other branches | Pull requests |
+|----------------------------------------------------------------------------------------------------------------------------|--------------|------------------------|---------------|
+| [Gitleaks](https://github.com/DvDty/branch-deploy/blob/main/.github/workflows/main-branch-build.yaml#L8-L26)               |       ✅      |            ✅           |       ✅       |
+| [Code linter](https://github.com/DvDty/branch-deploy/blob/main/.github/workflows/main-branch-build.yaml#L28-L64)           |              |                        |       ✅       |
+| Build docker image                                                                                                         |       ✅      |            ✅           |       ✅       |
+| Push image to Docker Hub                                                                                                   |       ✅      |            ✅           |               |
+| Scan image before pushing                                                                                                  |       ✅      |                        |       ✅       |
+| Unit tests                                                                                                                 |       ✅      |                        |       ✅       |
+| Feature tests                                                                                                              |       ✅      |                        |       ✅       |
+| Static code analysis                                                                                                       |       ✅      |                        |       ✅       |
+| Sonar Cloud analysis                                                                                                       |       ✅      |                        |       ✅       |
+| Database migrations                                                                                                        |       ✅      |                        |       ✅       |
+| [Check code coverage](https://github.com/DvDty/branch-deploy/blob/main/.github/workflows/main-branch-build.yaml#L198-L210) |       ✅      |                        |       ✅       |
+| [Store code coverage report](https://github.com/DvDty/branch-deploy/blob/main/.github/workflows/main-branch-build.yaml#L198-L210)                                                                                             |       ✅      |                        |               |
+| Deploy to minikube                                                                                                         |       ✅      |                        |       ✅       |
 
 
 ### Gitleaks
+
 Example with leaked api key:
 
 ![img.png](img.png)
@@ -39,9 +40,42 @@ Notification in slack:
 ![img_1.png](img_1.png)
 
 ### Code linter
+
+![img_3.png](img_3.png)
+
 ![img_2.png](img_2.png)
 
+### Code coverage
+
+![img_4.png](img_4.png)
+
+
+## Control plane
+
+The control plane allow us to easily create instances of our application on demand through a user-friendly interface. The software development life cycle looks like this:
+
+```mermaid
+graph TD;
+    A[New application feature]
+    --> B[Feature branch]
+    B --> |branch-builds.yaml| V
+    B --> |pull-requests.yaml| C[Pull request to main]
+    C --> |main-branch-build.yaml| Z
+    Z[Main branch]
+    Z --> X
+    X(docker_image:main)
+    V(docker_image:branch)
+    K[Docker Hub]
+    V --> K
+    X --> K
+    N[Control Plane]
+    K --> N
+    M[Deployment]
+    L[Deployment]
+    P[Deployment]
+    N --> M
+    N --> L
+    N --> P
+```
 
-![img_3.png](img_3.png)
 
-![img_4.png](img_4.png)
diff --git a/application/k8s/deployment.yaml b/application/k8s/deployment.yaml
@@ -3,7 +3,7 @@ kind: Deployment
 metadata:
   name: branch-deploy-application
 spec:
-  replicas: 2
+  replicas: 1
   selector:
     matchLabels:
       app: branch-deploy-application
@@ -14,7 +14,7 @@ spec:
     spec:
       containers:
         - name: branch-deploy-application
-          image: dvdty/branch-deploy-application:latest
+          image: dvdty/branch-deploy-application:test
           imagePullPolicy: "Always"
           ports:
             - containerPort: 80
diff --git a/master/app/Kubectl.php b/master/app/Kubectl.php
@@ -9,7 +9,9 @@ class Kubectl
 {
     public function getDeployments(): Collection
     {
-        $json = Process::run('kubectl get deployments --output=json')->output();
+        $json = Process::run('kubectl get deployments --output=json')
+            ->throw()
+            ->output();
 
         $json = json_decode($json, true);
 

diff --git a/master/k8s/deployment.yaml b/master/k8s/deployment.yaml
@@ -3,7 +3,7 @@ kind: Deployment
 metadata:
   name: branch-deploy-master
 spec:
-  replicas: 2
+  replicas: 1
   selector:
     matchLabels:
       app: branch-deploy-master