Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TT-10798] Added support embedded TIB in dashboard and tyk-stack #212

Merged
merged 4 commits into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions components/tyk-bootstrap/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ global:

secrets:
# tyk_analytics.conf admin_secret
# tib.conf TykAPISettings.GatewayConfig.AdminSecret
# tib.conf TykAPISettings.DashboardConfig.AdminSecret
AdminSecret: "12345"
# If you don't want to store plaintext secrets in the Helm value file and would
# rather provide the k8s Secret externally please populate the value below
Expand Down
5 changes: 5 additions & 0 deletions components/tyk-dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,8 @@ follow these steps to enable TLS:
> - If necessary, either enable `insecureSkipVerify` via `dashboard.tls.certificates`, or mount CA information through `dashboard.extraVolumes` and `dashboard.extraVolumeMounts`.
> - If the `tyk-bootstrap` chart is used to bootstrap the Tyk Dashboard, ensure that it has certificates to send requests to the Tyk Dashboard or enable `insecureSkipVerify` in the `tyk-bootstrap` chart.
> - If the Tyk Gateway connects to the Tyk Dashboard, confirm that the Tyk Gateway has appropriate certificates for connecting to the Tyk Dashboard

#### Embedded TIB
Starting from Tyk v3.0 TIB has been added as a built-in feature of the Tyk Dashboard. You no longer have to setup a separated instance of the service to make it work with the Dashboard.

User can enable in-built TIB simply by setting `tib.enabled` to true.
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,12 @@ spec:
- name: TYK_DB_MONGODRIVER
value: "{{ default "mgo" .Values.global.mongo.driver}}"
{{ end }}

{{- if .Values.tib }}
- name: TYK_DB_TIB_ENABLED
value: {{ .Values.tib.enabled | quote }}
{{- end }}

{{- if .Values.dashboard.extraEnvs }}
{{- include "tyk-dashboard.tplvalues.render" (dict "value" .Values.dashboard.extraEnvs "context" $) | nindent 10 }}
{{- end }}
Expand Down
7 changes: 4 additions & 3 deletions components/tyk-dashboard/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ global:
# tyk_analytics.conf shared_node_secret
APISecret: CHANGEME
# tyk_analytics.conf admin_secret
# tib.conf TykAPISettings.GatewayConfig.AdminSecret
# tib.conf TykAPISettings.DashboardConfig.AdminSecret
AdminSecret: "12345"
# If you don't want to store plaintext secrets in the Helm value file and would
# rather provide the k8s Secret externally please populate the value below
Expand Down Expand Up @@ -387,4 +385,7 @@ portal:

# tls corresponds to the tls configuration if Ingress rules use TLS
tls: []

# tib is used to configure Tyk Identity Broker(TIB) connection details
tib:
# enabled is used to enable/disable embedded TIB
enabled: false
5 changes: 5 additions & 0 deletions tyk-stack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -746,6 +746,11 @@ follow these steps to enable TLS:
> - If the `tyk-bootstrap` chart is used to bootstrap the Tyk Dashboard, ensure that it has certificates to send requests to the Tyk Dashboard or enable `insecureSkipVerify` in the `tyk-bootstrap` chart.
> - If the Tyk Gateway connects to the Tyk Dashboard, confirm that the Tyk Gateway has appropriate certificates for connecting to the Tyk Dashboard

#### Embedded TIB
Starting from Tyk v3.0 TIB has been added as a built-in feature of the Tyk Dashboard. You no longer have to setup a separated instance of the service to make it work with the Dashboard.

User can enable in-built TIB simply by setting `tyk-dashboard.tib.enabled` to true.

### Tyk Bootstrap

To enable bootstrapping, set `global.components.bootstrap` to `true`. It would run [tyk-k8s-bootstrap](https://github.com/TykTechnologies/tyk-k8s-bootstrap) to bootstrap `tyk-stack` and to create Kubernetes secrets that can be utilized in Tyk Operator and Tyk Enterprise Developer Portal.
Expand Down
6 changes: 4 additions & 2 deletions tyk-stack/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,6 @@ global:
# tyk_analytics.conf shared_node_secret
APISecret: CHANGEME
# tyk_analytics.conf admin_secret
# tib.conf TykAPISettings.GatewayConfig.AdminSecret
# tib.conf TykAPISettings.DashboardConfig.AdminSecret
AdminSecret: "12345"
# If you don't want to store plaintext secrets in the Helm value file and would
# rather provide the k8s Secret externally please populate the value below
Expand Down Expand Up @@ -938,6 +936,10 @@ tyk-dashboard:
- path: /
pathType: ImplementationSpecific
tls: []
# tib is used to configure Tyk Identity Broker(TIB) connection details
tib:
# enabled is used to enable/disable embedded TIB
enabled: false

tyk-dev-portal:
# Sensitive configuration of Portal could be set using k8s secret
Expand Down