feat: Add imagePullSecrets to support amundsen private images (#927)

* feat(helm): Add imagePullSecrets to support amundsen private images
Signed-off-by: Joey Bates <35610156+joeybaer@users.noreply.github.com>

* feat(helm): Update values to support helm-docs latest version, bump version to 2.1.0
Signed-off-by: Joey Bates <35610156+joeybaer@users.noreply.github.com>

amundsen-kube-helm/README.md

@@ -27,8 +27,6 @@ This is setup templates for deploying [amundsen](https://github.com/amundsen-io/
 
 ## Chart Values
 
-The following table lists the configurable parameters of the Amundsen charts and their default values.
-
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | LONG_RANDOM_STRING | int | `1234` | A long random string. You should probably provide your own. This is needed for OIDC. |
@@ -47,12 +45,14 @@ The following table lists the configurable parameters of the Amundsen charts and
 | frontEnd.OIDC_CLIENT_ID | string | `nil` | The client id for OIDC. |
 | frontEnd.OIDC_CLIENT_SECRET | string | `""` | The client secret for OIDC. |
 | frontEnd.OIDC_ORG_URL | string | `nil` | The organization URL for OIDC. |
+| frontEnd.OVERWRITE_REDIRECT_URI | string | `nil` | The redirect uri for OIDC. |
 | frontEnd.affinity | object | `{}` | Frontend pod specific affinity. |
 | frontEnd.annotations | object | `{}` | Frontend service specific tolerations. |
 | frontEnd.baseUrl | string | `"http://localhost"` | used by notifications util to provide links to amundsen pages in emails. |
 | frontEnd.createOidcSecret | bool | `false` | OIDC needs some configuration. If you want the chart to make your secrets, set this to true and set the next four values. If you don't want to configure your secrets via helm, you can still use the amundsen-oidc-config.yaml as a template |
 | frontEnd.image | string | `"amundsendev/amundsen-frontend"` | The image of the frontend container. |
-| frontEnd.imageTag | string | `"2.0.0"` | The image tag of the frontend container. |
+| frontEnd.imagePullSecrets | list | `[]` | Optional pod imagePullSecrets [ref](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) |
+| frontEnd.imageTag | string | `"2.3.0"` | The image tag of the frontend container. |
 | frontEnd.nodeSelector | object | `{}` | Frontend pod specific nodeSelector. |
 | frontEnd.oidcEnabled | bool | `false` | To enable auth via OIDC, set this to true. |
 | frontEnd.podAnnotations | object | `{}` | Frontend pod specific annotations. |
@@ -65,7 +65,8 @@ The following table lists the configurable parameters of the Amundsen charts and
 | metadata.affinity | object | `{}` | Metadata pod specific affinity. |
 | metadata.annotations | object | `{}` | Metadata service specific tolerations. |
 | metadata.image | string | `"amundsendev/amundsen-metadata"` | The image of the metadata container. |
-| metadata.imageTag | string | `"2.0.0"` | The image tag of the metadata container. |
+| metadata.imagePullSecrets | list | `[]` | Optional pod imagePullSecrets [ref](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) |
+| metadata.imageTag | string | `"2.5.5"` | The image tag of the metadata container. |
 | metadata.neo4jEndpoint | string | `nil` | The name of the service hosting neo4j on your cluster, if you bring your own. You should only need to change this, if you don't use the version in this chart. |
 | metadata.nodeSelector | object | `{}` | Metadata pod specific nodeSelector. |
 | metadata.podAnnotations | object | `{}` | Metadata pod specific annotations. |
@@ -76,14 +77,14 @@ The following table lists the configurable parameters of the Amundsen charts and
 | metadata.tolerations | list | `[]` | Metadata pod specific tolerations. |
 | neo4j.affinity | object | `{}` | neo4j specific affinity. |
 | neo4j.annotations | object | `{}` | neo4j service specific tolerations. |
-| neo4j.backup | object | `{"enabled":false,"s3Path":"s3://dev/null","schedule":"0 * * * *"}` | If enabled is set to true, make sure and set the s3 path as well. |
+| neo4j.backup | object | `{"enabled":false,"podAnnotations":{},"s3Path":"s3://dev/null","schedule":"0 * * * *"}` | If enabled is set to true, make sure and set the s3 path as well. |
 | neo4j.backup.s3Path | string | `"s3://dev/null"` | The s3path to write to for backups. |
 | neo4j.backup.schedule | string | `"0 * * * *"` | The schedule to run backups on. Defaults to hourly. |
-| neo4j.config | object | `{"dbms":{"heap_initial_size":"23000m","heap_max_size":"23000m","pagecache_size":"26600m"}}` | Neo4j application specific configuration. This type of configuration is why the charts/stable version is not used. See [ref](https://github.com/helm/charts/issues/21439) |
-| neo4j.config.dbms | object | `{"heap_initial_size":"23000m","heap_max_size":"23000m","pagecache_size":"26600m"}` | dbms config for neo4j |
-| neo4j.config.dbms.heap_initial_size | string | `"23000m"` | the initial java heap for neo4j |
-| neo4j.config.dbms.heap_max_size | string | `"23000m"` | the max java heap for neo4j |
-| neo4j.config.dbms.pagecache_size | string | `"26600m"` | the page cache size for neo4j |
+| neo4j.config | object | `{"dbms":{"heap_initial_size":"1G","heap_max_size":"2G","pagecache_size":"2G"}}` | Neo4j application specific configuration. This type of configuration is why the charts/stable version is not used. See [ref](https://github.com/helm/charts/issues/21439) |
+| neo4j.config.dbms | object | `{"heap_initial_size":"1G","heap_max_size":"2G","pagecache_size":"2G"}` | dbms config for neo4j |
+| neo4j.config.dbms.heap_initial_size | string | `"1G"` | the initial java heap for neo4j |
+| neo4j.config.dbms.heap_max_size | string | `"2G"` | the max java heap for neo4j |
+| neo4j.config.dbms.pagecache_size | string | `"2G"` | the page cache size for neo4j |
 | neo4j.enabled | bool | `true` | If neo4j is enabled as part of this chart, or not. Set this to false if you want to provide your own version. |
 | neo4j.nodeSelector | object | `{}` | neo4j specific nodeSelector. |
 | neo4j.persistence | object | `{}` | Neo4j persistence. Turn this on to keep your data between pod crashes, etc. This is also needed for backups. |
@@ -96,9 +97,11 @@ The following table lists the configurable parameters of the Amundsen charts and
 | provider | string | `"aws"` | The cloud provider the app is running in. Used to construct dns hostnames (on aws only). |
 | search.affinity | object | `{}` | Search pod specific affinity. |
 | search.annotations | object | `{}` | Search service specific tolerations. |
+| search.elasticSearchCredentials | object | `{}` | The elasticsearch user and password. This should only be set if you bring your own elasticsearch cluster in which case you must also set elasticsearch.enabled to false |
 | search.elasticsearchEndpoint | string | `nil` | The name of the service hosting elasticsearch on your cluster, if you bring your own. You should only need to change this, if you don't use the version in this chart. |
 | search.image | string | `"amundsendev/amundsen-search"` | The image of the search container. |
-| search.imageTag | string | `"2.0.0"` | The image tag of the search container. |
+| search.imagePullSecrets | list | `[]` | Optional pod imagePullSecrets [ref](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/) |
+| search.imageTag | string | `"2.4.0"` | The image tag of the search container. |
 | search.nodeSelector | object | `{}` | Search pod specific nodeSelector. |
 | search.podAnnotations | object | `{}` | Search pod specific annotations. |
 | search.replicas | int | `1` | How many replicas of the search service to run. |
@@ -108,6 +111,10 @@ The following table lists the configurable parameters of the Amundsen charts and
 | search.tolerations | list | `[]` | Search pod specific tolerations. |
 | tolerations | list | `[]` | amundsen application wide configuration of tolerations. This applies to search, metadata, frontend and neo4j. Elasticsearch has it's own configuation properties for this. [ref](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#taints-and-tolerations-beta-feature) |
 
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)
+
+
 ## Neo4j DBMS Config?
 
 You may want to override the default memory usage for Neo4J. In particular, if you're just test-driving a deployment and your node exits with status 137, you should set the usage to smaller values:

amundsen-kube-helm/templates/helm/Chart.yaml

 apiVersion: v1
 description: Amundsen is a metadata driven application for improving the productivity of data analysts, data scientists and engineers when interacting with data.
 name: amundsen
-version: 2.0.0
+version: 2.1.0
 icon: https://github.com/amundsen-io/amundsen/blob/master/docs/img/logos/amundsen_logo_on_light.svg
 home: https://github.com/amundsen-io/amundsen
 maintainers:

amundsen-kube-helm/templates/helm/templates/deployment-frontend.yaml

@@ -45,6 +45,10 @@ spec:
           secret:
             secretName: oidc-config
       {{- end }}
+    {{- if .Values.frontEnd.imagePullSecrets }}
+      imagePullSecrets:
+{{ toYaml .Values.frontEnd.imagePullSecrets | indent 8 }}
+    {{- end }}
       containers:
       - name: {{ .Chart.Name }}-{{ .Values.frontEnd.serviceName }}
         image: {{ .Values.frontEnd.image }}:{{ .Values.frontEnd.imageTag }}

amundsen-kube-helm/templates/helm/templates/deployment-metadata.yaml

@@ -43,6 +43,10 @@ spec:
           secret:
             secretName: oidc-config
       {{- end }}
+    {{- if .Values.metadata.imagePullSecrets }}
+      imagePullSecrets:
+{{ toYaml .Values.metadata.imagePullSecrets | indent 8 }}
+    {{- end }}
       containers:
       - name: {{ .Chart.Name }}-{{ .Values.metadata.serviceName }}
         image: {{ .Values.metadata.image }}:{{ .Values.metadata.imageTag }}

amundsen-kube-helm/templates/helm/templates/deployment-search.yaml

@@ -39,6 +39,10 @@ spec:
       tolerations:
 {{ toYaml . | indent 8 }}
       {{- end }}
+    {{- if .Values.search.imagePullSecrets }}
+      imagePullSecrets:
+{{ toYaml .Values.search.imagePullSecrets | indent 8 }}
+    {{- end }}
       containers:
       - name: {{ .Chart.Name }}-{{ .Values.search.serviceName }}
         image: {{ .Values.search.image }}:{{ .Values.search.imageTag }}