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 - Automations #5689

Open
wants to merge 58 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 57 commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
d5aa439
base files - checking push to branch
DavidRollins Oct 30, 2024
c26c357
updating auth and automations pages
DavidRollins Oct 31, 2024
43e4f0c
updating menu.yaml
DavidRollins Oct 31, 2024
d793ad3
remove aliases
DavidRollins Oct 31, 2024
3ab17e0
Update frontmatter and menu
DavidRollins Oct 31, 2024
03c5eb7
Update frontmatter and menu
DavidRollins Oct 31, 2024
b4eeff6
improve readability of automations page
DavidRollins Oct 31, 2024
78c4dec
update automations only
DavidRollins Nov 1, 2024
2b49c46
remove picture from authn
DavidRollins Nov 1, 2024
54e5ade
Update the automations page
DavidRollins Nov 4, 2024
b2efc94
Update the automations page
DavidRollins Nov 5, 2024
b1213bd
Update the automations page
DavidRollins Nov 5, 2024
71ba9dc
Update the automations page
DavidRollins Nov 5, 2024
61f6e40
Update the automations page
DavidRollins Nov 5, 2024
c1263e4
Update menu.yaml
DavidRollins Nov 5, 2024
e35748e
Update menu.yaml
DavidRollins Nov 5, 2024
12b0b26
Update menu.yaml
DavidRollins Nov 5, 2024
1c25834
Update menu.yaml
DavidRollins Nov 5, 2024
e073578
Update content per Sharads comments
DavidRollins Nov 5, 2024
3fb61e6
Update menu yaml
DavidRollins Nov 5, 2024
68fe6be
Update heading hierarchy
DavidRollins Nov 5, 2024
e84b4af
Update structure
DavidRollins Nov 5, 2024
f12f967
Update structure and page content
DavidRollins Nov 5, 2024
6080cba
fixing content deletion
DavidRollins Nov 5, 2024
a0a7787
fixing content deletion
DavidRollins Nov 5, 2024
581ff2c
fixing content deletion
DavidRollins Nov 5, 2024
5d36899
fixing content deletion
DavidRollins Nov 5, 2024
4e569fc
fixing content deletion
DavidRollins Nov 6, 2024
bef23d9
Update the content of automations
DavidRollins Nov 7, 2024
ec515c3
sort the aliases
letzya Nov 7, 2024
1292f72
save
DavidRollins Nov 7, 2024
8d4910a
Update automations page
DavidRollins Nov 7, 2024
e84f68a
Update automations page
DavidRollins Nov 7, 2024
a87627e
fix linking
DavidRollins Nov 7, 2024
4cf901e
test fragment
DavidRollins Nov 7, 2024
ec6741f
fix fragments
DavidRollins Nov 7, 2024
607a9b6
fix fragments
DavidRollins Nov 7, 2024
9d8a56e
fix fragments
DavidRollins Nov 7, 2024
7a84dc1
fix fragments
DavidRollins Nov 7, 2024
450f4e4
fix menu
DavidRollins Nov 7, 2024
3889bcf
fix menu
DavidRollins Nov 7, 2024
f7e2a0a
fix links
DavidRollins Nov 7, 2024
1b35100
fix links
DavidRollins Nov 7, 2024
219a92a
fix links
DavidRollins Nov 7, 2024
21a3357
fix aliases to address broken links
DavidRollins Nov 7, 2024
b00c164
fix links
DavidRollins Nov 7, 2024
f6f170b
fix links
DavidRollins Nov 7, 2024
a0bea2a
fix links
DavidRollins Nov 7, 2024
ffe2481
fix links
DavidRollins Nov 7, 2024
4243891
update per sharad's comments
DavidRollins Nov 8, 2024
ea5c8db
update the automations page with pm suggestions
DavidRollins Nov 12, 2024
bceace8
update the automations page with pm suggestions
DavidRollins Nov 12, 2024
0fe829a
update the automations page with pm suggestions
DavidRollins Nov 12, 2024
031ce6a
resolve merge conflicts
DavidRollins Nov 18, 2024
f901e84
fix merge errors
DavidRollins Nov 18, 2024
44d60e4
fix merge errors
DavidRollins Nov 18, 2024
f90caa1
fix merge errors
DavidRollins Nov 18, 2024
bdb477e
update getting started pages to latest steps
DavidRollins Nov 19, 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
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,4 @@ The ID you use in with any Dashboard API integrations will change as the documen

