Skip to content

Commit

Permalink
New IA - Migration to Tyk (#5823)
Browse files Browse the repository at this point in the history
(cherry picked from commit 8d08348)
  • Loading branch information
sharadregoti authored and Tyk Bot committed Jan 13, 2025
1 parent bba49ee commit 28055cd
Show file tree
Hide file tree
Showing 225 changed files with 10,751 additions and 12,400 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING-TECHNICAL-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ As an added value, you can specify the file path relative to the "content" folde
Example:

```
[Link title]({{< ref "apim/open-source" >}})
[Link title]({{< ref "tyk-open-source" >}})
```

### Images
Expand Down Expand Up @@ -194,19 +194,19 @@ The badge shortcode can be used in differing ways to populate the 3 grid types.
{{< grid >}}
{{< badge read="15 mins" href="/docs/tyk-cloud/" image="/docs/img/tyk-cloud.svg" >}}
{{< badge read="15 mins" href="/docs/migration-to-tyk#begin-with-tyk-cloud" image="/docs/img/tyk-cloud.svg" >}}
Sign up for our new, next level **SaaS** product.
{{< /badge >}}
{{< badge read="15 mins" href="/docs/getting-started/with-tyk-on-premises/installation/on-aws/" image="/docs/img/aws.png">}}
{{< badge read="15 mins" href="/docs/migration-to-tyk#install-via-aws-marketplace" image="/docs/img/aws.png">}}
Install our **On-Premises** product on AWS.
{{< /badge >}}
{{< badge read="10 mins" href="/docs/getting-started/installation/with-tyk-on-premises/docker/" image="/docs/img/docker.png">}}
{{< badge read="10 mins" href="migration-to-tyk#install-with-docker" image="/docs/img/docker.png">}}
Install our **On-Premises** product with Docker.
{{< /badge >}}
{{< badge read="10 mins" href="/docs/getting-started/installation/with-tyk-on-premises/kubernetes/" image="/docs/img/k8s.png">}}
{{< badge read="10 mins" href="/docs/migration-to-tyk#install-with-kubernetes" image="/docs/img/k8s.png">}}
Install our **On-Premises** product with Kubernetes.
{{< /badge >}}
Expand Down Expand Up @@ -248,7 +248,7 @@ The Tyk Pump is our open source analytics purger that moves the data generated b
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.
{{< /badge >}}
{{< badge href="/docs/getting-started/tyk-components/mdcb/" image="/docs/img/diagram.png" imageStyle="height:150px" >}}
{{< badge href="/docs/migration-to-tyk#implement-multi-data-centre-setup/" image="/docs/img/diagram.png" imageStyle="height:150px" >}}
**MDCB**
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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The Tyk Identity Broker (TIB) is an open-source project which can be used to int

## Step-by-step implementation guide

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" >}}).
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" >}}).

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can use sharding to very quickly publish an API from a `development` system

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

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.
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.

### Analytics and Reporting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ weight: 2

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.

Couple this functionality with the Tyk [Multi Data Center Bridge]({{< ref "tyk-multi-data-centre" >}}) to achieve a global, multi-cloud deployment.
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.

## Configure a Gateway as a shard

Expand Down
4 changes: 2 additions & 2 deletions tyk-docs/content/advanced-configuration/transform-traffic.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ Tyk's [API-level cache]({{< ref "basic-config-and-security/reduce-latency/cachin

### Circuit Breaker

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.
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.

### Do Not Track Endpoint

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.

### Enforced Timeout

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.
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.

### Ignore Authentication

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The **Core Settings** tab provides access to configure basic settings for the AP
- [API Categories]({{< ref "product-stack/tyk-dashboard/advanced-configurations/api-categories" >}})
- Upstream settings including
- Upstream service (target) URL
- [Service Discovery]({{< ref "planning-for-production/ensure-high-availability/service-discovery" >}})
- [Service Discovery]({{< ref "tyk-self-managed#service-discovery" >}})
- [API Ownership]({{< ref "product-stack/tyk-dashboard/advanced-configurations/user-management/api-ownership" >}})
- [API level rate limiting]({{< ref "basic-config-and-security/control-limit-traffic/rate-limiting#configuring-the-rate-limiter-at-the-api-level" >}})
- [Authentication]({{< ref "/api-management/client-authentication" >}})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The middleware has direct access to the response body and also to dynamic data a
- [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
- [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
- 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
- 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
- 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

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ In the response middleware chain, the endpoint-level transform is applied before
You can enrich the response headers by injecting data from context variables or session objects into the headers.
- [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
- [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
- 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
- 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

<hr>

Expand Down
7 changes: 4 additions & 3 deletions tyk-docs/content/api-management/automations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ linkTitle: Automation Tools
tags: ["Tyk API Management", "Open Source", "Self-Managed", "Tyk Cloud", "API Gateway"]
title: Automation Tools
aliases:
- /getting-started/key-concepts/gitops-with-tyk
- /advanced-configuration/manage-multiple-environments/tyk-sync
- /product-stack/tyk-operator/advanced-configurations/api-categories
- /product-stack/tyk-operator/advanced-configurations/api-versioning
Expand Down Expand Up @@ -69,7 +70,7 @@ In this guide, we’ll walk through the primary tools for automating API managem
Before diving into lifecycle automations with Tyk, ensure you have the following:

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

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

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

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

#### Install cert-manager
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/api-management/client-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -995,7 +995,7 @@ This guide will walk you through securing your APIs with JWTs via Keycloak.

#### Running in k8s

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" >}}).
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" >}}).


### Create Your JWT API in Tyk
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ Usage: Recommended for organizations already running Kubernetes and seeking a Ku

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

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.
Loading

0 comments on commit 28055cd

Please sign in to comment.