chore: Update README.md template

KubeRocketCI · Dec 24, 2024 · 8dac84a · 8dac84a
1 parent 4bd0533
commit 8dac84a
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,8 @@
   - [Introduction](#introduction)
   - [Project Structure](#project-structure)
   - [Getting Started](#getting-started)
-    - [Deploy with helm chart](#deploy-with-helm-chart)
+    - [Deploy with Helm](#deploy-with-helm)
+    - [Deploy with cluster add-ons](#deploy-with-cluster-add-ons)
   - [Usage](#usage)
     - [Using the ApprovalTask in a Tekton Pipeline](#using-the-approvaltask-in-a-tekton-pipeline)
       - [Define the Pipeline](#define-the-pipeline)
@@ -46,7 +47,7 @@ To get started with Tekton Custom Task, ensure you have Kubernetes and Tekton Pi
    kubectl apply -f config/crd/bases/
    ```
 
-### Deploy with helm chart
+### Deploy with Helm
 
 1. To add the Helm EPAMEDP Charts for local client, run "helm repo add":
 
@@ -62,18 +63,34 @@ To get started with Tekton Custom Task, ensure you have Kubernetes and Tekton Pi
     epamedp/tekton-custom-task      0.1.0          0.1.0          A Helm chart for Tekton Custom Tasks
     ```
 
-  _**NOTE:** It is highly recommended to use the latest released version._
+    _**NOTE:** It is highly recommended to use the latest released version._
 
 3. Full chart parameters available in [deploy-templates/README.md](deploy-templates/README.md).
 
 4. Install operator with the following command:
 
-  ```bash
-  helm install tekton-custom-task epamedp/tekton-custom-task --version <chart_version>
-  ```
+    ```bash
+    helm install tekton-custom-task epamedp/tekton-custom-task --version <chart_version>
+    ```
 
 5. Check the namespace that should contain CustomTask controller in a running status.
 
+### Deploy with cluster add-ons
+
+1. Navigate to the forked [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons) repository.
+
+2. Enable the deployment of the Tekton Custom Task Helm chart by setting the `tekton-custom-task.enable` and `tekton-custom-task.createNamespace` values to `true` in the `clusters/core/apps/values.yaml` file.
+
+    ```yaml title="clusters/core/apps/values.yaml"
+    tekton-custom-task:
+      createNamespace: true
+      enable: true
+    ```
+
+3. Update the `clusters/core/addons/tekton-custom-task/values.yaml` file with the desired configuration for the Tekton Custom Task Helm chart.
+
+4. After updating the `values.yaml` file, commit the changes to the repository and apply the changes with Helm or Argo CD.
+
 ## Usage
 
 This set of instructions guides you through the process of creating a custom `ApprovalTask` and incorporating it into a Tekton pipeline to serve as an approval step.

diff --git a/deploy-templates/README.md b/deploy-templates/README.md
@@ -32,7 +32,7 @@ To get started with Tekton Custom Task, ensure you have Kubernetes and Tekton Pi
    kubectl apply -f config/crd/bases/
    ```
 
-### Deploy with helm chart
+### Deploy with Helm
 
 1. To add the Helm EPAMEDP Charts for local client, run "helm repo add":
 
@@ -48,18 +48,34 @@ To get started with Tekton Custom Task, ensure you have Kubernetes and Tekton Pi
     epamedp/tekton-custom-task      0.1.0          0.1.0          A Helm chart for Tekton Custom Tasks
     ```
 
-  _**NOTE:** It is highly recommended to use the latest released version._
+    _**NOTE:** It is highly recommended to use the latest released version._
 
 3. Full chart parameters available in [deploy-templates/README.md](deploy-templates/README.md).
 
 4. Install operator with the following command:
 
-  ```bash
-  helm install tekton-custom-task epamedp/tekton-custom-task --version <chart_version>
-  ```
+    ```bash
+    helm install tekton-custom-task epamedp/tekton-custom-task --version <chart_version>
+    ```
 
 5. Check the namespace that should contain CustomTask controller in a running status.
 
+### Deploy with cluster add-ons
+
+1. Navigate to the forked [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons) repository.
+
+2. Enable the deployment of the Tekton Custom Task Helm chart by setting the `tekton-custom-task.enable` and `tekton-custom-task.createNamespace` values to `true` in the `clusters/core/apps/values.yaml` file.
+
+    ```yaml title="clusters/core/apps/values.yaml"
+    tekton-custom-task:
+      createNamespace: true
+      enable: true
+    ```
+
+3. Update the `clusters/core/addons/tekton-custom-task/values.yaml` file with the desired configuration for the Tekton Custom Task Helm chart.
+
+4. After updating the `values.yaml` file, commit the changes to the repository and apply the changes with Helm or Argo CD.
+
 ## Usage
 
 This set of instructions guides you through the process of creating a custom `ApprovalTask` and incorporating it into a Tekton pipeline to serve as an approval step.
@@ -159,8 +175,8 @@ This project is licensed under the [Apache License 2.0](LICENSE.txt).
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
 | annotations | object | `{}` |  |
-| image.repository | string | `"KubeRocketCI/tekton-custom-task"` | tekton-custom-task Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/KubeRocketCI/tekton-custom-task) |
-| image.tag | string | `nil` | tekton-custom-task Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/KubeRocketCI/tekton-custom-task) |
+| image.repository | string | `"epamedp/tekton-custom-task"` | tekton-custom-task Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/tekton-custom-task) |
+| image.tag | string | `nil` | tekton-custom-task Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/tekton-custom-task) |
 | imagePullPolicy | string | `"IfNotPresent"` |  |
 | name | string | `"tekton-custom-task"` | component name |
 | nodeSelector | object | `{}` |  |

diff --git a/deploy-templates/README.md.gotmpl b/deploy-templates/README.md.gotmpl
@@ -34,7 +34,7 @@ To get started with Tekton Custom Task, ensure you have Kubernetes and Tekton Pi
    kubectl apply -f config/crd/bases/
    ```
 
-### Deploy with helm chart
+### Deploy with Helm
 
 1. To add the Helm EPAMEDP Charts for local client, run "helm repo add":
 
@@ -50,18 +50,34 @@ To get started with Tekton Custom Task, ensure you have Kubernetes and Tekton Pi
     epamedp/tekton-custom-task      0.1.0          0.1.0          A Helm chart for Tekton Custom Tasks
     ```
 
-  _**NOTE:** It is highly recommended to use the latest released version._
+    _**NOTE:** It is highly recommended to use the latest released version._
 
 3. Full chart parameters available in [deploy-templates/README.md](deploy-templates/README.md).
 
 4. Install operator with the following command:
 
-  ```bash
-  helm install tekton-custom-task epamedp/tekton-custom-task --version <chart_version>
-  ```
+    ```bash
+    helm install tekton-custom-task epamedp/tekton-custom-task --version <chart_version>
+    ```
 
 5. Check the namespace that should contain CustomTask controller in a running status.
 
+### Deploy with cluster add-ons
+
+1. Navigate to the forked [edp-cluster-add-ons](https://github.com/epam/edp-cluster-add-ons) repository.
+
+2. Enable the deployment of the Tekton Custom Task Helm chart by setting the `tekton-custom-task.enable` and `tekton-custom-task.createNamespace` values to `true` in the `clusters/core/apps/values.yaml` file.
+
+    ```yaml title="clusters/core/apps/values.yaml"
+    tekton-custom-task:
+      createNamespace: true
+      enable: true
+    ```
+
+3. Update the `clusters/core/addons/tekton-custom-task/values.yaml` file with the desired configuration for the Tekton Custom Task Helm chart.
+
+4. After updating the `values.yaml` file, commit the changes to the repository and apply the changes with Helm or Argo CD.
+
 ## Usage
 
 This set of instructions guides you through the process of creating a custom `ApprovalTask` and incorporating it into a Tekton pipeline to serve as an approval step.

diff --git a/deploy-templates/values.yaml b/deploy-templates/values.yaml
@@ -5,10 +5,10 @@ nodeSelector: {}
 tolerations: []
 affinity: {}
 image:
-   # -- tekton-custom-task Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/KubeRocketCI/tekton-custom-task)
-  repository: KubeRocketCI/tekton-custom-task
+   # -- tekton-custom-task Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/tekton-custom-task)
+  repository: epamedp/tekton-custom-task
   # if not defined then .Chart.AppVersion is used
-  # -- tekton-custom-task Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/KubeRocketCI/tekton-custom-task)
+  # -- tekton-custom-task Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/tekton-custom-task)
   tag:
 imagePullPolicy: "IfNotPresent"