Skip to content

Commit

Permalink
fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
sharadregoti committed Dec 23, 2024
1 parent f16b194 commit 33d0360
Show file tree
Hide file tree
Showing 49 changed files with 150 additions and 157 deletions.
2 changes: 1 addition & 1 deletion 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 "migration-to-tyk#tyk-open-source" >}})
[Link title]({{< ref "#tyk-open-source" >}})
```

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

### 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 "migration-to-tyk#service-discovery" >}})
- [Service Discovery]({{< ref "#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 "migration-to-tyk#from-api-definitions" >}}) can be injected into the template using the notation appropriate to the location of the KV store
- values from [key-value (KV) storage]({{< ref "#from-api-definitions" >}}) 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 "migration-to-tyk#from-api-definitions" >}}) can be injected into added headers using the notation appropriate to the location of the KV store
- values from [key-value (KV) storage]({{< ref "#from-api-definitions" >}}) can be injected into added headers using the notation appropriate to the location of the KV store

<hr>

Expand Down
8 changes: 4 additions & 4 deletions tyk-docs/content/apim.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ components.
Choosing the right one for your organization depends on your specific requirements and preferences.
</br>Don’t hesitate to contact us for assistance {{< button_left href="https://tyk.io/contact/" color="green" content="Contact us" >}}

| | [Open Source]({{< ref "migration-to-tyk#tyk-open-source" >}}) | [Self-Managed]({{< ref "migration-to-tyk#configure-tyk-self-managed" >}}) | [Cloud](https://account.cloud-ara.tyk.io/signup)
| | [Open Source]({{< ref "#tyk-open-source" >}}) | [Self-Managed]({{< ref "#configure-tyk-self-managed" >}}) | [Cloud](https://account.cloud-ara.tyk.io/signup)
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------------|---------
| API Gateway Capabilities <br> <ul><li>Rate Limiting</li><li>Authentication</li> <li>API Versioning</li><li>Granular Access Control</li><li>GraphQL</li> <li>and [much more]({{< ref "migration-to-tyk#tyk-open-source" >}})</li></ul> | ✅ |✅ |✅
| API Gateway Capabilities <br> <ul><li>Rate Limiting</li><li>Authentication</li> <li>API Versioning</li><li>Granular Access Control</li><li>GraphQL</li> <li>and [much more]({{< ref "#tyk-open-source" >}})</li></ul> | ✅ |✅ |✅
| [Version Control]({{< ref "/api-management/automations#synchronize-tyk-environment-with-github-repository" >}}) Integration | - |✅ |✅
| [API Analytics Exporter]({{< ref "tyk-pump" >}}) | ✅ |✅ |✅
| [Tyk Dashboard]({{< ref "tyk-dashboard" >}}) | - |✅ |✅
| [Single Sign On (SSO)]({{< ref "advanced-configuration/integrate/sso" >}}) | - |✅ |✅
| [RBAC and API Teams]({{< ref "tyk-dashboard/rbac" >}}) | - |✅ |✅
| [Universal Data Graph]({{< ref "universal-data-graph" >}}) | - |✅ |✅
| [Multi-Tenant]({{< ref "basic-config-and-security/security/dashboard/organisations" >}}) | - |✅ |✅
| [Multi-Data Center]({{< ref "migration-to-tyk#setup-mdcb-control-plane" >}}) | - |✅ |✅
| [Multi-Data Center]({{< ref "#setup-mdcb-control-plane" >}}) | - |✅ |✅
| [Developer Portal]({{< ref "tyk-developer-portal" >}}) | - |✅ |✅
| [Developer API Analytics]({{< ref "tyk-dashboard-analytics" >}}) | - |✅ |✅
| Hybrid Deployments | - |- |✅
Expand All @@ -42,7 +42,7 @@ With Tyk Cloud, all of the above closed-source components are available. Get you

### Open Source (OSS)
The Tyk Gateway is the backbone of all our solutions and can be deployed for free, forever.
Visit the [OSS section]({{< ref "migration-to-tyk#tyk-open-source" >}}) for more information on it and other open source components.
Visit the [OSS section]({{< ref "#tyk-open-source" >}}) for more information on it and other open source components.

Explore the various open and closed source [Tyk components]({{< ref "tyk-stack" >}}) that are part of the Tyk platform
solutions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ For example:
}
```

The configuration of the separate Redis Cache is the same (and uses the same underlying driver) as the regular configuration, so [Redis Cluster]({{< ref "migration-to-tyk#configure-redis-cluster">}}) is fully supported. If you set `enable_cluster` to `false`, you only need to set one entry in `addrs`.
The configuration of the separate Redis Cache is the same (and uses the same underlying driver) as the regular configuration, so [Redis Cluster]({{< ref "#configure-redis-cluster">}}) is fully supported. If you set `enable_cluster` to `false`, you only need to set one entry in `addrs`.

