From f999ca9f486d096f192fb3ac83fa69ff22732ca6 Mon Sep 17 00:00:00 2001 From: Burak Sekili Date: Thu, 10 Aug 2023 15:10:42 +0300 Subject: [PATCH] Update README.md --- tyk-mdcb-data-plane/README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/tyk-mdcb-data-plane/README.md b/tyk-mdcb-data-plane/README.md index 28cedb93..7f8e3b01 100644 --- a/tyk-mdcb-data-plane/README.md +++ b/tyk-mdcb-data-plane/README.md @@ -1,6 +1,6 @@ ## Tyk MDCB Data Plane -Tyk-mdcb-data-plane provides the default deployment of a Tyk data plane for Tyk Self Managed MDCB or Tyk Cloud users. It will deploy the data plane components that remotely connect to a MDCB control plane. +`tyk-mdcb-data-plane` provides the default deployment of a Tyk data plane for Tyk Self Managed MDCB or Tyk Cloud users. It will deploy the data plane components that remotely connect to a MDCB control plane. It includes the Tyk Gateway, an open source Enterprise API Gateway, supporting REST, GraphQL, TCP and gRPC protocols; and Tyk Pump, an analytics purger that moves the data generated by your Tyk gateways to any back-end. Furthermore, it has all the required modifications to easily connect to Tyk Cloud or Multi Data Center (MDCB) control plane. @@ -10,8 +10,8 @@ By default, this chart installs following components as subcharts on a [Kubernet | Component | Enabled by Default | Flag | | --------- | ------------------ | ---- | -|Tyk Gateway |true | n/a | -|Tyk Pump |true | global.components.pump | +| Tyk Gateway |true | n/a | +| Tyk Pump |true | `global.components.pump` | To enable or disable each component, change the corresponding enabled flag. @@ -69,16 +69,16 @@ You can easily obtain your remote control plane connection details on Tyk Cloud. To install the chart from the Helm repository in namespace `tyk` with the release name `tyk-data-plane`: -```bash``` - 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 +```bash +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 ``` See [Configuration](#configuration) section for the available config options and modify your local `values-data-plane.yaml` file accordingly. Then install the chart: ```bash - helm install tyk-data-plane tyk-helm/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 @@ -104,7 +104,7 @@ If you were using `tyk-hybrid` chart for existing release, you cannot upgrade di To get all configurable options with detailed comments: ```bash - helm show values tyk-helm/tyk-mdcb-data-plane > values.yaml +helm show values tyk-helm/tyk-mdcb-data-plane > values.yaml ``` You can update any value in your local `values.yaml` file and use `-f [filename]` flag to override default values during installation.