Readme first release (#40)

* TT-8498, hybrid pump readme * Pre-release: update READMEs * Pre-release: removed comments * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md --------- Co-authored-by: caroltyk <[email protected]>
TykTechnologies · May 31, 2023 · 9003743 · 9003743
1 parent 8513464
commit 9003743
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 32 deletions.
diff --git a/components/tyk-gateway/README.md b/components/tyk-gateway/README.md
@@ -21,24 +21,16 @@ For typical usage, we recommend using following umbrella charts:
 * [Redis](https://tyk.io/docs/planning-for-production/redis/) should already be installed or accessible by the gateway 
 
 ## Installing the Chart
-<!--
+
 To install the chart from the Helm repository in namespace `tyk` with the release name `tyk-gateway`:
 
     helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
-    helm show values tyk-helm/tyk-gateway > values-gateway.yaml
-    helm install tyk-gateway tyk-helm/tyk-gateway -n tyk --create-namespace -f values-gateway.yaml
--->
-
-<!-- To be removed after the chart is published -->
-To install the chart from Git repository in namespace `tyk` with the release name `tyk-gateway`:
-
-    git clone https://github.com/TykTechnologies/tyk-charts.git
-    cd tyk-charts
-    helm show values tyk-gateway > values.yaml
+    helm repo update
+    helm show values tyk-helm/tyk-gateway > values.yaml
 
 Note: Set redis connection details first. See [Configuration](#configuration) below.
 
-    helm install tyk-gateway tyk-gateway -n tyk --create-namespace -f values.yaml
+    helm install tyk-gateway tyk-helm/tyk-gateway -n tyk --create-namespace -f values.yaml
 
 ## Uninstalling the Chart
 

diff --git a/components/tyk-pump/README.md b/components/tyk-pump/README.md
@@ -10,7 +10,7 @@ This chart deploys the open source Tyk pump on a [Kubernetes](https://kubernetes
 
 For typical usage, we recommend using following umbrella charts:
 * For Tyk Open Source, please use [tyk-oss](https://github.com/TykTechnologies/tyk-charts/tree/main/tyk-oss)
-* Coming soon: For Tyk Hybrid Gateway with Tyk Cloud, please use [tyk-hybrid-gateway](https://github.com/TykTechnologies/tyk-charts/tree/main/)
+* For Tyk Hybrid Gateway with Tyk Cloud or MDCB Remote Gateway, please use [tyk-mdcb-data-plane](https://github.com/TykTechnologies/tyk-charts/tree/main/tyk-mdcb-data-plane)
 * Coming soon: For Tyk Self-Managed, please use [tyk-self-managed](https://github.com/TykTechnologies/tyk-charts/tree/main/)
 
 [Learn more about different deployment options](https://tyk.io/docs/apim/)
@@ -21,17 +21,17 @@ For typical usage, we recommend using following umbrella charts:
 * [Redis](https://tyk.io/docs/planning-for-production/redis/)
 
 ## Installing the Chart
-To install the chart from Git repository in namespace `tyk` with the release name `tyk-pump`:
 
-```bash
-git clone https://github.com/TykTechnologies/tyk-charts.git
-cd tyk-charts
-helm show values tyk-pump > values.yaml
-helm install tyk-pump tyk-pump -n tyk --create-namespace -f values.yaml
-```
+To install the chart from the Helm repository in namespace `tyk` with the release name `tyk-pump`:
+
+    helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
+    helm repo update
+    helm show values tyk-helm/tyk-pump > values-pump.yaml
 
 Note: Set redis connection details first. See [Configuration](#configuration) below.
 
+    helm install tyk-pump tyk-helm/tyk-pump -n tyk --create-namespace -f values-pump.yaml
+
 ## Uninstalling the Chart
 
 ```bash
@@ -68,6 +68,7 @@ You may set `global.redis.addr` and `global.redis.pass` with redis connection st
 | Mongo Pump                | Add `mongo` to `pump.backend`, and add connection details for mongo under `.global.mongo`.                 |
 | SQL Pump                  | Add `postgres` to `.pump.backend`, and add connection details for postgres under `.global.postgres`.       |
 | Uptime Pump               | Set `pump.uptimePumpBackend` to `'mongo'` or `'postgres'` or `''`                                          |
+| Hybrid Pump               | Add `hybrid` to `.pump.backend`, and setup `.global.remoteControlPlane` section with the required adresses and tokens           |
 | Other Pumps               | Add the required environment variables in `pump.extraEnvs`                                                 |
 
 #### Prometheus Pump
@@ -140,6 +141,25 @@ Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml
 2. postgres: Used to set postgres pump for uptime analytics. Postgres Pump should be enabled.
 3. empty: Used to disable uptime analytics.
 
+#### Hybrid Pump
+
+```yaml
+  # Set remoteControlPlane connection details if you want to configure hybrid pump.
+  remoteControlPlane:
+      # connection string used to connect to an MDCB deployment. For Tyk Cloud users, you can get it from Tyk Cloud Console and retrieve the MDCB connection string.
+      connectionString: ""
+      # orgID of your dashboard user
+      orgId: ""
+      # API key of your dashboard user
+      userApiKey: ""
+      # needed in case you want to have multiple data-planes connected to the same redis instance
+      groupID: ""
+      # enable/disable ssl
+      useSSL: true
+      # Disables SSL certificate verification
+      sslInsecureSkipVerify: true
+```
+
 #### 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`
 
diff --git a/tyk-mdcb-data-plane/README.md b/tyk-mdcb-data-plane/README.md
@@ -24,12 +24,12 @@ Also, you can set the version of each component through `image.tag`. You could f
 
 ## Installing the Chart
 
-To install the chart from Git repository in namespace `tyk` with the release name `tyk-data-plane`:
+To install the chart from the Helm repository in namespace `tyk` with the release name `tyk-data-plane`:
+
+    helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
+    helm repo update
+    helm show values tyk-helm/tyk-mdcb-data-plane > values-data-plane.yaml
 
-    git clone https://github.com/TykTechnologies/tyk-charts.git
-    cd tyk-charts
-    helm dependency update tyk-mdcb-data-plane
-    helm show values tyk-mdcb-data-plane > values-data-plane.yaml
 
 
 Inside the values-data-plane.yaml you need to provide the following fields with their appropriate values:
@@ -54,7 +54,7 @@ global.remoteControlPlane.groupID: "test-group-id" (change this to something mea
 
 Then just run:
 
-    helm install tyk-data-plane tyk-mdcb-data-plane -n tyk --create-namespace -f values-data-plane.yaml
+    helm install tyk-data-plane tyk-helm/tyk-mdcb-data-plane -n tyk --create-namespace -f values-data-plane.yaml
 
 
 ## Uninstalling the Chart
@@ -122,6 +122,7 @@ To enable Pump, set `global.components.pump` to true, and configure below inside
 | 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
@@ -189,6 +190,25 @@ Uptime Pump can be configured by setting `pump.uptimePumpBackend` in values.yaml
 2. postgres: Used to set postgres pump for uptime analytics. Postgres Pump should be enabled.
 3. empty: Used to disable uptime analytics.
 
+#### Hybrid Pump
+
+```yaml
+  # Set remoteControlPlane connection details if you want to configure hybrid pump.
+  remoteControlPlane:
+      # connection string used to connect to an MDCB deployment. For Tyk Cloud users, you can get it from Tyk Cloud Console and retrieve the MDCB connection string.
+      connectionString: ""
+      # orgID of your dashboard user
+      orgId: ""
+      # API key of your dashboard user
+      userApiKey: ""
+      # needed in case you want to have multiple data-planes connected to the same redis instance
+      groupID: ""
+      # enable/disable ssl
+      useSSL: true
+      # Disables SSL certificate verification
+      sslInsecureSkipVerify: true
+```
+
 #### 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`
 

diff --git a/tyk-oss/README.md b/tyk-oss/README.md
@@ -23,16 +23,16 @@ Also, you can set the version of each component through `image.tag`. You could f
 
 ## Installing the Chart
 
-To install the chart from Git repository in namespace `tyk` with the release name `tyk-oss`:
+To install the chart from the Helm repository in namespace `tyk` with the release name `tyk-oss`:
+
+    helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
+    helm repo update
+    helm show values tyk-helm/tyk-oss > values-oss.yaml
 
-    git clone https://github.com/TykTechnologies/tyk-charts.git
-    cd tyk-charts
-    helm dependency update tyk-oss
-    helm show values tyk-oss > values-oss.yaml
 
 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-oss.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`
 
-    helm install tyk-oss tyk-oss -n tyk --create-namespace -f values-oss.yaml
+    helm install tyk-oss tyk-helm/tyk-oss -n tyk --create-namespace -f values-oss.yaml
 
 ## Uninstalling the Chart