## Use Tyk-Sync

You can also use our new Tyk-Sync tool which allows you to sync your APIs (and Policies) with a Version Control System (VCS). You can then move your APIs between environments. See [Tyk-Sync]({{< ref "/product-stack/tyk-sync/overview" >}}) for more details.
You can also use our new Tyk-Sync tool which allows you to sync your APIs (and Policies) with a Version Control System (VCS). You can then move your APIs between environments. See [Tyk-Sync]({{< ref "/api-management/automations#synchronize-tyk-environment-with-github-repository" >}}) for more details.
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,4 @@ As you can see, under the hood, the policy has been migrated correctly with targ

## Use Tyk-Sync

You can also use our new Tyk-Sync tool which allows you to sync your Policies (and APIs) with a Version Control System (VCS). You can then move your Policies between environments. See [Tyk-Sync]({{< ref "/product-stack/tyk-sync/overview" >}}) for more details.
You can also use our new Tyk-Sync tool which allows you to sync your Policies (and APIs) with a Version Control System (VCS). You can then move your Policies between environments. See [Tyk-Sync]({{< ref "/api-management/automations#synchronize-tyk-environment-with-github-repository" >}}) for more details.
4,669 changes: 4,669 additions & 0 deletions tyk-docs/content/api-management/automations.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Tyk Sync enables declarative API management and GitOps. With Tyk Sync, you can m
Usage: Recommended for organizations looking to implement GitOps in API management and have portable API and Policy configurations.

Learn more:
- [Tyk Sync]({{<ref "/product-stack/tyk-sync/overview">}})
- [Tyk Sync]({{<ref "/api-management/automations#synchronize-tyk-environment-with-github-repository">}})

## Tyk Operator

Expand All @@ -51,7 +51,7 @@ Building on the capabilities of Tyk Sync and GitOps, Tyk Operator provides a pow
Usage: Recommended for organizations already running Kubernetes and seeking a Kubernetes-native, automated approach to API deployment and management.

