diff --git a/tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-mongodb.md b/tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-mongodb.md index 796ca0d613..00a5919623 100644 --- a/tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-mongodb.md +++ b/tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-mongodb.md @@ -32,6 +32,8 @@ At the end of this quickstart Tyk Dashboard should be accessible through service First, you need to provide Tyk license, admin email and password, and API keys. We recommend to store them in secrets. ```bash NAMESPACE=tyk +REDIS_BITNAMI_CHART_VERSION=19.0.2 +MONGO_BITNAMI_CHART_VERSION=15.1.2 API_SECRET=changeit ADMIN_KEY=changeit @@ -58,21 +60,39 @@ kubectl create secret generic admin-secrets -n $NAMESPACE \ If you do not already have Redis installed, you may use these charts provided by Bitnami. ```bash -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --install +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --install --version $REDIS_BITNAMI_CHART_VERSION ``` Follow the notes from the installation output to get connection details and password. The DNS name of your Redis as set by Bitnami is `tyk-redis-master.tyk.svc:6379` (Tyk needs the name including the port) The Bitnami chart also creates a secret `tyk-redis` which stores the connection password in `redis-password`. We will make use of this secret in installation later. +{{< note success >}} +**Note** + +Please make sure you are installing Redis versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "planning-for-production/redis" >}}). +{{< /note >}} + **3. Install MongoDB (if you don't have a MongoDB instance)** If you do not already have MongoDB installed, you may use these charts provided by Bitnami. ```bash -helm upgrade tyk-mongo oci://registry-1.docker.io/bitnamicharts/mongodb -n $NAMESPACE --install +helm upgrade tyk-mongo oci://registry-1.docker.io/bitnamicharts/mongodb -n $NAMESPACE --install --version $MONGO_BITNAMI_CHART_VERSION ``` +{{< note success >}} +**Note** + +Please make sure you are installing MongoDB versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "tyk-dashboard/database-options" >}}). +{{< /note >}} + +{{< note >}} +**Note** + +Bitnami MongoDB image is not supported on darwin/arm64 architecture. +{{< /note >}} + We require the MongoDB connection string for Tyk installation. You can store it in a secret and provide the secret in installation later. ```bash diff --git a/tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-postgresql.md b/tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-postgresql.md index 28412a0dc7..edfbe49221 100644 --- a/tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-postgresql.md +++ b/tyk-docs/content/deployment-and-operations/tyk-self-managed/deployment-lifecycle/installations/kubernetes/tyk-helm-tyk-stack-postgresql.md @@ -27,6 +27,8 @@ First, you need to provide Tyk license, admin email and password, and API keys. ```bash NAMESPACE=tyk +REDIS_BITNAMI_CHART_VERSION=19.0.2 +POSTGRES_BITNAMI_CHART_VERSION=14.2.4 API_SECRET=changeit ADMIN_KEY=changeit @@ -53,7 +55,7 @@ kubectl create secret generic admin-secrets -n $NAMESPACE \ If you do not already have Redis installed, you may use these charts provided by Bitnami. ```bash -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --install +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --install --version $REDIS_BITNAMI_CHART_VERSION ``` Follow the notes from the installation output to get connection details and password. The DNS name of your Redis as set by Bitnami is `tyk-redis-master.tyk.svc:6379` (Tyk needs the name including the port) @@ -64,7 +66,7 @@ The Bitnami chart also creates a secret `tyk-redis` which stores the connection If you do not already have PostgreSQL installed, you may use these charts provided by Bitnami. ```bash -helm upgrade tyk-postgres oci://registry-1.docker.io/bitnamicharts/postgresql --set "auth.database=tyk_analytics" -n $NAMESPACE --install +helm upgrade tyk-postgres oci://registry-1.docker.io/bitnamicharts/postgresql --set "auth.database=tyk_analytics" -n $NAMESPACE --install --version $POSTGRES_BITNAMI_CHART_VERSION ``` Follow the notes from the installation output to get connection details. diff --git a/tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md b/tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md index 0a31cd79bd..b6d2ef08c9 100644 --- a/tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md +++ b/tyk-docs/content/product-stack/tyk-charts/tyk-control-plane-chart.md @@ -130,7 +130,7 @@ For Redis you can use these rather excellent charts provided by [Bitnami](https: Copy the following commands to add it: ```bash -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n tyk --create-namespace --install +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n tyk --create-namespace --install --version 19.0.2 ``` {{< note success >}} @@ -181,7 +181,7 @@ If not, you can use these rather excellent charts provided by Bitnami to install **Mongo Installation** ```bash -helm install tyk-mongo bitnami/mongodb --version {HELM_CHART_VERSION} --set "replicaSet.enabled=true" -n tyk +helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.2 ``` Then follow notes from the installation output to get connection details and update them in `values.yaml` file. @@ -189,6 +189,12 @@ Then follow notes from the installation output to get connection details and upd {{< note success >}} **Note** +Bitnami MongoDB image is not supported on darwin/arm64 architecture. +{{< /note >}} + +{{< note success >}} +**Note** + Please make sure you are installing MongoDB versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "tyk-dashboard/database-options" >}}). {{< /note >}} @@ -226,7 +232,7 @@ global: **PostgreSQL Installation** ```bash -helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk +helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk --version 14.2.4 ``` Follow the notes from the installation output to get connection details. diff --git a/tyk-docs/content/product-stack/tyk-charts/tyk-data-plane-chart.md b/tyk-docs/content/product-stack/tyk-charts/tyk-data-plane-chart.md index 65bce68e17..0bc0766bb7 100644 --- a/tyk-docs/content/product-stack/tyk-charts/tyk-data-plane-chart.md +++ b/tyk-docs/content/product-stack/tyk-charts/tyk-data-plane-chart.md @@ -119,7 +119,7 @@ For Redis you can use these rather excellent charts provided by [Bitnami](https: Copy the following commands to add it: ```bash -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n tyk --create-namespace --install +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n tyk --create-namespace --install --version 19.0.2 ``` {{< note success >}} diff --git a/tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md b/tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md index 2b46cd4bfb..0ab764eed4 100644 --- a/tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md +++ b/tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md @@ -107,7 +107,7 @@ For Redis you can use these rather excellent charts provided by [Bitnami](https: Copy the following commands to add it: ```bash -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n tyk --create-namespace --install +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n tyk --create-namespace --install --version 19.0.2 ``` {{< note success >}} @@ -358,9 +358,21 @@ If you are using the MongoDB pumps in the tyk-oss installation you will require To install MongoDB you can use these rather excellent charts provided by Bitnami: ```bash -helm install tyk-mongo bitnami/mongodb --version {HELM_CHART_VERSION} --set "replicaSet.enabled=true" -n tyk +helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.2 ``` +{{< note success >}} +**Note** + +Bitnami MongoDB image is not supported on darwin/arm64 architecture. +{{< /note >}} + +{{< note success >}} +**Note** + +Please make sure you are installing MongoDB versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "tyk-dashboard/database-options" >}}). +{{< /note >}} + Follow notes from the installation output to get connection details and update them in the `values.yaml` file. NOTE: Please make sure you are installing a mongo helm chart that matches a supported [version](https://tyk.io/docs/planning-for-production/database-settings/). @@ -397,9 +409,15 @@ If you are using the SQL Pumps in the tyk-oss installation you will require Post To install PostgreSQL you can use these rather excellent charts provided by Bitnami: ```bash -helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk +helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk --version 14.2.4 ``` +{{< note success >}} +**Note** + +Please make sure you are installing PostgreSQL versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "tyk-dashboard/database-options" >}}). +{{< /note >}} + Follow the notes from the installation output to get connection details and update them in `values.yaml` file. Add the following configuration under the `global` section in `values.yaml`: diff --git a/tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md b/tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md index 3d965d0489..38a9819d0b 100644 --- a/tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md +++ b/tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md @@ -124,7 +124,7 @@ For Redis you can use these rather excellent charts provided by [Bitnami](https: Copy the following commands to add it: ```bash -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n tyk --create-namespace --install +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n tyk --create-namespace --install --version 19.0.2 ``` {{< note success >}} @@ -175,9 +175,15 @@ If not, you can use these rather excellent charts provided by Bitnami to install **Mongo Installation** ```bash -helm install tyk-mongo bitnami/mongodb --version {HELM_CHART_VERSION} --set "replicaSet.enabled=true" -n tyk +helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.2 ``` +{{< note success >}} +**Note** + +Bitnami MongoDB image is not supported on darwin/arm64 architecture. +{{< /note >}} + Then follow notes from the installation output to get connection details and update them in `values.yaml` file. {{< note success >}} @@ -221,7 +227,7 @@ global: **PostgresSQL Installation** ```bash -helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk +helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk --version 14.2.4 ``` Follow the notes from the installation output to get connection details. diff --git a/tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/distributed-tracing/open-telemetry/otel_jaeger_k8s.md b/tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/distributed-tracing/open-telemetry/otel_jaeger_k8s.md new file mode 100644 index 0000000000..036a5c657b --- /dev/null +++ b/tyk-docs/content/product-stack/tyk-gateway/advanced-configurations/distributed-tracing/open-telemetry/otel_jaeger_k8s.md @@ -0,0 +1,155 @@ +--- +date: 2023-08-29T13:32:12Z +title: How to integrate with Jaeger on Kubernetes +tags: ["distributed tracing", "OpenTelemetry", "Jaeger", "Kubernetes"] +description: "This guide explains how to integrate Tyk Gateway with OpenTelemetry and Jager on Kubernetes to enhance API Observability" +--- + +This quick start guide offers a detailed, step-by-step walkthrough for configuring Tyk Gateway OSS with OpenTelemetry and [Jaeger](https://www.jaegertracing.io/) on Kubernetes to significantly improve API observability. We will cover the installation of essential components, their configuration, and the process of ensuring seamless integration. + +For Docker instructions, please refer to [How to integrate with Jaeger on Docker]({{< ref "otel_jaeger" >}}). + + +## Prerequisites + +Ensure the following prerequisites are in place before proceeding: + +- A functional Kubernetes cluster +- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) and [helm](https://helm.sh/docs/intro/install/) CLI tools installed + +## Step 1: Install Jaeger Operator + +For the purpose of this tutorial, we will use jaeger-all-in-one, which includes the Jaeger agent, collector, query, and UI in a single pod with in-memory storage. This deployment is intended for development, testing, and demo purposes. Other deployment patterns can be found in the [Jaeger Operator documentation](https://www.jaegertracing.io/docs/1.51/operator/#deployment-strategies). + + +1. Install the cert-manager release manifest (required by Jaeger) + +```bash +kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.13.2/cert-manager.yaml +``` + +2. Install [Jaeger Operator](https://www.jaegertracing.io/docs/latest/operator/)). + +```bash +kubectl create namespace observability +kubectl create -f https://github.com/jaegertracing/jaeger-operator/releases/download/v1.51.0/jaeger-operator.yaml -n observability + +``` + +3. After the Jaeger Operator is deployed to the `observability` namespace, create a Jaeger instance: + +```bash +kubectl apply -n observability -f - <}} +**Note** + +Please make sure you are installing Redis versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "planning-for-production/redis" >}}). +{{< /note >}} + + +Tyk Gateway is now accessible through service gateway-svc-tyk-oss-tyk-gateway at port 8080 and exports the OpenTelemetry traces to the `jaeger-all-in-one-collector` service. + +## Step 3: Deploy Tyk Operator + +Deploy Tyk Operator to manage APIs in your cluster: + +```bash +kubectl create namespace tyk-operator-system +kubectl create secret -n tyk-operator-system generic tyk-operator-conf \ + --from-literal "TYK_AUTH=$APISecret" \ + --from-literal "TYK_ORG=org" \ + --from-literal "TYK_MODE=ce" \ + --from-literal "TYK_URL=http://gateway-svc-tyk-otel-tyk-gateway.tyk.svc:8080" \ + --from-literal "TYK_TLS_INSECURE_SKIP_VERIFY=true" +helm install tyk-operator tyk-helm/tyk-operator -n tyk-operator-system + +``` + +## Step 4: Deploy a Test API Definition + +Save the following API definition as `apidef-hello-world.yaml`: + +```yaml +apiVersion: tyk.tyk.io/v1alpha1 +kind: ApiDefinition +metadata: + name: hello-world +spec: + name: hello-world + use_keyless: true + protocol: http + active: true + proxy: + target_url: http://echo.tyk-demo.com:8080/ + listen_path: /hello-world + strip_listen_path: true +``` + +To apply this API definition, run the following command: + +```bash +kubectl apply -f apidef-hello-world.yaml +``` + +This step deploys an API definition named hello-world using the provided configuration. It enables a keyless HTTP API proxying requests to http://echo.tyk-demo.com:8080/ and accessible via the path /hello-world. + +## Step 5: Explore OpenTelemetry traces in Jaeger + +You can use the kubectl `port-forward command` to access Tyk and Jaeger services running in the cluster from your local machine's localhost: + +For Tyk API Gateway: + +```bash +kubectl port-forward service/gateway-svc-tyk-otel-tyk-gateway 8080:8080 -n tyk +``` + +For Jaeger: + +```bash +kubectl port-forward service/jaeger-all-in-one-query 16686 -n observability +``` + +Begin by sending a few requests to the API endpoint configured in step 2: + +```bash +curl http://localhost:8080/hello-world/ -i +``` + +Next, navigate to Jaeger on `http://localhost:16686`, select the ´service´ called ´tyk-gateway´ and click on the button ´Find traces´. You should see traces generated by Tyk: + +{{< img src="/img/distributed-tracing/opentelemetry/api-gateway-trace-tyk-jaeger.png" alt="Tyk API Gateway distributed trace in Jaeger" >}} + +Click on a trace to view all its internal spans: + +{{< img src="/img/distributed-tracing/opentelemetry/api-gateway-trace-tyk-jaeger-spans.png" alt="Tyk API Gateway spans in Jaeger" >}} + diff --git a/tyk-docs/content/product-stack/tyk-pump/advanced-configurations/setup-prometheus-pump.md b/tyk-docs/content/product-stack/tyk-pump/advanced-configurations/setup-prometheus-pump.md index 385b8cfe64..a005dc18dd 100644 --- a/tyk-docs/content/product-stack/tyk-pump/advanced-configurations/setup-prometheus-pump.md +++ b/tyk-docs/content/product-stack/tyk-pump/advanced-configurations/setup-prometheus-pump.md @@ -38,10 +38,11 @@ Also you can customise Prometheus Custom Metrics based on your analytics needs. ```bash NAMESPACE=tyk-oss APISecret=foo +REDIS_BITNAMI_CHART_VERSION=19.0.2 PromOperator_Release=prometheus-stack Prometheus_Custom_Metrics='[{"name":"tyk_http_requests_total"\,"description":"Total of API requests"\,"metric_type":"counter"\,"labels":["response_code"\,"api_name"\,"method"\,"api_key"\,"alias"\,"path"]}\, { "name":"tyk_http_latency"\, "description":"Latency of API requests"\, "metric_type":"histogram"\, "labels":["type"\,"response_code"\,"api_name"\,"method"\,"api_key"\,"alias"\,"path"] }]' -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --create-namespace --install --set image.tag=6.2.13 +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --create-namespace --install --version $REDIS_BITNAMI_CHART_VERSION helm upgrade tyk-oss tyk-helm/tyk-oss -n $NAMESPACE --create-namespace \ --install \ @@ -59,6 +60,12 @@ helm upgrade tyk-oss tyk-helm/tyk-oss -n $NAMESPACE --create-namespace \ {{< note success >}} **Note** +Please make sure you are installing Redis versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "planning-for-production/redis" >}}). +{{< /note >}} + +{{< note success >}} +**Note** + For Custom Metrics, commas are escaped to be used in helm --set command. You can remove the backslashes in front of the commas if you are to set it in values.yaml. We have included an example in the default values.yaml comments section. {{< /note >}} @@ -112,10 +119,11 @@ helm install prometheus prometheus-community/prometheus -n monitoring --create-n ```bash NAMESPACE=tyk-oss APISecret=foo +REDIS_BITNAMI_CHART_VERSION=19.0.2 PromOperator_Release=prometheus-stack Prometheus_Custom_Metrics='[{"name":"tyk_http_requests_total"\,"description":"Total of API requests"\,"metric_type":"counter"\,"labels":["response_code"\,"api_name"\,"method"\,"api_key"\,"alias"\,"path"]}\, { "name":"tyk_http_latency"\, "description":"Latency of API requests"\, "metric_type":"histogram"\, "labels":["type"\,"response_code"\,"api_name"\,"method"\,"api_key"\,"alias"\,"path"] }]' -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --create-namespace --install --set image.tag=6.2.13 +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --create-namespace --install --version $REDIS_BITNAMI_CHART_VERSION helm upgrade tyk-oss tyk-helm/tyk-oss -n $NAMESPACE --create-namespace \ --install \ @@ -131,6 +139,12 @@ helm upgrade tyk-oss tyk-helm/tyk-oss -n $NAMESPACE --create-namespace \ --set-string tyk-pump.pump.podAnnotations."prometheus\.io/path"=/metrics ``` +{{< note success >}} +**Note** + +Please make sure you are installing Redis versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "planning-for-production/redis" >}}). +{{< /note >}} + ### 3. Verification After some time, you can see that Prometheus is successfully scraping from Tyk Pump: diff --git a/tyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways-helm.md b/tyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways-helm.md index 45c72f893e..a1c2d76a5e 100644 --- a/tyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways-helm.md +++ b/tyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways-helm.md @@ -58,9 +58,15 @@ You can connect the gateway to any Redis instance already deployed (as DBaaS or In case you don't have a Redis instance yet, here's how to deploy Redis in Kubernetes using Bitnami Helm charts. ```bash -helm install tyk-redis bitnami/redis -n tyk --set image.tag=6.2.13 +helm install tyk-redis bitnami/redis -n tyk --version 19.0.2 ``` +{{< note success >}} +**Note** + +Please make sure you are installing Redis versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "planning-for-production/redis" >}}). +{{< /note >}} + Follow the notes from the installation output to get connection details and password. ```bash diff --git a/tyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways.md b/tyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways.md index 010c57b611..087412f81d 100644 --- a/tyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways.md +++ b/tyk-docs/content/tyk-cloud/environments-deployments/hybrid-gateways.md @@ -188,11 +188,12 @@ MDCB_GroupId=your-group-id ```bash NAMESPACE=tyk APISecret=foo +REDIS_BITNAMI_CHART_VERSION=19.0.2 helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/ helm repo update -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --create-namespace --install +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --create-namespace --install --version $REDIS_BITNAMI_CHART_VERSION helm upgrade hybrid-dp tyk-helm/tyk-mdcb-data-plane -n $NAMESPACE --create-namespace \ --install \ diff --git a/tyk-docs/content/tyk-oss/ce-helm-chart-new.md b/tyk-docs/content/tyk-oss/ce-helm-chart-new.md index fbcc1f28b0..60b7de37b8 100644 --- a/tyk-docs/content/tyk-oss/ce-helm-chart-new.md +++ b/tyk-docs/content/tyk-oss/ce-helm-chart-new.md @@ -24,11 +24,12 @@ Quick start using `tyk-oss` and Bitnami Redis chart ```bash NAMESPACE=tyk-oss APISecret=foo +REDIS_BITNAMI_CHART_VERSION=19.0.2 helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/ helm repo update -helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --install +helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --install --version $REDIS_BITNAMI_CHART_VERSION helm upgrade tyk-oss tyk-helm/tyk-oss -n $NAMESPACE --create-namespace \ --install \ diff --git a/tyk-docs/content/tyk-oss/ce-helm-chart.md b/tyk-docs/content/tyk-oss/ce-helm-chart.md index 0b42cd896a..662ed13333 100644 --- a/tyk-docs/content/tyk-oss/ce-helm-chart.md +++ b/tyk-docs/content/tyk-oss/ce-helm-chart.md @@ -72,9 +72,15 @@ Copy the following commands to add it: ```bash helm repo add bitnami https://charts.bitnami.com/bitnami -helm install tyk-redis bitnami/redis -n tyk --set image.tag=6.2.13 +helm install tyk-redis bitnami/redis -n tyk --version 19.0.2 ``` +{{< note success >}} +**Note** + +Please make sure you are installing Redis versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "planning-for-production/redis" >}}). +{{< /note >}} + Follow the notes from the installation output to get connection details and password. ``` diff --git a/tyk-docs/content/tyk-self-managed/tyk-helm-chart.md b/tyk-docs/content/tyk-self-managed/tyk-helm-chart.md index c2cae0b526..0ed83ab348 100644 --- a/tyk-docs/content/tyk-self-managed/tyk-helm-chart.md +++ b/tyk-docs/content/tyk-self-managed/tyk-helm-chart.md @@ -79,9 +79,15 @@ For Redis, MongoDB or SQL you can use these rather excellent charts provided by
#### Redis ```bash -helm install tyk-redis bitnami/redis -n tyk --set image.tag=6.2.13 +helm install tyk-redis bitnami/redis -n tyk --version 19.0.2 ``` +{{< note success >}} +**Note** + +Please make sure you are installing Redis versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "planning-for-production/redis" >}}). +{{< /note >}} + Follow the notes from the installation output to get connection details and password. ```console @@ -101,9 +107,13 @@ Alternatively, you can use `--set` flag to set it in Tyk installation. For examp
#### MongoDB ```bash -helm install tyk-mongo bitnami/mongodb --version {HELM_CHART_VERSION} --set "replicaSet.enabled=true" -n tyk +helm install tyk-mongo bitnami/mongodb --set "replicaSet.enabled=true" -n tyk --version 15.1.2 ``` -Replace `HELM_CHART_VERSION` with a helm chart version of our [supported Mongo versions]({{< ref "planning-for-production/database-settings/mongodb" >}}). +{{< note success >}} +**Note** + +Bitnami MongoDB images is not supported on darwin/arm64 architecture. +{{< /note >}} Follow the notes from the installation output to get connection details and password. The DNS name of your MongoDB as set with Bitnami is `tyk-mongo-mongodb.tyk.svc.cluster.local` and you also need to set the `authSource` parameter to `admin`. The full `mongoURL` should be similar to `mongoURL: mongodb://root:pass@tyk-mongo-mongodb.tyk.svc.cluster.local:27017/tyk_analytics?authSource=admin`. You can update them in your local `values.yaml` file under `mongo.mongoURL` Alternatively, you can use `--set` flag to set it in your Tyk installation. @@ -122,9 +132,15 @@ a minimum of 2 to remedy this issue.
#### Postgres ```bash -helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk +helm install tyk-postgres bitnami/postgresql --set "auth.database=tyk_analytics" -n tyk --version 14.2.4 ``` +{{< note success >}} +**Note** + +Please make sure you are installing PostgreSQL versions that are supported by Tyk. Please refer to Tyk docs to get list of [supported versions]({{< ref "tyk-dashboard/database-options" >}}). +{{< /note >}} + Follow the notes from the installation output to get connection details and password. The DNS name of your Postgres service as set by Bitnami is `tyk-postgres-postgresql.tyk.svc.cluster.local`. You can update connection details in `values.yaml` file under `postgres`. {{< tab_end >}}