README updates related to git-sync for ndc-postgres, ndc-connector-oracle & ndc-mongodb

Author: tomhasura

charts/ndc-connector-oracle/README.md

@@ -30,7 +30,9 @@ helm upgrade --install <release-name> \
 
 Follow the pre-requisite [here](../../README.md#using-git-for-metadata-files) which has to be done once and deployed on the cluster.
 
-Replace `org`, `repo` placeholders in the below command to suit your git repository.  Additionally, ensure that `connectorEnvVars.configDirectory` is set to the given path below, providing that you are also replacing `repo` and `connector-name` placeholders within it.  For clarity, `connector-name` is the name that was give to your connector (ie. Check `app/connector` under your Supergraph).
+Replace `git_domain`, `org` and `repo` placeholders in the below command to suit your git repository.  Additionally, ensure that `connectorEnvVars.configDirectory` is set to the given path below, providing that you are also replacing `repo` and `connector-name` placeholders within it.  For clarity, `connector-name` is the name that was give to your connector (ie. Check `app/connector` under your Supergraph).
+
+Note: For `https` based checkout, a typical URL format for `initContainers.gitSync.repo` will be `https://<git_domain>/<org>/<repo>`.  For `ssh` based checkout, a typical URL format will be `git@<git_domain>:<org>/<repo>`
 
 ```bash
 helm upgrade --install <release-name> \
@@ -39,7 +41,7 @@ helm upgrade --install <release-name> \
   --set image.tag="my_custom_image_tag" \
   --set connectorEnvVars.JDBC_URL="jdbc_url" \
   --set initContainers.gitSync.enabled="true" \
-  --set initContainers.gitSync.repo="git@github.com:<org>/<repo>" \
+  --set initContainers.gitSync.repo="git@<git_domain>:<org>/<repo>" \
   --set initContainers.gitSync.branch="main" \
   --set connectorEnvVars.configDirectory="/work-dir/<repo>/app/connector/<connector-name>" \
   hasura-ddn/ndc-connector-oracle

charts/ndc-mongodb/README.md

@@ -26,11 +26,13 @@ helm upgrade --install <release-name> \
   hasura-ddn/ndc-mongodb
 ```
 
-## Enabling git-sync
+## Deployment option via git-sync
 
 Follow the pre-requisite [here](../../README.md#using-git-for-metadata-files) which has to be done once and deployed on the cluster.
 
-Replace `org`, `repo` placeholders in the below command to suit your git repository.  Additionally, ensure that `connectorEnvVars.configDirectory` is set to the given path below, providing that you are also replacing `repo` and `connector-name` placeholders within it.  For clarity, `connector-name` is the name that was give to your connector (ie. Check `app/connector` under your Supergraph).
+Replace `git_domain`, `org` and `repo` placeholders in the below command to suit your git repository.  Additionally, ensure that `connectorEnvVars.configDirectory` is set to the given path below, providing that you are also replacing `repo` and `connector-name` placeholders within it.  For clarity, `connector-name` is the name that was give to your connector (ie. Check `app/connector` under your Supergraph).
+
+Note: For `https` based checkout, a typical URL format for `initContainers.gitSync.repo` will be `https://<git_domain>/<org>/<repo>`.  For `ssh` based checkout, a typical URL format will be `git@<git_domain>:<org>/<repo>`
 
 ```bash
 helm upgrade --install <release-name> \
@@ -39,7 +41,7 @@ helm upgrade --install <release-name> \
   --set image.tag="my_custom_image_tag" \
   --set connectorEnvVars.MONGODB_DATABASE_URI="db_connection_string" \
   --set initContainers.gitSync.enabled="true" \
-  --set initContainers.gitSync.repo="git@github.com:<org>/<repo>" \
+  --set initContainers.gitSync.repo="git@<git_domain>:<org>/<repo>" \
   --set initContainers.gitSync.branch="main" \
   --set connectorEnvVars.configDirectory="/work-dir/<repo>/app/connector/<connector-name>" \
   hasura-ddn/ndc-mongodb

charts/ndc-postgres/README.md

@@ -30,7 +30,9 @@ helm upgrade --install <release-name> \
 
 Follow the pre-requisite [here](../../README.md#using-git-for-metadata-files) which has to be done once and deployed on the cluster.
 
-Replace `org`, `repo` placeholders in the below command to suit your git repository.  Additionally, ensure that `connectorEnvVars.configDirectory` is set to the given path below, providing that you are also replacing `repo` and `connector-name` placeholders within it.  For clarity, `connector-name` is the name that was give to your connector (ie. Check `app/connector` under your Supergraph).
+Replace `git_domain`, `org` and `repo` placeholders in the below command to suit your git repository.  Additionally, ensure that `connectorEnvVars.configDirectory` is set to the given path below, providing that you are also replacing `repo` and `connector-name` placeholders within it.  For clarity, `connector-name` is the name that was give to your connector (ie. Check `app/connector` under your Supergraph).
+
+Note: For `https` based checkout, a typical URL format for `initContainers.gitSync.repo` will be `https://<git_domain>/<org>/<repo>`.  For `ssh` based checkout, a typical URL format will be `git@<git_domain>:<org>/<repo>`
 
 ```bash
 helm upgrade --install <release-name> \
@@ -39,7 +41,7 @@ helm upgrade --install <release-name> \
   --set image.tag="my_custom_image_tag" \
   --set connectorEnvVars.CONNECTION_URI="db_connection_string" \
   --set initContainers.gitSync.enabled="true" \
-  --set initContainers.gitSync.repo="git@github.com:<org>/<repo>" \
+  --set initContainers.gitSync.repo="git@<git_domain>:<org>/<repo>" \
   --set initContainers.gitSync.branch="main" \
   --set connectorEnvVars.configDirectory="/work-dir/<repo>/app/connector/<connector-name>" \
   hasura-ddn/ndc-postgres