Learn more:
- [Tyk Operator]({{<ref "tyk-operator">}})
- [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">}})

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.
4 changes: 2 additions & 2 deletions tyk-docs/content/apim.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Choosing the right one for your organization depends on your specific requiremen

| | [Open Source]({{< ref "apim/open-source" >}}) | [Self-Managed]({{< ref "tyk-on-premises" >}}) | [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" >}})</li></ul> | ✅ |✅ |✅
| [Version Control]({{< ref "/product-stack/tyk-sync/overview" >}}) Integration | - |✅ |✅
| 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> | ✅ |✅ |✅
| [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" >}}) | - |✅ |✅
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ As you can see in the above example, enabling Basic Authentication is as simple

### Enable basic authentication using Tyk Operator

Please consult the Tyk Operator supporting documentation for an example of how to [enable basic authentication]({{< ref "product-stack/tyk-operator/advanced-configurations/client-authentication#basic-authentication" >}}) with Tyk Operator.
Please consult the Tyk Operator supporting documentation for an example of how to [enable basic authentication]({{< ref "/api-management/automations#basic-authentication" >}}) with Tyk Operator.

## Create a Basic Authentication user

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,4 @@ It is possible to provide Tyk with your own custom tokens, this can be achieved

## Enabling bearer tokens with Tyk Operator

Please consult the Tyk Operator supporting documentation for an example of how to [enable a bearer tokens]({{< ref "product-stack/tyk-operator/advanced-configurations/client-authentication#auth-token-bearer-token" >}}) with Tyk Operator.
Please consult the Tyk Operator supporting documentation for an example of how to [enable a bearer tokens]({{< ref "/api-management/automations#auth-token-bearer-token" >}}) with Tyk Operator.
Original file line number Diff line number Diff line change
Expand Up @@ -240,4 +240,4 @@ Several scopes in JWT claim will lead to have several policies applied to a key.

### JWT authentication with Tyk Operator

Please consult the Tyk Operator supporting documentation for an example of how to [configure JWT authentication]({{< ref "product-stack/tyk-operator/advanced-configurations/client-authentication#jwt" >}}) with Tyk Operator.
Please consult the Tyk Operator supporting documentation for an example of how to [configure JWT authentication]({{< ref "/api-management/automations#jwt" >}}) with Tyk Operator.
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ Tyk will chain the auth mechanisms as they appear in the code and will default t

## Enable Multi (Chained) Authentication with Tyk Operator

Please consult the Tyk Operator supporting documentation for an example of how to enable [multi chained authentication]({{< ref "product-stack/tyk-operator/advanced-configurations/client-authentication#multiple-chained-auth" >}}) with Tyk Operator.
Please consult the Tyk Operator supporting documentation for an example of how to enable [multi chained authentication]({{< ref "/api-management/automations#multiple-chained-auth" >}}) with Tyk Operator.
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ Keyless APIs cannot be selected for [Access Rights]({{< ref "getting-started/cre

## Tyk Operator Example

Please consult the Tyk Operator supporting documentation for an example of how to configure an API within Tyk Operator for [Open Access]({{< ref "product-stack/tyk-operator/advanced-configurations/client-authentication#keyless-open" >}}).
Please consult the Tyk Operator supporting documentation for an example of how to configure an API within Tyk Operator for [Open Access]({{< ref "/api-management/automations#keyless-open" >}}).
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "How to backup APIs and Policies with Tyk Dashboard"
---

Backing up Tyk APIs and Policies is crucial for ensuring business continuity and data integrity. It safeguards against accidental data loss, system failures or corruption. This provides the opportunity to rollback to a stable state during upgrades or migrations, allowing you to restore configurations to a previous state to prevent disruptions with your API infrastructure.
If you are using Self Managed deployment then we recommend that you use [Tyk Sync]({{< ref "/product-stack/tyk-sync/overview" >}}) to backup your Tyk APIs and policies.
If you are using Self Managed deployment then we recommend that you use [Tyk Sync]({{< ref "/api-management/automations#synchronize-tyk-environment-with-github-repository" >}}) to backup your Tyk APIs and policies.

## Export And Restore APIs and Policies

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ To track changes in Dashboard configurations, please submit a [support ticket](h

#### If there's a configuration error or an unwanted change, can I easily revert to a previous API or Policy configuration? What are the options or best practices for effective rollbacks?

You can configure [Tyk-Sync]({{< ref "/product-stack/tyk-sync/overview" >}}) to synchronise APIs and Policies with any version control system, like GitHub or GitLab and use it to perform roll back. Keys are not synchronised with Tyk Sync.
You can configure [Tyk-Sync]({{< ref "/api-management/automations#synchronize-tyk-environment-with-github-repository" >}}) to synchronise APIs and Policies with any version control system, like GitHub or GitLab and use it to perform roll back. Keys are not synchronised with Tyk Sync.
Original file line number Diff line number Diff line change
Expand Up @@ -332,4 +332,4 @@ Note that the Gateway will respond with the following error message:

You can make use of Tyk Operator custom resources to configure [Tyk OAS API]({{<ref "getting-started/using-oas-definitions/oas-glossary#tyk-oas-api-definition">}}) in a Kubernetes environment.

In this [tutorial]({{<ref "product-stack/tyk-operator/getting-started/create-an-oas-api">}}) we guide you through the steps to create a new Tyk OAS API using Tyk Operator.
In this [tutorial]({{<ref "/api-management/automations#set-up-oas-api">}}) we guide you through the steps to create a new Tyk OAS API using Tyk Operator.
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,6 @@ See the [supported languages]({{< ref "plugins/supported-languages" >}}) section

Please consult the Tyk Operator supporting documentation for examples of how to configure a Tyk Operator API to use:

- [Go custom authentication plugin]({{< ref "product-stack/tyk-operator/advanced-configurations/client-authentication#custom-plugin-auth-go" >}})
- [gRPC custom authentication plugin]({{< ref "product-stack/tyk-operator/advanced-configurations/client-authentication#custom-plugin-auth-grpc" >}})
- [Go custom authentication plugin]({{< ref "/api-management/automations#custom-plugin-auth-go" >}})
- [gRPC custom authentication plugin]({{< ref "/api-management/automations#custom-plugin-auth-grpc" >}})

Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Each change log item should be expandable. The first line summarises the changel
<details>
<summary>OSS: Simplify Tyk Operator setup with Kubernetes Secret creation</summary>

When you set `operatorSecret.enabled` to `true` in the `tyk-oss` chart, a Kubernetes Secret named `tyk-operator-conf` will be automatically created in the same namespace. This secret is essential for connecting Tyk Operator to the Gateway, enabling seamless management of Tyk API resources. To learn more about setting up Tyk Operator, check out [Tyk Operator installation]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}}).
When you set `operatorSecret.enabled` to `true` in the `tyk-oss` chart, a Kubernetes Secret named `tyk-operator-conf` will be automatically created in the same namespace. This secret is essential for connecting Tyk Operator to the Gateway, enabling seamless management of Tyk API resources. To learn more about setting up Tyk Operator, check out [Tyk Operator installation]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}}).
</details>
</li>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -271,14 +271,14 @@ mdcb:

`global.components.operator` added to determine whether the Tyk Operator component should be installed.

This feature adds a dependency on the Tyk Operator to the umbrella charts, facilitating the installation of the Tyk Operator component. Users can now easily install the Tyk Operator component by setting the `global.components.operator` parameter. Note that the Tyk Operator requires `cert-manager` to be installed beforehand. It also expects secret `tyk-operator-conf` is present in the installation namespace. You can enable bootstrapping at `global.components.bootstrap` if you are working on a new installation to have this secret created for you. Refer to the Tyk Operator [installation guide]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}}) for detailed information on pre-requisites.
This feature adds a dependency on the Tyk Operator to the umbrella charts, facilitating the installation of the Tyk Operator component. Users can now easily install the Tyk Operator component by setting the `global.components.operator` parameter. Note that the Tyk Operator requires `cert-manager` to be installed beforehand. It also expects secret `tyk-operator-conf` is present in the installation namespace. You can enable bootstrapping at `global.components.bootstrap` if you are working on a new installation to have this secret created for you. Refer to the Tyk Operator [installation guide]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}}) for detailed information on pre-requisites.

