fix: Updated comments on values.yaml to understand the values better

.env.sample

@@ -1,4 +1,3 @@
-# Sample environment variables for seting up DNS
 PROVIDER=
 NAME=
 PROJECT_ID=

README.md

@@ -140,9 +140,9 @@ kubectl get nodes
 ```
 
 ### 2)Template preparation:
-Fill the values [`Values.yaml`](charts/template/values.yaml)  and [`ConfigMap.yaml`](charts/template/configmap.yaml) inside the charts/template folder. These Template are necessary during provision for one to get features like 0Auth, mail service etc.
+Fill the values [`Values.yaml`](charts/values.yaml)  and [`ConfigMap.yaml`](charts/template/configmap.yaml) inside the charts/template folder. These Template are necessary during provision for one to get features like 0Auth, mail service etc.
 
-Ensure the `.env` file contains necessary key values according to the sample(`.env.sample`). This step is necessary during `DBseed` process for DNS creation.
+Ensure the `.env` file contains necessary key values according to the sample [`.env.sample`](./.env.sample). This step is necessary during `DBseed` process for DNS creation.
 
 ### 3) Bootstrap and run 01Cloud
 
@@ -323,5 +323,7 @@ If your organization uses this environment or contributes improvements, consider
   - Inspect events/logs: kubectl describe pod/<name> -n 01cloud-staging; kubectl logs <name> -n 01cloud-staging
 - Adjust resources:
   - Edit charts/values.yaml PVC and resource requests/limits as needed
+- Self signed cert not getting accepted ( firefox specially)
+  - Refer to this [doc](docs/mkcert-issue.md) for adding CAroot in your browser.
 
 Enjoy building with 01Cloud!

charts/values.yaml

@@ -18,18 +18,21 @@ image:
   exsecret: 01community/01cloud-exsecret:v0.0.1
   logging: 01community/01cloud-exlogger:v0.0.1
 
+## This secret are stored in the env-sec which will be using in the microservices (e.g. api, controllers)
 secret:
-  API_SECRET: --- YOUR-API-SECRET ---
-  DB_PASSWORD: --- YOUR-DB-PASSWORD ---
-  SMTP_PASSWORD: --- YOUR-SMTP-PASSWORD ---
-  DB_URL: --- YOUR-DB-URL ---
-  MONGO_URL: --- YOUR-MONGO-URL ---
-  RABBITMQ_URL: --- YOUR-RABBITMQ-URL ---
-  MONGODB_PASSWORD: --- YOUR-MONGO-PASSWORD ---
-  RABBITMQ_PASSWORD: --- YOUR-RABBITMQ-PASSWORD ---
+  API_SECRET: --- YOUR-API-SECRET ---                   # Generate a strong random string
+  DB_PASSWORD: --- YOUR-DB-PASSWORD ---                 # PSQL DB Password (for helm chart)
+  SMTP_PASSWORD: --- YOUR-SMTP-PASSWORD ---             # SMTP password ( SendGrid API Key or SMTP password)
+  DB_URL: --- YOUR-DB-URL ---                           # Database connection URL for microservices
+  MONGO_URL: --- YOUR-MONGO-URL ---                     # MongoDB connection URL for microservices
+  RABBITMQ_URL: --- YOUR-RABBITMQ-URL ---               # RabbitMQ connection URL for microservices
+  MONGODB_PASSWORD: --- YOUR-MONGO-PASSWORD ---         # MongoDB Password (for helm chart)
+  RABBITMQ_PASSWORD: --- YOUR-RABBITMQ-PASSWORD ---     # RabbitMQ Password (for helm chart)
+  MODE: bGVnYWN5
+
+  # Base64 encoded TLS certs for Ingress TLS termination( can use mkcert to generate self-signed certs for testing)
   TLS_CRT:  --- YOUR-TLS ---
   TLS_KEY:  --- YOUR-KEY ---
-  MODE: bGVnYWN5
 
 
 env:
@@ -43,11 +46,8 @@ env:
   paymentFailedUiUrl: https://console.staging.01cloud.dev/payment/failure
   terminalUrl: https://terminal.staging.01cloud.dev
   PROMETHEUS_API_URL: http://prometheus-operated.monitoring.svc.cluster.local:9090
-  REACT_APP_AUTH0_MODE: "legacy"
-  REACT_APP_AUTH0_DOMAIN: " "
-  REACT_APP_AUTH0_CLIENT_ID: " "
-  REACT_APP_AUTH0_AUDIENCE: " "
 
+# Ingress Domain
 
   API_SERVER_WS: ws://cloud-api.01cloud-staging.svc:8081
   GRPC_NOTIFICATION_SERVER: cloud-notifications:10081
@@ -58,34 +58,45 @@ env:
   paymentServerUrl: http://cloud-payments:8080
   helmcdServerUrl: http://cloud-helm-cd:8080
 
+### Your SMTP settings here
+
   SMTP_FROM_ADDRESS: --- YOUR-EMAIL-ADDRESS ---
   SMTP_HOST: --- YOUR-SMTP-HOST ---
   SMTP_PORT: --- YOUR-SMTP-PORT ---
-  SMTP_USERNAME: apikey
+  SMTP_USERNAME: --- YOUR-SMTP-USERNAME ---
+  SMTP_USERNAME: --- YOUR-SMTP-USERNAME ---
+
+### DB_services.yaml, Change according to your preference
   DB_DRIVER: postgres
   DB_HOST: staging-postgres-postgresql
   DB_NAME: cloud
   DB_PORT: "5432"
   DB_USER: berrybytes
   DB_BACKUP_PATH: /data/db-backup
+  adminEmail: --- YOUR-ADMIN-MAIL-FOR-01CLOUD ---
+
   MONGO_DB: cloud
   mongoUser: berrybytes
   rabbitmqUser: berrybytes
   STORE_TYPE: mongo
   MESSAGE_TYPE: rabbitmq
-  GCLOUD_NAMESPACE: --- YOUR-GCLOUD-NAMESPACE (OPTIONAL) ---
-  GCLOUD_PROJECT: --- YOUR-GCLOUD-PROJECT (OPTIONAL) ---
-  GOOGLE_APPLICATION_CREDENTIALS: /data/gcloud.json
+
+## Payment
+  invoicePath: /data/invoices
+
+##  Recaptcha
+  RECAPTCHA_SECRET: --- YOUR-RECAPTCHA-SECRET ---
+
+## Change these values according to your preference( used in cname creation for running application)
+  GCLOUD_NAMESPACE: staging             #default
+  GCLOUD_PROJECT: 01cloud-staging       #default
 
   TLS: zerone-tls-cert
   dockerPluginId: "3"
   TEKTON_FILE_PATH: data.sample
   TEKTON_FILE_PATH_v1: data.sample/v1
   VCLUSTER_API_URL: https://zerone-4409-9534.01cloud.com/v1
   ZERONE_API_URL: https://api.staging.01cloud.dev
-  invoicePath: /data/invoices
-  adminEmail: --- YOUR-ADMIN-EMAIL ---
-  RECAPTCHA_SECRET: --- YOUR-RECAPTCHA-SECRET ---
   storageAccessKey: --- YOUR-STORAGE-ACCESS-KEY ---
   storageSecretKey: --- YOUR-STORAGE-SECRET-KEY ---
 

docs/mkcert-issue.md

@@ -0,0 +1,10 @@
+### Adding mkcert CAroot for snapd firefox
+After running `mkcert -install` you may (not very often) encounter issue regarding refused connection to your host. This is due to firefox being installed as a snap package. To bypass this  create a `ceretificates` folder inside `/var/lib/snapd/deskto/`  and copy the `CAroot` file inside the `certificates` folder.
+```bash
+# create folder if not present
+sudo mkdir -p /var/lib/snapd/desktop/certificates/
+
+# copy the CAroot file
+sudo cp "$(mkcert -CAROOT)/rootCA.pem" /var/lib/snapd/desktop/certificates/
+sudo update-ca-certificates
+```

seeder/package_install.json

@@ -45,13 +45,13 @@
 		"description": "Reloader is a tool to  watch changes in ConfigMap and Secret and do rolling upgrades on Pods with their associated DeploymentConfigs, Deployments, Daemonsets and Statefulsets."
 	},
 	 {
-                "chart": "zerone/secret-patcher",
-                "name": "secret-patcher",
+		"chart": "zerone/secret-patcher",
+		"name": "secret-patcher",
 		"title": "Secret Patcher",
 		"namespace": "zerone-secret-patcher",
-                "optional": true,
-                "icon": "https://console.01cloud.io/meta.jpg",
-                "description": "Secret Patcher patches the  service account with an imagepullsecrets that allows the service account of the pod to pull the  images from container registry"
+		"optional": true,
+		"icon": "https://console.01cloud.io/meta.jpg",
+		"description": "Secret Patcher patches the  service account with an imagepullsecrets that allows the service account of the pod to pull the  images from container registry"
         },
         {
 		"chart": "zerone/velero",
@@ -82,14 +82,14 @@
 	},
 
 	{
-                "chart": "zerone/tekton",
-                "name": "tekton",
-                "title": "Tekton",
-                "namespace": "tekton-pipelines",
-                "optional": true,
-                "icon": "https://avatars.githubusercontent.com/u/47602533?s=280&v=4",
-                "description": "A package to install powerful and flexible kubernetes-native open source CI/CD systems"
-        },
+		"chart": "zerone/tekton",
+		"name": "tekton",
+		"title": "Tekton",
+		"namespace": "tekton-pipelines",
+		"optional": true,
+		"icon": "https://avatars.githubusercontent.com/u/47602533?s=280&v=4",
+		"description": "A package to install powerful and flexible kubernetes-native open source CI/CD systems"
+	},
 
 	{
 		"chart": "zerone/prometheus-operator",
@@ -121,28 +121,28 @@
 		"required_dns": false,
 		"icon": "https://console.01cloud.io/meta.jpg",
 		"description": "The Logging operator manages the log collectors and log forwarders of your logging infrastructure, and the routing rules that specify where you want to send your different log messages."
-		},
-		{
-			"chart": "zerone/flagger",
-			"name": "flagger",
-			"title": "Flagger",
-			"optional": true,
-			"namespace": "zerone-flagger",
-			"required_dns": false,
-			"icon": "https://console.01cloud.io/meta.jpg",
-			"description": "Progressive Delivery operator for Kubernetes (Canary, A/B Testing and Blue/Green deployments)"
-		},
+	},
+	{
+		"chart": "zerone/flagger",
+		"name": "flagger",
+		"title": "Flagger",
+		"optional": true,
+		"namespace": "zerone-flagger",
+		"required_dns": false,
+		"icon": "https://console.01cloud.io/meta.jpg",
+		"description": "Progressive Delivery operator for Kubernetes (Canary, A/B Testing and Blue/Green deployments)"
+	},
 
-		        {
-            "chart": "zerone/openebs",
-            "name": "openebs",
-            "title": "openebs",
-            "optional": true,
-            "namespace": "zerone-openebs",
-            "required_dns": false,
-            "icon": "https://console.01cloud.io/meta.jpg",
-            "description": " OpenEBS turns any storage available to Kubernetes worker nodes into Local or Distributed Kubernetes Persistent Volumes."
-        }],
+			{
+		"chart": "zerone/openebs",
+		"name": "openebs",
+		"title": "openebs",
+		"optional": true,
+		"namespace": "zerone-openebs",
+		"required_dns": false,
+		"icon": "https://console.01cloud.io/meta.jpg",
+		"description": " OpenEBS turns any storage available to Kubernetes worker nodes into Local or Distributed Kubernetes Persistent Volumes."
+	}],
 	"repositories": [{
 		"name": "zerone",
 		"url": "https://berrybytes.github.io/helm-chart-org"