Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update MDCB Data plane doc #94

Merged
merged 1 commit into from
Aug 10, 2023
Merged

Update MDCB Data plane doc #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions tyk-mdcb-data-plane/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

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

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