```yaml
global:
components:
# operator determines whether Tyk Operator component should be installed or not.
# Tyk Operator needs cert-manager to be installed beforehand. Make sure that cert-manager is installed.
# For further details, please refer to https://tyk.io/docs/tyk-stack/tyk-operator/installing-tyk-operator/
# For further details, please refer to https://tyk.io/docs//api-management/automations#install-and-configure-tyk-operator/
operator: false
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For a comprehensive list of changes, please refer to the detailed [changelog](#C
<!-- Required. Use the following statement if there are no breaking changes, or explain if there are -->
This release has no breaking changes.

However, if you are upgrading to [Tyk Operator v1.0]({{<ref "product-stack/tyk-operator/release-notes/operator-1.0.md">}}) using the Helm Chart, please read the [license requirement]({{<ref "product-stack/tyk-operator/release-notes/operator-1.0.md#breaking-changes">}}) and Tyk Operator [installation and upgrade instructions]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}}) carefully.
However, if you are upgrading to [Tyk Operator v1.0]({{<ref "product-stack/tyk-operator/release-notes/operator-1.0.md">}}) using the Helm Chart, please read the [license requirement]({{<ref "product-stack/tyk-operator/release-notes/operator-1.0.md#breaking-changes">}}) and Tyk Operator [installation and upgrade instructions]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}}) carefully.

<!-- The following "Changed error log messages" section is Optional!
Instructions: We should mention in the changelog section ALL changes in our application log messages. In case we made such changes, this section should also be added, to make sure the users don't miss this notice among other changelog lines. -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -865,7 +865,7 @@ tyk-dev-portal:
### Tyk Operator Configurations

Tyk Operator is a licensed component that requires a valid key for operation.
Please refer to the [Tyk Operator Installation Guide]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}})
Please refer to the [Tyk Operator Installation Guide]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}})
for detailed information on the installation and upgrade processes.

Prior to installing Tyk Operator, ensure that a valid license key is provided by setting `global.license.operator` field in values.yaml file. You can set license key via a Kubernetes secret using `global.secrets.useSecretName` field. The secret should contain a key called `OperatorLicense`.
Expand All @@ -876,4 +876,4 @@ to `true`.
All other configurations related to Tyk Operator are available under `tyk-operator` section of `values.yaml` file.

> Tyk Operator needs a cert-manager to be installed. Ensure that cert-manager is installed as described in the
> official documentation: [Installing Tyk Operator]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}}).
> official documentation: [Installing Tyk Operator]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}}).
4 changes: 2 additions & 2 deletions tyk-docs/content/product-stack/tyk-charts/tyk-oss-chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,7 +496,7 @@ To setup other backends for pump, refer to this [document](https://github.com/Ty
### Tyk Operator Configurations

Tyk Operator is a licensed component that requires a valid key for operation.
Please refer to the [Tyk Operator Installation Guide]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}})
Please refer to the [Tyk Operator Installation Guide]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}})
for detailed information on the installation and upgrade processes.

Prior to installing Tyk Operator, ensure that a valid license key is provided by setting `global.license.operator` field in values.yaml file. You can set license key via a Kubernetes secret using `global.secrets.useSecretName` field. The secret should contain a key called `OperatorLicense`.
Expand All @@ -505,4 +505,4 @@ In order to enable installing Tyk Operator along-side Tyk OSS installation, plea

All other configurations related to Tyk Operator are available under `tyk-operator` section of `values.yaml` file.

> Tyk Operator needs a cert-manager to be installed. Ensure that cert-manager is installed as described in the official documentation: [Installing Tyk Operator]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}}).
> Tyk Operator needs a cert-manager to be installed. Ensure that cert-manager is installed as described in the official documentation: [Installing Tyk Operator]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}}).
4 changes: 2 additions & 2 deletions tyk-docs/content/product-stack/tyk-charts/tyk-stack-chart.md
Original file line number Diff line number Diff line change
Expand Up @@ -888,7 +888,7 @@ tyk-dev-portal:
### Tyk Operator Configurations

Tyk Operator is a licensed component that requires a valid key for operation.
Please refer to the [Tyk Operator Installation Guide]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}})
Please refer to the [Tyk Operator Installation Guide]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}})
for detailed information on the installation and upgrade processes.

Prior to installing Tyk Operator, ensure that a valid license key is provided by setting `global.license.operator` field in values.yaml file. You can set license key via a Kubernetes secret using `global.secrets.useSecretName` field. The secret should contain a key called `OperatorLicense`.
Expand All @@ -899,4 +899,4 @@ to `true`.
All other configurations related to Tyk Operator are available under `tyk-operator` section of `values.yaml` file.

> Tyk Operator needs a cert-manager to be installed. Ensure that cert-manager is installed as described in the
> official documentation: [Installing Tyk Operator]({{<ref "tyk-stack/tyk-operator/installing-tyk-operator">}}).
> official documentation: [Installing Tyk Operator]({{<ref "/api-management/automations#install-and-configure-tyk-operator">}}).
Loading
Loading