Skip to content

Commit 8d08348

Browse files
authored
New IA - Migration to Tyk (#5823)
1 parent ea2a69b commit 8d08348

File tree

225 files changed

+10751
-12400
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

225 files changed

+10751
-12400
lines changed

CONTRIBUTING-TECHNICAL-GUIDE.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ As an added value, you can specify the file path relative to the "content" folde
125125
Example:
126126

127127
```
128-
[Link title]({{< ref "apim/open-source" >}})
128+
[Link title]({{< ref "tyk-open-source" >}})
129129
```
130130

131131
### Images
@@ -194,19 +194,19 @@ The badge shortcode can be used in differing ways to populate the 3 grid types.
194194
195195
{{< grid >}}
196196
197-
{{< badge read="15 mins" href="/docs/tyk-cloud/" image="/docs/img/tyk-cloud.svg" >}}
197+
{{< badge read="15 mins" href="/docs/migration-to-tyk#begin-with-tyk-cloud" image="/docs/img/tyk-cloud.svg" >}}
198198
Sign up for our new, next level **SaaS** product.
199199
{{< /badge >}}
200200
201-
{{< badge read="15 mins" href="/docs/getting-started/with-tyk-on-premises/installation/on-aws/" image="/docs/img/aws.png">}}
201+
{{< badge read="15 mins" href="/docs/migration-to-tyk#install-via-aws-marketplace" image="/docs/img/aws.png">}}
202202
Install our **On-Premises** product on AWS.
203203
{{< /badge >}}
204204
205-
{{< badge read="10 mins" href="/docs/getting-started/installation/with-tyk-on-premises/docker/" image="/docs/img/docker.png">}}
205+
{{< badge read="10 mins" href="migration-to-tyk#install-with-docker" image="/docs/img/docker.png">}}
206206
Install our **On-Premises** product with Docker.
207207
{{< /badge >}}
208208
209-
{{< badge read="10 mins" href="/docs/getting-started/installation/with-tyk-on-premises/kubernetes/" image="/docs/img/k8s.png">}}
209+
{{< badge read="10 mins" href="/docs/migration-to-tyk#install-with-kubernetes" image="/docs/img/k8s.png">}}
210210
Install our **On-Premises** product with Kubernetes.
211211
{{< /badge >}}
212212
@@ -248,7 +248,7 @@ The Tyk Pump is our open source analytics purger that moves the data generated b
248248
The Tyk Developer Portal is a small CMS-like system that enables you to expose a facade of your APIs and then allow third-party developers to register and use your APIs.
249249
{{< /badge >}}
250250
251-
{{< badge href="/docs/getting-started/tyk-components/mdcb/" image="/docs/img/diagram.png" imageStyle="height:150px" >}}
251+
{{< badge href="/docs/migration-to-tyk#implement-multi-data-centre-setup/" image="/docs/img/diagram.png" imageStyle="height:150px" >}}
252252
**MDCB**
253253
254254
The Multi Data Center Bridge allows for centralised management of multiple independent Tyk clusters and the seamless transition of APIs between environments, availability zones and segmented nodes.

tyk-docs/content/advanced-configuration/integrate/3rd-party-identity-providers/dashboard-login-ldap-tib.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The Tyk Identity Broker (TIB) is an open-source project which can be used to int
3333

3434
## Step-by-step implementation guide
3535

36-
This guide assumes you already have a Tyk environment set up, with a Gateway and Dashboard. If you don't, please follow the [Tyk Self-Managed getting started guide]({{< ref "tyk-self-managed/install" >}}).
36+
This guide assumes you already have a Tyk environment set up, with a Gateway and Dashboard. If you don't, please follow the [Tyk Self-Managed getting started guide]({{< ref "tyk-self-managed#installation-options-for-tyk-self-managed" >}}).
3737

3838
The environment used for this guide is, for simplicity's sake, all contained on a single host running Ubuntu 14.04. The hostname `my-tyk-instance.com` has been set to point at `127.0.0.1`. For production environments it is recommended that each component is hosted separately and appropriate security measures are used such as HTTPS to secure connections.
3939

tyk-docs/content/advanced-configuration/manage-multiple-environments.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You can use sharding to very quickly publish an API from a `development` system
3131

3232
With Tyk Community Edition and Tyk Pro, these clusters must all share the same Redis DB.
3333

34-
If you are an Enterprise user, then you can go a step further and use the [Tyk Multi Data Center Bridge]({{< ref "tyk-multi-data-centre" >}}) to have full multi-DC, multi-zone cluster segmentation, and manage APIs in different segments across different database back-ends.
34+
If you are an Enterprise user, then you can go a step further and use the [Tyk Multi Data Center Bridge]({{< ref "tyk-multi-data-centre#managing-geographically-distributed-gateways-to-minimize-latency-and-protect-data-sovereignty" >}}) to have full multi-DC, multi-zone cluster segmentation, and manage APIs in different segments across different database back-ends.
3535

3636
### Analytics and Reporting
3737

tyk-docs/content/advanced-configuration/manage-multiple-environments/with-tyk-multi-cloud.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ weight: 2
1212

1313
With Tyk, it is easy to enable a sharded configuration, you can deploy Gateways which selectively load APIs. This unlocks abilities to run Gateways in multiple zones, all connected to the same Control Plane. This allows for GDPR deployments, development/test Gateways, or even DMZ/NON-DMZ Gateways.
1414

15-
Couple this functionality with the Tyk [Multi Data Center Bridge]({{< ref "tyk-multi-data-centre" >}}) to achieve a global, multi-cloud deployment.
15+
Couple this functionality with the Tyk [Multi Data Center Bridge]({{< ref "tyk-multi-data-centre#managing-geographically-distributed-gateways-to-minimize-latency-and-protect-data-sovereignty" >}}) to achieve a global, multi-cloud deployment.
1616

1717
## Configure a Gateway as a shard
1818

tyk-docs/content/advanced-configuration/transform-traffic.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ Tyk's [API-level cache]({{< ref "basic-config-and-security/reduce-latency/cachin
3434

3535
### Circuit Breaker
3636

37-
The [Circuit Breaker]({{< ref "planning-for-production/ensure-high-availability/circuit-breakers" >}}) is a protective mechanism that helps to maintain system stability by preventing repeated failures and overloading of services that are erroring. When a network or service failure occurs, the circuit breaker prevents further calls to that service, allowing the affected service time to recover while ensuring that the overall system remains functional.
37+
The [Circuit Breaker]({{< ref "tyk-self-managed#circuit-breakers" >}}) is a protective mechanism that helps to maintain system stability by preventing repeated failures and overloading of services that are erroring. When a network or service failure occurs, the circuit breaker prevents further calls to that service, allowing the affected service time to recover while ensuring that the overall system remains functional.
3838

3939
### Do Not Track Endpoint
4040

4141
If [traffic logging]({{< ref "product-stack/tyk-gateway/basic-config-and-security/logging-api-traffic/logging-api-traffic" >}}) is enabled for your Tyk Gateway, then it will create transaction logs for all API requests (and responses) to deployed APIs. You can use the [Do-Not-Track]({{< ref "product-stack/tyk-gateway/middleware/do-not-track-middleware" >}}) middleware to suppress creation of transaction records for specific endpoints.
4242

4343
### Enforced Timeout
4444

45-
Tyk’s [Enforced Timeout]({{< ref "planning-for-production/ensure-high-availability/enforced-timeouts" >}}) middleware can be used to apply a maximum time that the Gateway will wait for a response before it terminates (or times out) the request. This helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system.
45+
Tyk’s [Enforced Timeout]({{< ref "tyk-self-managed#circuit-breakers" >}}) middleware can be used to apply a maximum time that the Gateway will wait for a response before it terminates (or times out) the request. This helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system.
4646

4747
### Ignore Authentication
4848

tyk-docs/content/advanced-configuration/transform-traffic/endpoint-designer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The **Core Settings** tab provides access to configure basic settings for the AP
2222
- [API Categories]({{< ref "product-stack/tyk-dashboard/advanced-configurations/api-categories" >}})
2323
- Upstream settings including
2424
- Upstream service (target) URL
25-
- [Service Discovery]({{< ref "planning-for-production/ensure-high-availability/service-discovery" >}})
25+
- [Service Discovery]({{< ref "tyk-self-managed#service-discovery" >}})
2626
- [API Ownership]({{< ref "product-stack/tyk-dashboard/advanced-configurations/user-management/api-ownership" >}})
2727
- [API level rate limiting]({{< ref "basic-config-and-security/control-limit-traffic/rate-limiting#configuring-the-rate-limiter-at-the-api-level" >}})
2828
- [Authentication]({{< ref "/api-management/client-authentication" >}})

tyk-docs/content/advanced-configuration/transform-traffic/response-body.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The middleware has direct access to the response body and also to dynamic data a
5555
- [Context variables]({{< ref "context-variables" >}}), extracted from the request at the start of the middleware chain, can be injected into the template using the `._tyk_context.KEYNAME` namespace
5656
- [Session metadata]({{< ref "getting-started/key-concepts/session-meta-data" >}}), from the Tyk Session Object linked to the request, can be injected into the template using the `._tyk_meta.KEYNAME` namespace
5757
- Inbound form or query data can be accessed through the `._tyk_context.request_data` namespace where it will be available in as a `key:[]value` map
58-
- values from [key-value (KV) storage]({{< ref "tyk-configuration-reference/kv-store#transformation-middleware" >}}) can be injected into the template using the notation appropriate to the location of the KV store
58+
- values from [key-value (KV) storage]({{< ref "tyk-self-managed#transformation-middleware" >}}) can be injected into the template using the notation appropriate to the location of the KV store
5959

6060
The response body transform middleware can iterate through list indices in dynamic data so, for example, calling `{{ index ._tyk_context.request_data.variablename 0 }}` in a template will expose the first entry in the `request_data.variablename` key/value array.
6161

tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ In the response middleware chain, the endpoint-level transform is applied before
5050
You can enrich the response headers by injecting data from context variables or session objects into the headers.
5151
- [context variables]({{< ref "context-variables" >}}), extracted from the request at the start of the middleware chain, can be injected into added headers using the `$tyk_context.` namespace
5252
- [session metadata]({{< ref "getting-started/key-concepts/session-meta-data" >}}), from the Tyk Session Object linked to the request, can be injected into added headers using the `$tyk_meta.` namespace
53-
- values from [key-value (KV) storage]({{< ref "tyk-configuration-reference/kv-store#transformation-middleware" >}}) can be injected into added headers using the notation appropriate to the location of the KV store
53+
- values from [key-value (KV) storage]({{< ref "tyk-self-managed#transformation-middleware" >}}) can be injected into added headers using the notation appropriate to the location of the KV store
5454

5555
<hr>
5656

tyk-docs/content/api-management/automations.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ linkTitle: Automation Tools
44
tags: ["Tyk API Management", "Open Source", "Self-Managed", "Tyk Cloud", "API Gateway"]
55
title: Automation Tools
66
aliases:
7+
- /getting-started/key-concepts/gitops-with-tyk
78
- /advanced-configuration/manage-multiple-environments/tyk-sync
89
- /product-stack/tyk-operator/advanced-configurations/api-categories
910
- /product-stack/tyk-operator/advanced-configurations/api-versioning
@@ -69,7 +70,7 @@ In this guide, we’ll walk through the primary tools for automating API managem
6970
Before diving into lifecycle automations with Tyk, ensure you have the following:
7071

7172
- **A Tyk installation** (Self-Managed or Cloud)
72-
- If you don't have Tyk installed, follow our [installation guide]({{<ref "tyk-self-managed/install">}})
73+
- If you don't have Tyk installed, follow our [installation guide]({{<ref "tyk-self-managed#installation-options-for-tyk-self-managed">}})
7374
- For Tyk Cloud, sign up [here](https://tyk.io/sign-up/)
7475
- Tyk Operator license key. Starting from Tyk Operator v1.0, a valid license key is required.
7576

@@ -300,7 +301,7 @@ To address this challenge, Tyk Operator allows you to directly reference certifi
300301
### Install and Configure Tyk Operator
301302

302303
We assume you have already installed Tyk. If you don’t have it, check out [Tyk
303-
Cloud]({{<ref "/deployment-and-operations/tyk-cloud-platform/quick-start">}}) or [Tyk Self
304+
Cloud]({{<ref "tyk-cloud#quick-start-tyk-cloud">}}) or [Tyk Self
304305
Managed]({{<ref "/getting-started/installation">}}) page. [Tyk Helm
305306
Chart]({{<ref "/product-stack/tyk-charts/overview">}}) is the preferred (and easiest) way to install Tyk on Kubernetes.
306307

@@ -310,7 +311,7 @@ In order for policy ID matching to work correctly, Dashboard must have `allow_ex
310311
Tyk Operator needs a [user credential]({{< ref "#operator-user" >}}) to connect with
311312
Tyk Dashboard. The Operator user should have write access to the resources it is going to manage, e.g. APIs, Certificates,
312313
Policies, and Portal. It is the recommended practice to turn off write access for other users for the above resources. See
313-
[Using Tyk Operator to enable GitOps with Tyk]({{< ref "getting-started/key-concepts/gitops-with-tyk" >}}) about
314+
[Using Tyk Operator to enable GitOps with Tyk]({{< ref "api-management/automations" >}}) about
314315
maintaining a single source of truth for your API configurations.
315316

316317
#### Install cert-manager

tyk-docs/content/api-management/client-authentication.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -995,7 +995,7 @@ This guide will walk you through securing your APIs with JWTs via Keycloak.
995995

996996
#### Running in k8s
997997

998-
If you are looking to POC this functionality in Kubernetes, you can run a fully worked-out example using our tyk-k8s-demo library. You can read more [here]({{< ref "getting-started/quick-start/tyk-k8s-demo" >}}).
998+
If you are looking to POC this functionality in Kubernetes, you can run a fully worked-out example using our tyk-k8s-demo library. You can read more [here]({{< ref "tyk-self-managed#kubernetes-demo" >}}).
999999

10001000

10011001
### Create Your JWT API in Tyk

tyk-docs/content/api-management/manage-apis/deploy-apis/deploy-apis-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,6 @@ Usage: Recommended for organizations already running Kubernetes and seeking a Ku
5252

5353
Learn more:
5454
- [Tyk Operator]({{<ref "/api-management/automations#what-is-tyk-operator">}})
55-
- [Using Tyk Operator to enable GitOps with Tyk]({{<ref "getting-started/key-concepts/gitops-with-tyk">}})
55+
- [Using Tyk Operator to enable GitOps with Tyk]({{<ref "api-management/automations">}})
5656

5757
With these flexible deployment options, you can easily design, develop, and deploy APIs in Tyk according to your specific requirements and workflow. Choose the option that best aligns with your needs and integrates smoothly into your API development lifecycle.

0 commit comments

Comments
 (0)