diff --git a/README.md b/README.md index 8f6a559..fe2a962 100644 --- a/README.md +++ b/README.md @@ -10,22 +10,164 @@ https://marketingplatform.google.com/about/tag-manager/ ## Usage -[Helm](https://helm.sh) must be installed to use this Chart. +### Prerequisites -Please refer to Helm's [Documentation](https://helm.sh/docs) to get started. +[Helm](https://helm.sh) must be installed first in order to use this Chart. -Once Helm has been set up correctly, add the repo as follows: +Please refer to Helm [Documentation](https://helm.sh/docs) to get started. + +### Helm Chart Repository + +Once Helm has been set up correctly, add locally the Helm Chart Repository as follows: helm repo add gtm https://jobtome-labs.github.io/google-tag-manager -If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of this Chart. +If you had already added this Repository earlier, run `helm repo update` to retrieve the latest versions of this Chart. You can then run `helm search repo gtm` to see the Chart. +### Install Google Tag Manager Chart + To install the Google Tag Manager Chart: helm install gtm gtm/google-tag-manager -To uninstall the Chart: +### Uninstall Google Tag Manager Chart + +To uninstall the Google Tag Manager Chart: helm delete gtm + +### Helm Tests + +To run Chart Tests: + + helm test gtm + +### Example Values for GKE + +The following Example Helm Values are for a **GKE (Google Kubernetes Engine)** Context. + +In this context, the [GKE Ingress Controller](https://cloud.google.com/kubernetes-engine/docs/concepts/ingress) is being used, along with [Backend/Frontend Configs](https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-configuration). + +```YAML +containerConfig: "" + +previewServer: + replicaCount: 1 + + service: + type: NodePort + + pdb: + enabled: true + + ingress: + enabled: true + + annotations: + kubernetes.io/ingress.class: "" + external-dns.alpha.kubernetes.io/hostname: ps.gtm.jobtome.com + external-dns.alpha.kubernetes.io/ttl: "200" + cert-manager.io/cluster-issuer: "" + acme.cert-manager.io/http01-edit-in-place: "true" + + hosts: + - host: ps.gtm.jobtome.com + paths: + - path: / + pathType: ImplementationSpecific + + tls: + - secretName: ps-gtm-jobtome-com-tls + hosts: + - ps.gtm.jobtome.com + + frontendConfig: + enabled: true + + redirectToHttps: + enabled: true + + responseCodeName: MOVED_PERMANENTLY_DEFAULT + + backendConfig: + enabled: true + + timeoutSec: 30 + + healthCheck: + checkIntervalSec: 5 + timeoutSec: 3 + healthyThreshold: 1 + unhealthyThreshold: 2 + type: HTTP + requestPath: /healthz + port: 8080 + +serverSideTagging: + previewServerUrl: https://ps.gtm.jobtome.com + + service: + type: NodePort + + pdb: + enabled: true + + autoscaling: + enabled: false + + minReplicas: 3 + maxReplicas: 10 + + ingress: + enabled: true + + annotations: + kubernetes.io/ingress.class: "" + external-dns.alpha.kubernetes.io/hostname: sst.gtm.jobtome.com + external-dns.alpha.kubernetes.io/ttl: "200" + cert-manager.io/cluster-issuer: "" + acme.cert-manager.io/http01-edit-in-place: "true" + + hosts: + - host: sst.gtm.jobtome.com + paths: + - path: / + pathType: ImplementationSpecific + + tls: + - secretName: sst-gtm-jobtome-com-tls + hosts: + - sst.gtm.jobtome.com + + frontendConfig: + enabled: true + + redirectToHttps: + enabled: true + + responseCodeName: MOVED_PERMANENTLY_DEFAULT + + backendConfig: + enabled: true + + timeoutSec: 30 + + healthCheck: + checkIntervalSec: 5 + timeoutSec: 3 + healthyThreshold: 1 + unhealthyThreshold: 2 + type: HTTP + requestPath: /healthz + port: 8080 +``` + +In addition, you can enable [NEGs](https://cloud.google.com/kubernetes-engine/docs/how-to/standalone-neg). + +```YAML + service: + neg: + enabled: true +``` diff --git a/charts/google-tag-manager/Chart.yaml b/charts/google-tag-manager/Chart.yaml index e41f01a..b28e7f5 100644 --- a/charts/google-tag-manager/Chart.yaml +++ b/charts/google-tag-manager/Chart.yaml @@ -6,7 +6,7 @@ type: application name: google-tag-manager description: A Helm Chart for Google Tag Manager -version: "0.2.0" +version: "0.2.1" appVersion: "1.16.0" keywords: diff --git a/charts/google-tag-manager/README.md b/charts/google-tag-manager/README.md index 8f6a559..fe2a962 100644 --- a/charts/google-tag-manager/README.md +++ b/charts/google-tag-manager/README.md @@ -10,22 +10,164 @@ https://marketingplatform.google.com/about/tag-manager/ ## Usage -[Helm](https://helm.sh) must be installed to use this Chart. +### Prerequisites -Please refer to Helm's [Documentation](https://helm.sh/docs) to get started. +[Helm](https://helm.sh) must be installed first in order to use this Chart. -Once Helm has been set up correctly, add the repo as follows: +Please refer to Helm [Documentation](https://helm.sh/docs) to get started. + +### Helm Chart Repository + +Once Helm has been set up correctly, add locally the Helm Chart Repository as follows: helm repo add gtm https://jobtome-labs.github.io/google-tag-manager -If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions of this Chart. +If you had already added this Repository earlier, run `helm repo update` to retrieve the latest versions of this Chart. You can then run `helm search repo gtm` to see the Chart. +### Install Google Tag Manager Chart + To install the Google Tag Manager Chart: helm install gtm gtm/google-tag-manager -To uninstall the Chart: +### Uninstall Google Tag Manager Chart + +To uninstall the Google Tag Manager Chart: helm delete gtm + +### Helm Tests + +To run Chart Tests: + + helm test gtm + +### Example Values for GKE + +The following Example Helm Values are for a **GKE (Google Kubernetes Engine)** Context. + +In this context, the [GKE Ingress Controller](https://cloud.google.com/kubernetes-engine/docs/concepts/ingress) is being used, along with [Backend/Frontend Configs](https://cloud.google.com/kubernetes-engine/docs/how-to/ingress-configuration). + +```YAML +containerConfig: "" + +previewServer: + replicaCount: 1 + + service: + type: NodePort + + pdb: + enabled: true + + ingress: + enabled: true + + annotations: + kubernetes.io/ingress.class: "" + external-dns.alpha.kubernetes.io/hostname: ps.gtm.jobtome.com + external-dns.alpha.kubernetes.io/ttl: "200" + cert-manager.io/cluster-issuer: "" + acme.cert-manager.io/http01-edit-in-place: "true" + + hosts: + - host: ps.gtm.jobtome.com + paths: + - path: / + pathType: ImplementationSpecific + + tls: + - secretName: ps-gtm-jobtome-com-tls + hosts: + - ps.gtm.jobtome.com + + frontendConfig: + enabled: true + + redirectToHttps: + enabled: true + + responseCodeName: MOVED_PERMANENTLY_DEFAULT + + backendConfig: + enabled: true + + timeoutSec: 30 + + healthCheck: + checkIntervalSec: 5 + timeoutSec: 3 + healthyThreshold: 1 + unhealthyThreshold: 2 + type: HTTP + requestPath: /healthz + port: 8080 + +serverSideTagging: + previewServerUrl: https://ps.gtm.jobtome.com + + service: + type: NodePort + + pdb: + enabled: true + + autoscaling: + enabled: false + + minReplicas: 3 + maxReplicas: 10 + + ingress: + enabled: true + + annotations: + kubernetes.io/ingress.class: "" + external-dns.alpha.kubernetes.io/hostname: sst.gtm.jobtome.com + external-dns.alpha.kubernetes.io/ttl: "200" + cert-manager.io/cluster-issuer: "" + acme.cert-manager.io/http01-edit-in-place: "true" + + hosts: + - host: sst.gtm.jobtome.com + paths: + - path: / + pathType: ImplementationSpecific + + tls: + - secretName: sst-gtm-jobtome-com-tls + hosts: + - sst.gtm.jobtome.com + + frontendConfig: + enabled: true + + redirectToHttps: + enabled: true + + responseCodeName: MOVED_PERMANENTLY_DEFAULT + + backendConfig: + enabled: true + + timeoutSec: 30 + + healthCheck: + checkIntervalSec: 5 + timeoutSec: 3 + healthyThreshold: 1 + unhealthyThreshold: 2 + type: HTTP + requestPath: /healthz + port: 8080 +``` + +In addition, you can enable [NEGs](https://cloud.google.com/kubernetes-engine/docs/how-to/standalone-neg). + +```YAML + service: + neg: + enabled: true +```