From dfc807b3967cef49529668b471d2e4d09c8c553a Mon Sep 17 00:00:00 2001 From: caroltyk <97617859+caroltyk@users.noreply.github.com> Date: Wed, 31 May 2023 15:43:44 +0100 Subject: [PATCH] Update README.md (#41) * Update README.md * Update README.md --- tyk-mdcb-data-plane/README.md | 12 ++++++------ tyk-oss/README.md | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/tyk-mdcb-data-plane/README.md b/tyk-mdcb-data-plane/README.md index a39f0859..e51aad4a 100644 --- a/tyk-mdcb-data-plane/README.md +++ b/tyk-mdcb-data-plane/README.md @@ -20,7 +20,7 @@ Also, you can set the version of each component through `image.tag`. You could f * Kuberentes 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. +* 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). ## Installing the Chart @@ -33,7 +33,7 @@ To install the chart from the Helm repository in namespace `tyk` with the releas Inside the values-data-plane.yaml you need to provide the following fields with their appropriate values: -*If you use the bitnami chart for Redis installation, the DNS name of your Redis as set by Bitnami is `tyk-redis-master.tyk.svc.cluster.local:6379` You can update them in your local `values-data-plane.yaml` file under `global.redis.addr` and `global.redis.pass`. Alternatively, you can use `--set` flag to set it in Tyk installation. For example `--set global.redis.pass=$REDIS_PASSWORD` +If you use the bitnami chart for Redis installation, the DNS name of your Redis as set by Bitnami is `tyk-redis-master.tyk.svc.cluster.local:6379` You can update them in your local `values-data-plane.yaml` file under `global.redis.addr` and `global.redis.pass`. Alternatively, you can use `--set` flag to set it in Tyk installation. For example `--set global.redis.pass=$REDIS_PASSWORD` ```yaml global.remoteControlPlane.enabled: true @@ -79,12 +79,12 @@ To get all configurable options with detailed comments: You can update any value in your local `values.yaml` file and use `-f [filename]` flag to override default values during installation. Alternatively, you can use `--set` flag to set it in Tyk installation. -### Set Redis connection details (Required) +### Set Redis Connection Details (Required) -Tyk uses Redis for distributed rate-limiting and token storage. You may set `global.redis.addr` and `global.redis.pass` with redis connection +Tyk uses Redis for distributed rate-limiting and token storage. You may set `global.redis.addr` and `global.redis.pass` with Redis connection string and password respectively. -If you do not already have redis installed, you may use these charts provided by Bitnami +If you do not already have Redis installed, you may use these charts provided by Bitnami helm repo add bitnami https://charts.bitnami.com/bitnami helm install tyk-redis bitnami/redis -n tyk --create-namespace @@ -185,7 +185,7 @@ 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 support 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. diff --git a/tyk-oss/README.md b/tyk-oss/README.md index 48adec7b..5a4ac882 100644 --- a/tyk-oss/README.md +++ b/tyk-oss/README.md @@ -19,7 +19,7 @@ Also, you can set the version of each component through `image.tag`. You could f * Kuberentes 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. +* 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). ## Installing the Chart @@ -60,12 +60,12 @@ To get all configurable options with detailed comments: You can update any value in your local `values.yaml` file and use `-f [filename]` flag to override default values during installation. Alternatively, you can use `--set` flag to set it in Tyk installation. -### Set Redis connection details (Required) +### Set Redis Connection Details (Required) -Tyk uses Redis for distributed rate-limiting and token storage. You may set `global.redis.addr` and `global.redis.pass` with redis connection +Tyk uses Redis for distributed rate-limiting and token storage. You may set `global.redis.addr` and `global.redis.pass` with Redis connection string and password respectively. -If you do not already have redis installed, you may use these charts provided by Bitnami +If you do not already have Redis installed, you may use these charts provided by Bitnami helm repo add bitnami https://charts.bitnami.com/bitnami helm install tyk-redis bitnami/redis -n tyk --create-namespace @@ -171,7 +171,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 support 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.