[EPMDEDP-10274]: docs: Align README.md

Change-Id: I960e26f109b3135eb80de79a64f419920362f23f
epam · Aug 17, 2022 · 7c6a3a3 · 7c6a3a3
1 parent ed1beeb
commit 7c6a3a3
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -26,15 +26,17 @@ In order to install the EDP Sonar Operator, follow the steps below:
 1. To add the Helm EPAMEDP Charts for local client, run "helm repo add":
 
      ```bash
-     helm repo add epamedp https://chartmuseum.demo.edp-epam.com/
+     helm repo add epamedp https://epam.github.io/edp-helm-charts/stable
      ```
 
 2. Choose available Helm chart version:
 
      ```bash
-     helm search repo epamedp/sonar-operator
+     helm search repo epamedp/sonar-operator -l
      NAME                    CHART VERSION   APP VERSION     DESCRIPTION
-     epamedp/sonar-operator  v2.10.0                          Helm chart for Golang application/service deplo...
+     epamedp/sonar-operator  2.11.0          2.11.0          A Helm chart for EDP Sonar Operator
+     epamedp/sonar-operator  2.10.2          2.10.2          A Helm chart for EDP Sonar Operator
+     epamedp/sonar-operator  2.10.0          2.10.0          A Helm chart for EDP Sonar Operator
      ```
 
     _**NOTE:** It is highly recommended to use the latest released version._
@@ -43,17 +45,19 @@ In order to install the EDP Sonar Operator, follow the steps below:
 
     Full available chart parameters available in [deploy-templates/README.md](deploy-templates/README.md):
 
-4. Install operator in the <edp_cicd_project> namespace with the helm command; find below the installation command example:
+4. Install operator in the <edp-project> namespace with the helm command; find below the installation command example:
 
     ```bash
-    helm install sonar-operator epamedp/sonar-operator --version <chart_version> --namespace <edp_cicd_project> --set name=sonar-operator --set global.edpName=<edp_cicd_project> --set global.platform=<platform_type> --set global.dnsWildCard=<cluster_DNS_wildcard>
+    helm install sonar-operator epamedp/sonar-operator --version <chart_version> --namespace <edp-project> --set name=sonar-operator --set global.edpName=<edp-project> --set global.platform=<platform_type> --set global.dnsWildCard=<cluster_DNS_wildcard>
     ```
 
-5. Check the <edp_cicd_project> namespace that should contain operator deployment with your operator in a running status.
+5. Check the <edp-project> namespace that should contain operator deployment with your operator in a running status.
 
 ## Local Development
 
