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.

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

New IA - Migration to Tyk #5823

Open
wants to merge 72 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
66fb552
update migration to tyk
DavidRollins Nov 16, 2024
192b7d9
save progress
DavidRollins Nov 17, 2024
57d054c
Save progress
DavidRollins Nov 18, 2024
659b84e
Save progress
DavidRollins Nov 18, 2024
7fe2b3d
update migration to tyk
DavidRollins Nov 18, 2024
ac06ea0
update migration to tyk
DavidRollins Nov 18, 2024
4f84228
update
DavidRollins Nov 18, 2024
12013a2
update
DavidRollins Nov 18, 2024
a350d39
update
DavidRollins Nov 18, 2024
96e6764
update
DavidRollins Nov 19, 2024
d533a10
fix pipeline
DavidRollins Nov 22, 2024
8c6628f
fix pipeline
DavidRollins Nov 22, 2024
7afc7a3
try one more time with this link
DavidRollins Nov 22, 2024
35a9206
remove private spaces link
DavidRollins Nov 22, 2024
0c59aca
[DX-1770]add internal hash validation (#5725)
yurisasuke Nov 18, 2024
a5127fd
[DX-1769] preserve section in aliases redirection (#5724)
yurisasuke Nov 18, 2024
a6459bd
[DX-1771]Update docs with deprecation advice (#5729)
Eopayemi Nov 19, 2024
e3eabf7
TT-8252 Aurora Postgresql support (#5715)
caroltyk Nov 19, 2024
f645630
Adding docs for EDP PORTAL_RESPONSE_HEADERS (#5736)
tbuchaillot Nov 20, 2024
db1a0de
Docs Fixes (#5735)
sharadregoti Nov 21, 2024
882268e
DX-1773 EDP Adding PORTAL_DISABLE_CSRF_CHECK config (#5744)
tbuchaillot Nov 22, 2024
3cbf877
update links after merge
DavidRollins Nov 22, 2024
3473fcb
update links after merge
DavidRollins Nov 22, 2024
8bc58f2
update links after merge
DavidRollins Nov 22, 2024
750e992
update links after merge
DavidRollins Nov 22, 2024
59c21da
update migration page to fix heading structure
DavidRollins Nov 22, 2024
0701ae1
fix aliases and delete their redundant pages
DavidRollins Nov 22, 2024
b338eb1
stash changes for merge
DavidRollins Nov 23, 2024
e6d5f5e
merge
DavidRollins Nov 23, 2024
af30ab0
update alias.json to see if that fixes linking
DavidRollins Nov 23, 2024
cb42172
update links to files we deleted
DavidRollins Nov 23, 2024
c649e05
fixing broken string
DavidRollins Nov 23, 2024
24bcc0f
fixing broken string
DavidRollins Nov 23, 2024
d1a7180
fixing broken string
DavidRollins Nov 23, 2024
547fcf2
fixing broken string
DavidRollins Nov 23, 2024
8109a65
update menu.yaml
DavidRollins Nov 23, 2024
4de0305
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
3eff5bc
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
c224d20
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
d697f0e
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
7b2cca8
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
460c245
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
5c4c1f5
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
186f455
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
05262b8
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
2718535
update internal links in migration page - save progress
DavidRollins Nov 23, 2024
018a160
update the menu yaml
DavidRollins Nov 23, 2024
68ba7a5
update the menu yaml
DavidRollins Nov 23, 2024
6f178ce
update the menu yaml
DavidRollins Nov 23, 2024
c6ee7f4
update the menu yaml
DavidRollins Nov 23, 2024
fec2974
update the menu yaml
DavidRollins Nov 23, 2024
54fa3ca
update the menu yaml
DavidRollins Nov 23, 2024
8bd2658
update the menu yaml
DavidRollins Nov 23, 2024
6d61c05
update the menu yaml
DavidRollins Nov 23, 2024
1b42315
update the menu yaml
DavidRollins Nov 23, 2024
9599caf
update the menu yaml
DavidRollins Nov 23, 2024
e6c17eb
update the menu yaml
DavidRollins Nov 23, 2024
8391b8c
update the menu yaml
DavidRollins Nov 23, 2024
27c07aa
update the links
DavidRollins Nov 23, 2024
7cc97c7
update the links
DavidRollins Nov 23, 2024
b73e7e3
update the links
DavidRollins Nov 23, 2024
4f69b4c
update the links
DavidRollins Nov 23, 2024
ac7386f
update the links
DavidRollins Nov 23, 2024
c21c0d6
update the links
DavidRollins Nov 23, 2024
1245123
update the links
DavidRollins Nov 23, 2024
0add7e3
update menu.yaml for deleted pages
DavidRollins Nov 23, 2024
4fbda03
Initial Commit
sharadregoti Dec 6, 2024
4352614
Merge branch 'master' of https://github.com/TykTechnologies/tyk-docs …
sharadregoti Dec 16, 2024
6671d8e
Fixes
sharadregoti Dec 18, 2024
fbe4868
Fixes
sharadregoti Dec 18, 2024
c6e467a
Merge branch 'master' of https://github.com/TykTechnologies/tyk-docs …
sharadregoti Dec 18, 2024
dbe2918
Fixes
sharadregoti Dec 18, 2024
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
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 "migration-to-tyk#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
2 changes: 2 additions & 0 deletions tyk-docs/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ enableGitInfo = true
disableKinds = ["term","taxonomy"]
canonifyURLs = false
timeout = "60s"
refLinksErrorLevel = "WARNING"
refLinksNotFoundURL = "migration-to-tyk#configure-tyk-self-managed"
[params]
GithubEdit = "https://github.com/TykTechnologies/tyk-docs/edit/master/tyk-docs/content/"
GithubReadOnly = "https://github.com/TykTechnologies/tyk-docs/blob/master/tyk-docs/content/"
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 "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.

### 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 "migration-to-tyk#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 "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 "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.

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

### 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 "migration-to-tyk#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 "migration-to-tyk#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 "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 "migration-to-tyk#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 "apim/open-source" >}}) | [Self-Managed]({{< ref "tyk-on-premises" >}}) | [Cloud](https://account.cloud-ara.tyk.io/signup)
| | [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)
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|-------------------|---------
| 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 "apim/open-source#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 "migration-to-tyk#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 "tyk-multi-data-centre" >}}) | - |✅ |✅
| [Multi-Data Center]({{< ref "migration-to-tyk#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 "apim/open-source" >}}) for more information on it and other open source components.
Visit the [OSS section]({{< ref "migration-to-tyk#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.
33 changes: 0 additions & 33 deletions tyk-docs/content/apim/open-source.md

This file was deleted.

6 changes: 3 additions & 3 deletions tyk-docs/content/apim/open-source/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The backbone of all our products is our open source Gateway. You can install our

{{< grid >}}

{{< badge read="10 mins" href="tyk-oss/ce-docker/" image="/img/docker.png" alt="Docker install">}}
{{< badge read="10 mins" href="migration-to-tyk#install-with-docker" image="/img/docker.png" alt="Docker install">}}
Install with Docker.
{{< /badge >}}

Expand All @@ -29,11 +29,11 @@ Install with K8s.
Install with Ansible.
{{< /badge >}}

{{< badge read="10 mins" href="tyk-oss/ce-redhat-rhel-centos/" image="/img/redhat-logo2.png" alt="Redhat / CentOS install">}}
{{< badge read="10 mins" href="migration-to-tyk#install-tyk-gateway-on-red-hat-rhel--centos" image="/img/redhat-logo2.png" alt="Redhat / CentOS install">}}
Install on RHEL / CentOS.
{{< /badge >}}

{{< badge read="10 mins" href="tyk-oss/ce-debian-ubuntu/" image="/img/debian-nd-753.png" alt="Debian / Ubuntu install">}}
{{< badge read="10 mins" href="migration-to-tyk#install-tyk-gateway-on-ubuntu" image="/img/debian-nd-753.png" alt="Debian / Ubuntu install">}}
Install on Debian / Ubuntu.
{{< /badge >}}

Expand Down
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 "tyk-stack/tyk-gateway/configuration/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 "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`.

{{< 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 "planning-for-production/ensure-high-availability/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 "migration-to-tyk#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 "advanced-configuration/manage-multiple-environments/with-tyk-on-premises" >}}) and enforce a tagging standard across all organizations.
Self-Managed users should use [API tagging]({{< ref "migration-to-tyk#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
Loading
Loading