Skip to content

Commit

Permalink
Restructure Automations Page (#5921)
Browse files Browse the repository at this point in the history
(cherry picked from commit 05e0e14)
  • Loading branch information
sharadregoti authored and Tyk Bot committed Jan 27, 2025
1 parent c5fc212 commit 1e08bce
Show file tree
Hide file tree
Showing 29 changed files with 4,884 additions and 120 deletions.
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 "/api-management/automations#synchronize-tyk-environment-with-github-repository" >}}) 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/sync" >}}) 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 "/api-management/automations#synchronize-tyk-environment-with-github-repository" >}}) 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/sync" >}}) for more details.
85 changes: 19 additions & 66 deletions tyk-docs/content/api-management/automations.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,17 @@
---
title: "Tyk Automations Tools"
date: 2025-01-10
tags: ["Tyk API Management", "Tyk Sync", "Tyk Operator", "Github", "Kubernetes", "Automations"]
description: Tyk Tools that help with automating deployment and API Management operations
linkTitle: Automation Tools
tags: ["Tyk API Management", "Open Source", "Self-Managed", "Tyk Cloud", "API Gateway"]
title: Automation Tools
keywords: ["Tyk API Management", "Tyk Sync", "Tyk Operator", "Github", "Kubernetes", "Automations"]
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
- /product-stack/tyk-operator/advanced-configurations/client-authentication
- /product-stack/tyk-operator/advanced-configurations/internal-looping
- /product-stack/tyk-operator/advanced-configurations/management-of-api
- /product-stack/tyk-operator/advanced-configurations/tls-certificate
- /product-stack/tyk-operator/getting-started/create-an-api-overview
- /product-stack/tyk-operator/getting-started/create-an-oas-api
- /product-stack/tyk-operator/getting-started/example-tyk-oas-api
- /product-stack/tyk-operator/getting-started/quick-start-graphql
- /product-stack/tyk-operator/getting-started/quick-start-http
- /product-stack/tyk-operator/getting-started/quick-start-tcp
- /product-stack/tyk-operator/getting-started/quick-start-udg
- /product-stack/tyk-operator/getting-started/secure-an-api-overview
- /product-stack/tyk-operator/getting-started/secure-an-oas-api
- /product-stack/tyk-operator/getting-started/security-policy-example
- /product-stack/tyk-operator/getting-started/tyk-operator-api-ownership
- /product-stack/tyk-operator/getting-started/tyk-operator-multiple-organisations
- /product-stack/tyk-operator/key-concepts/custom-resources
- /product-stack/tyk-operator/key-concepts/key-concepts
- /product-stack/tyk-operator/key-concepts/operator-context
- /product-stack/tyk-operator/key-concepts/operator-user
- /product-stack/tyk-operator/reference/api-definition
- /product-stack/tyk-operator/reference/security-policy
- /product-stack/tyk-operator/reference/tyk-oas-api-definition
- /product-stack/tyk-operator/reference/version-compatibility
- /product-stack/tyk-operator/troubleshooting/tyk-operator-changes-not-applied
- /product-stack/tyk-operator/troubleshooting/tyk-operator-reconciliation-troubleshooting
- /product-stack/tyk-operator/tyk-ingress-controller
- /product-stack/tyk-sync/commands/sync-dump
- /product-stack/tyk-sync/commands/sync-examples
- /product-stack/tyk-sync/commands/sync-publish
- /product-stack/tyk-sync/commands/sync-sync
- /product-stack/tyk-sync/commands/sync-update
- /product-stack/tyk-sync/installing-tyk-sync
- /product-stack/tyk-sync/overview
- /product-stack/tyk-sync/tutorials/tutorial-backup-api-configurations
- /product-stack/tyk-sync/tutorials/tutorial-synchronise-api-configurations
- /product-stack/tyk-sync/tutorials/tutorial-update-api-configurations
- /tyk-operator
- /tyk-stack/tyk-operator/access-an-api
- /tyk-stack/tyk-operator/create-an-api
- /tyk-stack/tyk-operator/getting-started-tyk-operator
- /tyk-stack/tyk-operator/installing-tyk-operator
- /tyk-stack/tyk-operator/migration
- /tyk-stack/tyk-operator/publish-an-api
- /tyk-stack/tyk-operator/secure-an-api
- /tyk-stack/tyk-operator/tyk-operator-reconciliation
- /tyk-sync

---

## Introduction

Managing APIs across multiple environments can quickly become complex. Updating and overseeing multiple configurations, security policies, and deployments requires a significant amount of effort without the right tools. Tyk’s suite of automation tools simplifies this process by enabling automated control over API management tasks, helping teams ensure reliability, reduce manual errors, and maintain consistency across deployments.

In this guide, we’ll walk through the primary tools for automating API management with Tyk, including:
In this page, we’ll walk through the primary tools for automating API management with Tyk, including:

* **Tyk Operator for Kubernetes**: Automate API deployments within Kubernetes environments.
* **Tyk Sync**: Sync configurations across environments for consistent API management.
Expand Down Expand Up @@ -89,10 +40,11 @@ Before diving into lifecycle automations with Tyk, ensure you have the following
- For YAML, check out this [YAML tutorial](https://yaml.org/spec/1.2/spec.html)
- For API concepts, review our [API management basics]({{<ref "getting-started/key-concepts">}})


If you're missing any of these prerequisites, please follow the provided links to set up the necessary components before proceeding with the lifecycle automation steps.

## Automation Tools

<<<<<<< HEAD
## Automate API Management in Kubernetes Environments

Using Tyk Operator within Kubernetes allows you to manage API lifecycles declaratively. This section provides instructions for setting up and configuring the Tyk Operator to automate API creation, updates, and security in Kubernetes clusters, ensuring your APIs align with Kubernetes management practices.
Expand Down Expand Up @@ -4801,18 +4753,19 @@ It's a good practice to maintain separate branches or tags for different environ
### Can I use Tyk Operator with non-Kubernetes Tyk installations?

While Tyk Operator is designed to work within a Kubernetes environment, you can still use it to manage non-Kubernetes Tyk installations. You'll need to:
=======
{{< grid >}}
>>>>>>> 05e0e147b... Restructure Automations Page (#5921)

1. Run Tyk Operator in a Kubernetes cluster.
2. Configure Tyk Operator to point to your external Tyk installation, e.g. via `tyk-operator-conf`, environment variable, or OperatorContext:
```yaml
TYK_MODE: pro
TYK_URL: http://external-tyk-dashboard
TYK_AUTH: api-access-key
TYK_ORG: org-id
```
{{< badge read="10 mins" href="api-management/automations/sync" image="/img/GitHub-Mark-64px.png" alt="Tyk Sync">}}
Synchronize Tyk Environment With GitHub using Tyk Sync.
{{< /badge >}}

This allows you to manage your external Tyk installation using Kubernetes resources.
{{< badge read="10 mins" href="api-management/automations/operator" image="/img/k8s.png" alt="Tyk Operator">}}
API Management in Kubernetes using Tyk Operator.
{{< /badge >}}

{{< /grid >}}

## Conclusion

Expand Down
Loading

0 comments on commit 1e08bce

Please sign in to comment.