-In order to develop the operator, first set up a local environment. For details, please refer to the [Developer Guide](https://epam.github.io/edp-install/developer-guide/local-development/) page.
+In order to develop the operator, first set up a local environment. For details, please refer to the [Local Development](https://epam.github.io/edp-install/developer-guide/local-development/) page.
+
+Development versions are also available, please refer to the [snapshot helm chart repository](https://epam.github.io/edp-helm-charts/snapshot/) page.
 
 ### Related Articles
 

diff --git a/deploy-templates/README.md b/deploy-templates/README.md
@@ -23,57 +23,51 @@ A Helm chart for EDP Sonar Operator
 |-----|------|---------|-------------|
 | affinity | object | `{}` |  |
 | annotations | object | `{}` |  |
-| global.dnsWildCard | string | `"example.com"` |  |
-| global.edpName | string | `""` |  |
-| global.openshift.deploymentType | string | `"deployments"` |  |
-| global.platform | string | `"openshift"` |  |
-| image.repository | string | `"epamedp/sonar-operator"` |  |
-| image.tag | string | `nil` |  |
+| global.dnsWildCard | string | `nil` | a cluster DNS wildcard name |
+| global.edpName | string | `""` | namespace or a project name (in case of OpenShift) |
+| global.openshift.deploymentType | string | `"deployments"` | Wich type of kind will be deployed to Openshift (values: deployments/deploymentConfigs) |
+| global.platform | string | `"openshift"` | platform type that can be "kubernetes" or "openshift" |
+| image.repository | string | `"epamedp/sonar-operator"` | EDP sonar-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator) |
+| image.tag | string | `nil` | EDP sonar-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator/tags) |
 | imagePullPolicy | string | `"IfNotPresent"` |  |
-| name | string | `"sonar-operator"` |  |
+| name | string | `"sonar-operator"` | component name |
 | nodeSelector | object | `{}` |  |
 | resources.limits.memory | string | `"192Mi"` |  |
 | resources.requests.cpu | string | `"50m"` |  |
 | resources.requests.memory | string | `"64Mi"` |  |
 | sonar.affinity | object | `{}` |  |
 | sonar.annotations | object | `{}` |  |
-| sonar.basePath | string | `""` |  |
+| sonar.basePath | string | `""` | Base path for Sonar URL |
 | sonar.db.affinity | object | `{}` |  |
 | sonar.db.annotations | object | `{}` |  |
-| sonar.db.image | string | `"postgres:9.6"` |  |
+| sonar.db.image | string | `"postgres:9.6"` | Database image name |
 | sonar.db.imagePullPolicy | string | `"IfNotPresent"` |  |
 | sonar.db.nodeSelector | object | `{}` |  |
 | sonar.db.resources.limits.memory | string | `"512Mi"` |  |
 | sonar.db.resources.requests.cpu | string | `"50m"` |  |
 | sonar.db.resources.requests.memory | string | `"64Mi"` |  |
 | sonar.db.tolerations | list | `[]` |  |
-| sonar.deploy | bool | `true` |  |
-| sonar.image | string | `"sonarqube"` |  |
+| sonar.deploy | bool | `true` | Flag to enable/disable Sonar deploy |
+| sonar.image | string | `"sonarqube"` | Define sonar docker image name |
 | sonar.imagePullPolicy | string | `"IfNotPresent"` |  |
-| sonar.imagePullSecrets | string | `nil` |  |
+| sonar.imagePullSecrets | string | `nil` | Secrets to pull from private Docker registry |
 | sonar.ingress.annotations | object | `{}` |  |
-| sonar.ingress.pathType | string | `"Prefix"` |  |
-| sonar.ingress.tls | list | `[]` |  |
+| sonar.ingress.pathType | string | `"Prefix"` | pathType is only for k8s >= 1.1= |
+| sonar.ingress.tls | list | `[]` | See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress ingressClassName: nginx |
 | sonar.initContainers.resources | object | `{}` |  |
 | sonar.initImage | string | `"busybox:1.35.0"` |  |
-| sonar.name | string | `"sonar"` |  |
+| sonar.name | string | `"sonar"` | Sonar name |
 | sonar.nodeSelector | object | `{}` |  |
-| sonar.plugins.install[0] | string | `"https://github.com/vaulttec/sonar-auth-oidc/releases/download/v2.0.0/sonar-auth-oidc-plugin-2.0.0.jar"` |  |
-| sonar.plugins.install[1] | string | `"https://github.com/checkstyle/sonar-checkstyle/releases/download/9.0.1/checkstyle-sonar-plugin-9.0.1.jar"` |  |
-| sonar.plugins.install[2] | string | `"https://github.com/spotbugs/sonar-findbugs/releases/download/4.0.4/sonar-findbugs-plugin-4.0.4.jar"` |  |
-| sonar.plugins.install[3] | string | `"https://github.com/jborgers/sonar-pmd/releases/download/3.3.1/sonar-pmd-plugin-3.3.1.jar"` |  |
-| sonar.plugins.install[4] | string | `"https://github.com/sbaudoin/sonar-ansible/releases/download/v2.4.0/sonar-ansible-plugin-2.4.0.jar"` |  |
-| sonar.plugins.install[5] | string | `"https://github.com/sbaudoin/sonar-yaml/releases/download/v1.6.0/sonar-yaml-plugin-1.6.0.jar"` |  |
-| sonar.plugins.install[6] | string | `"https://github.com/Inform-Software/sonar-groovy/releases/download/1.8/sonar-groovy-plugin-1.8.jar"` |  |
+| sonar.plugins | object | `{"install":["https://github.com/vaulttec/sonar-auth-oidc/releases/download/v2.0.0/sonar-auth-oidc-plugin-2.0.0.jar","https://github.com/checkstyle/sonar-checkstyle/releases/download/9.0.1/checkstyle-sonar-plugin-9.0.1.jar","https://github.com/spotbugs/sonar-findbugs/releases/download/4.0.4/sonar-findbugs-plugin-4.0.4.jar","https://github.com/jborgers/sonar-pmd/releases/download/3.3.1/sonar-pmd-plugin-3.3.1.jar","https://github.com/sbaudoin/sonar-ansible/releases/download/v2.4.0/sonar-ansible-plugin-2.4.0.jar","https://github.com/sbaudoin/sonar-yaml/releases/download/v1.6.0/sonar-yaml-plugin-1.6.0.jar","https://github.com/Inform-Software/sonar-groovy/releases/download/1.8/sonar-groovy-plugin-1.8.jar"]}` | List of plugins to install. For example: |
 | sonar.resources.limits.memory | string | `"3Gi"` |  |
 | sonar.resources.requests.cpu | string | `"100m"` |  |
 | sonar.resources.requests.memory | string | `"1.5Gi"` |  |
 | sonar.sonarqubeFolder | string | `"/opt/sonarqube"` |  |
-| sonar.storage.data.class | string | `"gp2"` |  |
-| sonar.storage.data.size | string | `"1Gi"` |  |
-| sonar.storage.database.class | string | `"gp2"` |  |
-| sonar.storage.database.size | string | `"1Gi"` |  |
+| sonar.storage.data.class | string | `"gp2"` | Storageclass for Sonar data volume |
+| sonar.storage.data.size | string | `"1Gi"` | Size for Sonar data volume |
+| sonar.storage.database.class | string | `"gp2"` | Storageclass for database data volume |
+| sonar.storage.database.size | string | `"1Gi"` | Size for database data volume |
 | sonar.tolerations | list | `[]` |  |
-| sonar.version | string | `"8.9.8-community"` |  |
+| sonar.version | string | `"8.9.8-community"` | Define sonar docker image tag |
 | tolerations | list | `[]` |  |
 
diff --git a/deploy-templates/values.yaml b/deploy-templates/values.yaml
@@ -1,18 +1,25 @@
 global:
+  # -- namespace or a project name (in case of OpenShift)
   edpName: ""
+  # -- platform type that can be "kubernetes" or "openshift"
   platform: "openshift"
-  dnsWildCard: "example.com"
+  # -- a cluster DNS wildcard name
+  dnsWildCard:
   openshift:
+    # -- Wich type of kind will be deployed to Openshift (values: deployments/deploymentConfigs)
     deploymentType: "deployments"
 
+# -- component name
 name: sonar-operator
 annotations: {}
 nodeSelector: {}
 tolerations: []
 affinity: {}
 image:
+  # -- EDP sonar-operator Docker image name. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator)
   repository: epamedp/sonar-operator
   # if not defined then .Chart.AppVersion is used
+  # -- EDP sonar-operator Docker image tag. The released image can be found on [Dockerhub](https://hub.docker.com/r/epamedp/sonar-operator/tags)
   tag:
 imagePullPolicy: "IfNotPresent"
 
@@ -32,38 +39,48 @@ sonar:
     # We allow the init containers to have a separate resources declaration because
     # the initContainer does not take as much resources.
     resources: {}
+  # --  Flag to enable/disable Sonar deploy
   deploy: true
+  # --  Sonar name
   name: "sonar"
+  # -- Define sonar docker image name
   image: "sonarqube"
+  # -- Define sonar docker image tag
   version: "8.9.8-community"
   imagePullPolicy: "IfNotPresent"
   initImage: "busybox:1.35.0"
+  # --  Base path for Sonar URL
   basePath: ""
+  # --  Secrets to pull from private Docker registry
   imagePullSecrets:
   storage:
     data:
+      # --  Storageclass for Sonar data volume
       class: gp2
+      # --  Size for Sonar data volume
       size: 1Gi
     database:
+      # --  Storageclass for database data volume
       class: gp2
+      # --  Size for database data volume
       size: 1Gi
   annotations: {}
   nodeSelector: {}
   tolerations: []
   affinity: {}
   ingress:
     annotations: {}
-    # pathType is only for k8s >= 1.1=
+    # -- pathType is only for k8s >= 1.1=
     pathType: Prefix
-    # For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName
-    # See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress
+    # -- For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName
+    # -- See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress
     # ingressClassName: nginx
     tls: []
     #  - secretName: chart-example-tls
     #    hosts:
     #      - chart-example.local
   sonarqubeFolder: /opt/sonarqube
-  # List of plugins to install.
+  # -- List of plugins to install.
   # For example:
   plugins:
     install:
@@ -83,6 +100,7 @@ sonar:
       memory: 1.5Gi
 
   db:
+    # -- Database image name
     image: "postgres:9.6"
     imagePullPolicy: "IfNotPresent"
     resources: