diff --git a/components/tyk-bootstrap/README.md b/components/tyk-bootstrap/README.md index 34886d81..3fb10949 100644 --- a/components/tyk-bootstrap/README.md +++ b/components/tyk-bootstrap/README.md @@ -6,7 +6,7 @@ This chart helps with the bootstrapping of the Tyk Dashboard by creating a job w The chart provides little benefits by itself and should only be used in conjunction with other charts that also use the dashboard component. ## Prerequisites -* Kuberentes 1.19+ +* Kubernetes 1.19+ * Helm 3+ ## Installing the Chart diff --git a/components/tyk-bootstrap/templates/bootstrap-post-install.yaml b/components/tyk-bootstrap/templates/bootstrap-post-install.yaml index 188e383a..6a66adf1 100644 --- a/components/tyk-bootstrap/templates/bootstrap-post-install.yaml +++ b/components/tyk-bootstrap/templates/bootstrap-post-install.yaml @@ -53,7 +53,9 @@ spec: - name: TYK_DASHBOARD_PROTO value: "{{ include "tyk-bootstrap.dash_proto" . }}" - name: TYK_DASHBOARD_SVC - {{- if .Values.global.components.dashboard }} + {{- if .Values.bootstrap.dashboard.serviceName }} + value: {{ .Values.bootstrap.dashboard.serviceName | quote }} + {{- else if .Values.global.components.dashboard }} value: "dashboard-svc-{{.Release.Name}}-tyk-dashboard" {{- else }} value: "dashboard-svc-tyk-dashboard" @@ -100,11 +102,7 @@ spec: value: "true" {{- end }} - name: TYK_DASHBOARD_DEPLOY - {{- if .Values.global.components.dashboard }} - value: "dashboard-{{.Release.Name}}-tyk-dashboard" - {{- else }} value: {{ .Values.bootstrap.dashboard.deploymentName }} - {{- end }} restartPolicy: Never terminationGracePeriodSeconds: 0 {{- end }} diff --git a/components/tyk-bootstrap/values.yaml b/components/tyk-bootstrap/values.yaml index 18ba1bc5..c7c3f148 100644 --- a/components/tyk-bootstrap/values.yaml +++ b/components/tyk-bootstrap/values.yaml @@ -45,6 +45,9 @@ bootstrap: enabled: true # Name of the deployment that we want to bootstrap deploymentName: dashboard-tyk-dashboard + + # Specify if dashboard has custom service name. + serviceName: "" portal: # Trigger to control if we want to bootstrap the dashboard component using tyk-bootstrap enabled: true diff --git a/components/tyk-dashboard/README.md b/components/tyk-dashboard/README.md index 241aa60e..11550287 100644 --- a/components/tyk-dashboard/README.md +++ b/components/tyk-dashboard/README.md @@ -13,7 +13,7 @@ For typical usage, we recommend using following umbrella charts: [Learn more about Tyk Licensing and Deployment models](https://tyk.io/docs/tyk-on-premises/licensing/) ## Prerequisites -* Kuberentes 1.19+ +* Kubernetes 1.19+ * Helm 3+ * [Redis](https://tyk.io/docs/planning-for-production/redis/) should already be installed or accessible by the dashboard * [Mongo](https://tyk.io/docs/planning-for-production/database-settings/mongodb/) or [PostgreSQL](https://tyk.io/docs/planning-for-production/database-settings/postgresql/) should already be installed or accessible by the dashboard diff --git a/components/tyk-dashboard/templates/secrets-mounts.yaml b/components/tyk-dashboard/templates/secrets-mounts.yaml deleted file mode 100644 index ba518058..00000000 --- a/components/tyk-dashboard/templates/secrets-mounts.yaml +++ /dev/null @@ -1,16 +0,0 @@ -{{- range $secret := .Values.dashboard.mounts }} -apiVersion: v1 -kind: Secret -metadata: - name: {{ $.Release.Name }}-dashboard-secret-{{ $secret.name }} - labels: - app: dashboard-secret-{{ $secret.name }}-{{ include "tyk-dashboard.fullname" $ }} - chart: {{ include "tyk-dashboard.chart" $ }} - release: {{ $.Release.Name }} - heritage: {{ $.Release.Service }} -type: Opaque -data: - {{ $secret.filename }}: |- -{{ $.Files.Get (printf "mounts/%s" $secret.filename) | b64enc | indent 4 }} ---- -{{- end }} diff --git a/components/tyk-dashboard/values.yaml b/components/tyk-dashboard/values.yaml index 76f19cc9..0f10426a 100644 --- a/components/tyk-dashboard/values.yaml +++ b/components/tyk-dashboard/values.yaml @@ -1,3 +1,9 @@ +# nameOverride overrides the Chart name. It is truncated to 63 characters. +nameOverride: "" + +# fullnameOverride overrides App name. It is truncated to 63 characters. +fullnameOverride: "" + global: license: # The license key needed by Tyk Dashboard to work @@ -79,7 +85,7 @@ global: # Default value: false # enableCluster: true - # By default the database index is 0. Setting the database index is not + # By default, the database index is 0. Setting the database index is not # supported with redis cluster. As such, if you have enableCluster: true, # then this value should be omitted or explicitly set to 0. storage: diff --git a/components/tyk-gateway/README.md b/components/tyk-gateway/README.md index abd45993..c6bee4c6 100644 --- a/components/tyk-gateway/README.md +++ b/components/tyk-gateway/README.md @@ -16,7 +16,7 @@ For typical usage, we recommend using following umbrella charts: [Learn more about different deployment options](https://tyk.io/docs/apim/) ## Prerequisites -* Kuberentes 1.19+ +* Kubernetes 1.19+ * Helm 3+ * [Redis](https://tyk.io/docs/planning-for-production/redis/) should already be installed or accessible by the gateway diff --git a/components/tyk-gateway/values.yaml b/components/tyk-gateway/values.yaml index 2bd7f204..ed184711 100644 --- a/components/tyk-gateway/values.yaml +++ b/components/tyk-gateway/values.yaml @@ -84,7 +84,7 @@ global: # Redis sentinel master name, only required while enableSentinel is true. # masterName: "" - # By default the database index is 0. Setting the database index is not + # By default, the database index is 0. Setting the database index is not # supported with redis cluster. As such, if you have enableCluster: true, # then this value should be omitted or explicitly set to 0. storage: diff --git a/components/tyk-pump/README.md b/components/tyk-pump/README.md index c7ac1813..765185d6 100644 --- a/components/tyk-pump/README.md +++ b/components/tyk-pump/README.md @@ -135,7 +135,7 @@ Add following under the `global` section in `values.yaml`: ``` #### Uptime Pump -Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml file. It support following values +Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml file. It supports following values 1. mongo: Used to set mongo pump for uptime analytics. Mongo Pump should be enabled. 2. postgres: Used to set postgres pump for uptime analytics. Postgres Pump should be enabled. 3. empty: Used to disable uptime analytics. @@ -172,5 +172,5 @@ Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml ``` #### Other Pumps -To setup other backends for pump, refer to this [document](https://github.com/TykTechnologies/tyk-pump/blob/master/README.md#pumps--back-ends-supported) and add the required environment variables in `pump.extraEnvs` +To set up other backends for pump, refer to this [document](https://github.com/TykTechnologies/tyk-pump/blob/master/README.md#pumps--back-ends-supported) and add the required environment variables in `pump.extraEnvs` diff --git a/components/tyk-pump/values.yaml b/components/tyk-pump/values.yaml index a17df835..86b51686 100644 --- a/components/tyk-pump/values.yaml +++ b/components/tyk-pump/values.yaml @@ -60,7 +60,7 @@ global: # For bitnami/redis typically redis-master # masterName: "" - # By default the database index is 0. Setting the database index is not + # By default, the database index is 0. Setting the database index is not # supported with redis cluster. As such, if you have enableCluster: true, # then this value should be omitted or explicitly set to 0. storage: diff --git a/tyk-mdcb-data-plane/README.md b/tyk-mdcb-data-plane/README.md index 870bc38b..238e4304 100644 --- a/tyk-mdcb-data-plane/README.md +++ b/tyk-mdcb-data-plane/README.md @@ -18,7 +18,7 @@ Also, you can set the version of each component through `image.tag`. You could f ## Prerequisites -* Kuberentes 1.19+ +* Kubernetes 1.19+ * Helm 3+ * Redis should already be installed or accessible by the gateway. For Redis installation instruction, please see [https://tyk.io/docs/tyk-oss/ce-helm-chart/#recommended-via-bitnami-chart](https://tyk.io/docs/tyk-oss/ce-helm-chart/#recommended-via-bitnami-chart). @@ -116,14 +116,14 @@ To enable Pump, set `global.components.pump` to true, and configure below inside -| Pump | Configuration | -|---------------------------|------------------------------------------------------------------------------------------------------------| -| Prometheus Pump (Default) | Add `prometheus` to `pump.backend`, and add connection details for prometheus under `pump.prometheusPump`. | -| Mongo Pump | Add `mongo` to `pump.backend`, and add connection details for mongo under `.mongo`. | -| SQL Pump | Add `postgres` to `pump.backend`, and add connection details for postgres under `.postgres`. | -| Uptime Pump | Set `pump.uptimePumpBackend` to `'mongo'` or `'postgres'` or `''` | -| Hybrid Pump | Add `hybrid` to `pump.backend`, and setup `.remoteControlPlane` section with the required adresses and tokens | -| Other Pumps | Add the required environment variables in `pump.extraEnvs` | +| Pump | Configuration | +|---------------------------|-----------------------------------------------------------------------------------------------------------------| +| Prometheus Pump (Default) | Add `prometheus` to `pump.backend`, and add connection details for prometheus under `pump.prometheusPump`. | +| Mongo Pump | Add `mongo` to `pump.backend`, and add connection details for mongo under `.mongo`. | +| SQL Pump | Add `postgres` to `pump.backend`, and add connection details for postgres under `.postgres`. | +| Uptime Pump | Set `pump.uptimePumpBackend` to `'mongo'` or `'postgres'` or `''` | +| Hybrid Pump | Add `hybrid` to `pump.backend`, and setup `.remoteControlPlane` section with the required adresses and tokens | +| Other Pumps | Add the required environment variables in `pump.extraEnvs` | #### Prometheus Pump Add `prometheus` to `pump.backend`, and add connection details for prometheus under `pump.prometheusPump`. @@ -185,7 +185,7 @@ postgres: ``` #### Uptime Pump -Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml file. It support the following values +Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml file. It supports the following values 1. mongo: Used to set mongo pump for uptime analytics. Mongo Pump should be enabled. 2. postgres: Used to set postgres pump for uptime analytics. Postgres Pump should be enabled. 3. empty: Used to disable uptime analytics. @@ -222,7 +222,7 @@ Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml ``` #### Other Pumps -To setup other backends for pump, refer to this [document](https://github.com/TykTechnologies/tyk-pump/blob/master/README.md#pumps--back-ends-supported) and add the required environment variables in `pump.extraEnvs` +To set up other backends for pump, refer to this [document](https://github.com/TykTechnologies/tyk-pump/blob/master/README.md#pumps--back-ends-supported) and add the required environment variables in `pump.extraEnvs` diff --git a/tyk-mdcb-data-plane/templates/configmap.yaml b/tyk-mdcb-data-plane/templates/configmap.yaml deleted file mode 100644 index 56f11e15..00000000 --- a/tyk-mdcb-data-plane/templates/configmap.yaml +++ /dev/null @@ -1,11 +0,0 @@ -apiVersion: v1 -kind: ConfigMap -metadata: - name: config-{{ include "tyk-data-plane.fullname" .}} - namespace: {{ .Release.Namespace}} - labels: - app: secrets-tyk-data-plane - release: {{ .Release.Name }} -data: - rpcUseSSL: "{{ .Values.global.remoteControlPlane.useSSL}}" - rpcSslInsecureSkipVerify: "{{ .Values.global.remoteControlPlane.sslInsecureSkipVerify}}" diff --git a/tyk-mdcb-data-plane/templates/secrets.yaml b/tyk-mdcb-data-plane/templates/secrets.yaml index 397fbf2b..e505685b 100644 --- a/tyk-mdcb-data-plane/templates/secrets.yaml +++ b/tyk-mdcb-data-plane/templates/secrets.yaml @@ -8,8 +8,4 @@ metadata: release: {{ .Release.Name }} type: Opaque stringData: - rpcConnString: "{{ .Values.global.remoteControlPlane.connectionString }}" - orgId: "{{ .Values.global.remoteControlPlane.orgId }}" - userApiKey: "{{ .Values.global.remoteControlPlane.userApiKey }}" APISecret: "{{ .Values.global.secrets.APISecret}}" - groupID: "{{ .Values.global.remoteControlPlane.groupID}}" diff --git a/tyk-mdcb-data-plane/values.yaml b/tyk-mdcb-data-plane/values.yaml index c036f742..bbe43afe 100644 --- a/tyk-mdcb-data-plane/values.yaml +++ b/tyk-mdcb-data-plane/values.yaml @@ -1,9 +1,16 @@ # Default values for tyk-mdcb-data-plane. # This is a YAML-formatted file. # Declare variables to be passed into your templates. + +# nameOverride overrides the Chart name. It is truncated to 63 characters. +nameOverride: "" + +# fullnameOverride overrides App name. It is truncated to 63 characters. +fullnameOverride: "" + global: components: - # Determines whether or not the pump component should be installed. + # Determines whether the pump component should be installed. pump: true servicePorts: @@ -89,7 +96,7 @@ global: # For bitnami/redis typically redis-master # masterName: "" - # By default the database index is 0. Setting the database index is not + # By default, the database index is 0. Setting the database index is not # supported with redis cluster. As such, if you have enableCluster: true, # then this value should be omitted or explicitly set to 0. storage: diff --git a/tyk-oss/README.md b/tyk-oss/README.md index 03b5d8b7..1e306436 100644 --- a/tyk-oss/README.md +++ b/tyk-oss/README.md @@ -17,7 +17,7 @@ Also, you can set the version of each component through `image.tag`. You could f ## Prerequisites -* Kuberentes 1.19+ +* Kubernetes 1.19+ * Helm 3+ * Redis should already be installed or accessible by the gateway. For Redis installation instruction, please see [https://tyk.io/docs/tyk-oss/ce-helm-chart/#recommended-via-bitnami-chart](https://tyk.io/docs/tyk-oss/ce-helm-chart/#recommended-via-bitnami-chart). @@ -171,13 +171,13 @@ Add following under the `global` section in `values.yaml`: ``` #### Uptime Pump -Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml file. It support the following values +Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml file. It supports the following values 1. mongo: Used to set mongo pump for uptime analytics. Mongo Pump should be enabled. 2. postgres: Used to set postgres pump for uptime analytics. Postgres Pump should be enabled. 3. empty: Used to disable uptime analytics. #### Other Pumps -To setup other backends for pump, refer to this [document](https://github.com/TykTechnologies/tyk-pump/blob/master/README.md#pumps--back-ends-supported) and add the required environment variables in `pump.extraEnvs` +To set up other backends for pump, refer to this [document](https://github.com/TykTechnologies/tyk-pump/blob/master/README.md#pumps--back-ends-supported) and add the required environment variables in `pump.extraEnvs` diff --git a/tyk-oss/values.yaml b/tyk-oss/values.yaml index 0a708ede..7ed26732 100644 --- a/tyk-oss/values.yaml +++ b/tyk-oss/values.yaml @@ -1,3 +1,9 @@ +# nameOverride overrides the Chart name. It is truncated to 63 characters. +nameOverride: "" + +# fullnameOverride overrides App name. It is truncated to 63 characters. +fullnameOverride: "" + global: components: # Determines whether the pump component should be installed. @@ -70,7 +76,7 @@ global: # For bitnami/redis typically redis-master # masterName: "" - # By default the database index is 0. Setting the database index is not + # By default, the database index is 0. Setting the database index is not # supported with redis cluster. As such, if you have enableCluster: true, # then this value should be omitted or explicitly set to 0. storage: diff --git a/tyk-single-dc/README.md b/tyk-single-dc/README.md index 855a66af..f7a66afe 100644 --- a/tyk-single-dc/README.md +++ b/tyk-single-dc/README.md @@ -22,7 +22,7 @@ Also, you can set the version of each component through `image.tag`. You could f ## Prerequisites -* Kuberentes 1.19+ +* Kubernetes 1.19+ * Helm 3+ * Redis should already be installed or accessible by the gateway. For Redis installation instruction, please see https://tyk.io/docs/tyk-oss/ce-helm-chart/#recommended-via-bitnami-chart. @@ -204,13 +204,13 @@ postgres: ``` #### Uptime Pump -Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml file. It support following values +Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml file. It supports following values 1. mongo: Used to set mongo pump for uptime analytics. Mongo Pump should be enabled. 2. postgres: Used to set postgres pump for uptime analytics. Postgres Pump should be enabled. 3. empty: Used to disable uptime analytics. #### Other Pumps -To setup other backends for pump, refer to this [document](https://github.com/TykTechnologies/tyk-pump/blob/master/README.md#pumps--back-ends-supported) and add the required environment variables in `pump.extraEnvs` +To set up other backends for pump, refer to this [document](https://github.com/TykTechnologies/tyk-pump/blob/master/README.md#pumps--back-ends-supported) and add the required environment variables in `pump.extraEnvs` diff --git a/tyk-single-dc/templates/configmap.yaml b/tyk-single-dc/templates/configmap.yaml deleted file mode 100644 index 83ef1c33..00000000 --- a/tyk-single-dc/templates/configmap.yaml +++ /dev/null @@ -1,12 +0,0 @@ -apiVersion: v1 -kind: ConfigMap -metadata: - name: config-tyk-single-dc - namespace: {{ .Release.Namespace}} - labels: - app: secrets-tyk-single-dc - release: {{ .Release.Name }} -data: - rpcConnString: "{{ .Values.global.remoteControlPlane.connectionString }}" - rpcUseSSL: "{{ .Values.global.remoteControlPlane.useSSL}}" - rpcSslInsecureSkipVerify: "{{ .Values.global.remoteControlPlane.sslInsecureSkipVerify}}" diff --git a/tyk-single-dc/templates/secrets.yaml b/tyk-single-dc/templates/secrets.yaml index 6d7bef83..b09064a4 100644 --- a/tyk-single-dc/templates/secrets.yaml +++ b/tyk-single-dc/templates/secrets.yaml @@ -8,7 +8,4 @@ metadata: release: {{ .Release.Name }} type: Opaque stringData: - orgID: "{{ .Values.global.remoteControlPlane.orgId }}" - apiKey: "{{ .Values.global.remoteControlPlane.userApiKey }}" APISecret: "{{ .Values.global.secrets.APISecret}}" - groupID: "{{ .Values.global.remoteControlPlane.groupID}}" diff --git a/tyk-single-dc/values.yaml b/tyk-single-dc/values.yaml index 8d4a6a4a..ae6c5868 100644 --- a/tyk-single-dc/values.yaml +++ b/tyk-single-dc/values.yaml @@ -6,7 +6,7 @@ global: license: dashboard: "" components: - # Determines whether or not the pump component should be installed. + # Determines whether the pump component should be installed. pump: true dashboard: true @@ -87,7 +87,7 @@ global: # Default value: false # enableCluster: true - # By default the database index is 0. Setting the database index is not + # By default, the database index is 0. Setting the database index is not # supported with redis cluster. As such, if you have enableCluster: true, # then this value should be omitted or explicitly set to 0. storage: @@ -435,6 +435,8 @@ tyk-bootstrap: dashboard: enabled: true deploymentName: dashboard-tyk-single-dc-tyk-dashboard + # Specify if dashboard has custom service name. + serviceName: "" portal: enabled: true gateway: @@ -477,6 +479,12 @@ tyk-bootstrap: preDeletePodAnnotations: {} tyk-dashboard: + # nameOverride overrides the Chart name. It is truncated to 63 characters. + nameOverride: "" + + # fullnameOverride overrides App name. It is truncated to 63 characters. + fullnameOverride: "" + dashboard: enableOwnership: true defaultPageSize: 10