{{< note success >}}
**Note**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When Tyk generates an [event]({{< ref "basic-config-and-security/report-monitor-
{{< note success >}}
**Note**

Circuit breaker events provide different metadata, see [Circuit Breakers]({{< ref "migration-to-tyk#circuit-breakers" >}}) to see what is provided when the `BreakerTripped`, `BreakerReset` or `BreakerTriggered` events are generated.
Circuit breaker events provide different metadata, see [Circuit Breakers]({{< ref "#circuit-breakers" >}}) to see what is provided when the `BreakerTripped`, `BreakerReset` or `BreakerTriggered` events are generated.
{{< /note >}}

### Using the metadata
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The concept of an organization does not exist within the Tyk Gateway. Gateways o

Tyk allows each organization to own its own set of Gateways, for example when you want to use different hosting providers you can segregate them in terms of resources, or just for security reasons.

Self-Managed users should use [API tagging]({{< ref "migration-to-tyk#configure-tyk-self-managed" >}}) and enforce a tagging standard across all organizations.
Self-Managed users should use [API tagging]({{< ref "#configure-tyk-self-managed" >}}) and enforce a tagging standard across all organizations.

All actions in a Self-Managed installation of Tyk must use a base Organization, and all actions should stem from a User owned by that organization.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ menu:
weight: 4
---

The Tyk Gateway is the main component that will be internet-facing in your installation since it manages the traffic through to your services. The Gateway has a command and control API that must be secured, using a [shared secret]({{< ref "migration-to-tyk#change-all-the-shared-secrets" >}}).
The Tyk Gateway is the main component that will be internet-facing in your installation since it manages the traffic through to your services. The Gateway has a command and control API that must be secured, using a [shared secret]({{< ref "#change-all-the-shared-secrets" >}}).

Although the Gateway has an API, it is recommended to integrate with the Dashboard API as this is more secure and more granular.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ Next, [add your first API to Tyk ]({{< ref "getting-started/create-api" >}}) and

## Kubernetes

This pages has shown the fasted way to get up and running with Tyk Open Source. If you are interested in deploying Tyk stack on a Kubernetes cluster please use our [Helm Charts]{{< ref "migration-to-tyk#quick-start-with-helm-chart">}}
This pages has shown the fasted way to get up and running with Tyk Open Source. If you are interested in deploying Tyk stack on a Kubernetes cluster please use our [Helm Charts]{{< ref "#quick-start-with-helm-chart">}}
2 changes: 1 addition & 1 deletion tyk-docs/content/developer-support/release-notes/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ There are no deprecations in this release

#### Release Highlights

This Tyk Cloud update introduces features that improve both flexibility in plugin management and user onboarding. Now, [Mserv]({{< ref "migration-to-tyk#uploading-your-bundle" >}}), supports **multiple plugin bundles**, allowing greater customization and easier deployment of plugin configurations. Additionally, we added an **embedded product tour** to enhance the deployment experience, offering a guided walkthrough of Tyk Dashboard’s features, ideal for users familiarizing themselves with the platform during onboarding.
This Tyk Cloud update introduces features that improve both flexibility in plugin management and user onboarding. Now, [Mserv]({{< ref "#uploading-your-bundle" >}}), supports **multiple plugin bundles**, allowing greater customization and easier deployment of plugin configurations. Additionally, we added an **embedded product tour** to enhance the deployment experience, offering a guided walkthrough of Tyk Dashboard’s features, ideal for users familiarizing themselves with the platform during onboarding.

For a comprehensive list of improvements and fixes, please check the detailed [changelog]({{< ref "#Changelog-v1.23.0">}}) below.

Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/getting-started/create-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To reach a detailed guide to creating Tyk API Definitions, please choose the tab
Tyk Cloud is a fully managed service that makes it easy for API teams to create, secure, publish and maintain APIs at any scale, anywhere in the world. Tyk Cloud includes everything you need to manage your global API ecosystem: [Tyk Gateways]({{< ref "tyk-oss-gateway" >}}), [Tyk Dashboard]({{< ref "tyk-dashboard" >}}), [Tyk Developer Portal]({{< ref "tyk-developer-portal" >}}) and [Universal Data Graph]({{< ref "universal-data-graph" >}}).
<br>

To embark on your API journey with Tyk Cloud, we recommend going to our [Quick Start guide]({{< ref "/migration-to-tyk#" >}}). This guide will walk you through the process of creating your very first API in Tyk Cloud.
To embark on your API journey with Tyk Cloud, we recommend going to our [Quick Start guide]({{< ref "#" >}}). This guide will walk you through the process of creating your very first API in Tyk Cloud.
For an advanced step by step guide we recommend visiting our [Getting Started guide]({{< ref "/tyk-cloud/getting-started" >}}). This will explain advanced configuration steps relating to how to distribute your API across nodes, in addition to adding and testing your API.

{{< tab_end >}}
Expand Down
2 changes: 1 addition & 1 deletion tyk-docs/content/key-concepts/grpc-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ After setting your Tyk configuration, all you need to do is to send a token in a

### gRPC load balancing

Tyk is able to perform load balancing on gRPC traffic using an approach similar to our native [Load Balancing]({{< ref "migration-to-tyk#load-balancing" >}}) functionality.
Tyk is able to perform load balancing on gRPC traffic using an approach similar to our native [Load Balancing]({{< ref "#load-balancing" >}}) functionality.

For both secure and insecure gRPC scenarios, the steps above serve as a starting point.

Expand Down
Loading

0 comments on commit 33d0360

Please sign in to comment.