improve helm chart docs and the connector examples

README.md

@@ -9,6 +9,7 @@ Please refer to the [official documentation](https://helm.sh/docs/intro/install/
 
 ```bash
 helm repo add hasura https://hasura.github.io/helm-charts/
+helm repo update
 ```
 
 You can then see the charts by running:
@@ -17,6 +18,8 @@ You can then see the charts by running:
 helm search repo hasura
 ```
 
+> You can change the repo name `hasura` to another one if getting conflicts.
+
 For more information, have a look at the [Using Helm](https://helm.sh/docs/intro/using_helm/#helm-repo-working-with-repositories) documentation.
 
 ## Contributing

charts/graphql-data-connector/README.md

@@ -9,8 +9,20 @@ This chart deploys the GraphQL Data Connector service.
 
 ```bash
 helm repo add hasura https://hasura.github.io/helm-charts
+helm repo update
 ```
 
+> You can change the repo name `hasura` to another one if getting conflicts.
+
+## Get Started
+
+```bash
+helm install [RELEASE_NAME] hasura/graphql-data-connector
+```
+See [configuration](#parameters) below.
+
+See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation.
+
 ## Parameters 
 
 | Name                                              | Description                                                                                                | Value                           |

charts/graphql-data-connector/values.yaml

@@ -183,9 +183,9 @@ autoscaling:
 ## Resource requests and limits of deployment pods
 ## ref: https://kubernetes.io/docs/user-guide/compute-resources/
 ## Example:
-## requests:
-##   cpu: 250m
-##   memory: 256Mi
+## limits:
+##   memory: "2Gi"
+##   cpu: "1"
 ##
 resources: {}
 

charts/graphql-engine/README.md

@@ -10,8 +10,11 @@ This chart deploys the GraphQL Engine service with a Postgres instance for metad
 
 ```bash
 helm repo add hasura https://hasura.github.io/helm-charts
+helm repo update
 ```
 
+> You can change the repo name `hasura` to another one if getting conflicts.
+
 ## Get Started
 
 ### Install Helm Chart

charts/graphql-engine/values.yaml

@@ -197,9 +197,9 @@ autoscaling:
 ## Resource requests and limits of deployment pods
 ## ref: https://kubernetes.io/docs/user-guide/compute-resources/
 ## Example:
-## requests:
-##   cpu: 250m
-##   memory: 256Mi
+## limits:
+##   memory: "4Gi"
+##   cpu: "2"
 ##
 resources: {}
 

charts/hasura-enterprise-stack/README.md

@@ -20,8 +20,11 @@ Components included in this package:
 
 ```bash
 helm repo add hasura https://hasura.github.io/helm-charts
+helm repo update
 ```
 
+> You can change the repo name `hasura` to another one if getting conflicts.
+
 > The Bitnami repository has been moved to OCI-based registries that are GA supported in by Helm since v3.8.0. If you use the helm chart prior to v3.8.0, you need to enable the [experiment environment](https://helm.sh/docs/topics/registries/#oci-support-prior-to-v380).  
 
 ## Get Started

charts/hasura-enterprise-stack/examples/05-data-connector.yaml

@@ -16,3 +16,33 @@ graphql-engine:
   secret:
     adminSecret: "hasura"
     eeLicenseKey: "<license-key>"
+
+  ## Enable graphql-data-connector and mongo-data-connector health checks 
+  ## if you enable graphql-data-connector and face the race condition issue
+  ## because connector pods start up longer than graphql-engine. to Do not uncomment the health check container if you don't use the connector or graphql-engine pods are failed to start. 
+  ##
+  ## Note: change the <connector> to the data source that graphql-engine will connect
+  ## Accepted values: athena, mariadb, mysql, oracle, snowflake
+  ##
+  # initContainers:
+  #   - name: wait-for-graphql-data-connector
+  #     image: atkrad/wait4x:2
+  #     args:
+  #       - http
+  #       - http://{{ .Release.Name }}-graphql-data-connector:8081/api/v1/<connector>/health
+  #       - --expect-status-code
+  #       - "200"
+  #       - --timeout
+  #       - 300s
+  #     imagePullPolicy: IfNotPresent
+  # 
+  #   - name: wait-for-mongo-data-connector
+  #     image: atkrad/wait4x:2
+  #     args:
+  #       - http
+  #       - http://{{ .Release.Name }}-mongo-data-connector:8081/health
+  #       - --expect-status-code
+  #       - "200"
+  #       - --timeout
+  #       - 300s
+  #     imagePullPolicy: IfNotPresent

charts/mongo-data-connector/README.md

@@ -9,8 +9,20 @@ This chart deploys the GraphQL Data Connector service.
 
 ```bash
 helm repo add hasura https://hasura.github.io/helm-charts
+helm repo update
 ```
 
+> You can change the repo name `hasura` to another one if getting conflicts.
+
+## Get Started
+
+```bash
+helm install [RELEASE_NAME] hasura/mongo-data-connector
+```
+See [configuration](#parameters) below.
+
+See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation.
+
 ## Parameters 
 
 | Name                                              | Description                                                                                     | Value                         |

charts/mongo-data-connector/values.yaml

@@ -182,9 +182,9 @@ autoscaling:
 ## Resource requests and limits of deployment pods
 ## ref: https://kubernetes.io/docs/user-guide/compute-resources/
 ## Example:
-## requests:
-##   cpu: 250m
-##   memory: 256Mi
+## limits:
+##   memory: "2Gi"
+##   cpu: "1"
 ##
 resources: {}
 

charts/postgres/README.md

@@ -11,8 +11,20 @@ This chart deploys a PostgreSQL instance for metadata storage.
 
 ```bash
 helm repo add hasura https://hasura.github.io/helm-charts
+helm repo update
 ```
 
+> You can change the repo name `hasura` to another one if getting conflicts.
+
+## Get Started
+
+```bash
+helm install [RELEASE_NAME] hasura/postgres
+```
+See [configuration](#parameters) below.
+
+See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation.
+
 ## Parameters 
 
 ### Global parameters

charts/postgres/values.yaml

@@ -162,9 +162,9 @@ extraVolumeMounts: []
 ## Resource requests and limits of deployment pods
 ## ref: https://kubernetes.io/docs/user-guide/compute-resources/
 ## Example
-## requests:
-##   cpu: 250m
-##   memory: 256Mi
+## limits:
+##   memory: "4Gi"
+##   cpu: "2"
 ##
 resources: {}