Skip to content

Commit

Permalink
Update README.md (#41)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md
  • Loading branch information
caroltyk authored May 31, 2023
1 parent 9003743 commit dfc807b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
12 changes: 6 additions & 6 deletions tyk-mdcb-data-plane/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
10 changes: 5 additions & 5 deletions tyk-oss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit dfc807b

Please sign in to comment.