Tyk Operator 1.0 Release Notes

Licensed Protected Product

This page contains all release notes for version 1.0.X displayed in a reverse chronological order

Support Lifetime

Our minor releases are supported until our next minor comes out.

1.0.0 Release Notes

We are excited to announce the release of Tyk Operator v1.0, marking a significant milestone with new features, enhancements, and critical changes. This release introduces support for Tyk OAS APIs, extended capabilities for managing Classic APIs and security policies, and includes license changes that you must be aware of before upgrading.

Release Date 10 Oct 2024

Release Highlights

Support for Tyk OAS API

The Tyk Operator v1.0 release introduces powerful new features designed to enhance how you manage APIs in Kubernetes environments. One of the key highlights is the full support for Tyk OAS APIs, allowing you to define and manage APIs through the new TykOasApiDefinition custom resource. This integration extends GitOps API Management to Tyk OAS, allowing you to have declarative, versioned, and fully automated control to your APIs in Kubernetes environments.

Key features:

• Define and Manage Tyk OAS APIs using the TykOasApiDefinition custom resource.
• Manage API Definitions in ConfigMaps: Any changes are automatically tracked and synced to Tyk.
• Configure Tyk OAS in a Kubernetes-native way: You can organize APIs by categories or manage multiple API versions easily with the new CRD.
• Simplify certificate management by referencing Kubernetes secrets.
• Use the Tyk Ingress controller to create Tyk OAS APIs from Ingress specs.

With this release, users benefit from seamless GitOps workflows, ensuring a Kubernetes-native operation workflow. Security is also made simpler with automated certificate synchronization, removing the hassle of manual certificate management.

Enhanced Classic API and Security Policy Features

Enhanced support for Tyk Classic APIs continues, with improvements to security policies and new capabilities for setting API and endpoint-specific rate limits, making it easier than ever to customize API usage policies.

This release represents a significant upgrade for both API management and security, offering a more efficient, scalable, and Kubernetes-native way to operate Tyk. Whether you’re leveraging Tyk OAS APIs or continuing with Tyk Classic, this version brings the tools and features you need to streamline your workflows and enhance operational efficiency.

For details please refer to the changelog below.

Breaking Changes

License Requirement: Tyk Operator is now a closed-source product and requires a valid license key to operate. Please follow our Installation and Upgrade Guide to set your license key before installation or upgrade.

If the license is missing, invalid, or expired, Tyk Operator will exit with an error message. Ensure that you carefully review the setup steps to avoid any issues during the upgrade or installation process.

Dependencies

3rd Party Dependencies & Tools

Given the time difference between your upgrade and the release of this version, we recommend customers verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.

Deprecations

There are no deprecations in this release.

Upgrade instructions

Tyk Operator v1.0 introduced new Custom Resource Definitions (CRDs). Before upgrading to Tyk Operator v1.0 with Helm Chart, please run the following commands to install the CRDs:

$ kubectl apply -f https://raw.githubusercontent.com/TykTechnologies/tyk-charts/refs/heads/main/tyk-operator-crds/crd-v1.0.0.yaml

Go to the Upgrading Tyk Operator section for detailed upgrade instructions.

Downloads

• Docker image v1.0.0

  • docker pull tykio/tyk-operator:v1.0.0
    

• Helm chart - TBP (To Be Published separately after the release)

Changelog

Added

• TykOasApiDefinition: new Custom Resource for Tyk OAS

  The TykOasApiDefinition custom resource allows you to manage Tyk OAS APIs directly within your Kubernetes environment. You can now categorize APIs, manage multiple versions, and simplify SSL certificate management by referencing Kubernetes secrets. This enhancement offers a Kubernetes-native approach to managing Tyk APIs, streamlining operations and reducing the complexity of versioning and certificate handling across different environments.

  Learn More: Create Tyk OAS API

• Ingress Controller: Support Tyk OAS API as an Ingress Template

  With this release, you can use the TykOasApiDefinition resource as a template for automatically creating Tyk OAS APIs based on Kubernetes Ingress specs. This simplifies the process of generating APIs by leveraging Ingress controller annotations, reducing manual intervention, and automating API creation workflows for better scalability and operational efficiency.

  Learn More: Tyk Ingress Controller

• SecurityPolicy: Support for Key-Level Per-API Rate Limits and Quota

  This release introduces the ability to configure specific rate limits, quotas, and throttling rules at the API level using the access_rights_array in the security policy. Each API now has the flexibility to inherit global limit settings or apply custom limits, making it easier to control API usage on a per-API basis. This provides enhanced granularity in managing traffic, ensuring optimal resource allocation and improved performance under heavy loads.

  Learn More: Key-Level Per-API Rate Limits and Quota

• SecurityPolicy: Support for Key-Level Per-Endpoint Rate Limits

  By configuring key-level per-endpoint limits, you can restrict the request rate for specific API clients to a specific endpoint of an API.

  Learn More: Key-Level Per-Endpoint Rate Limits

• SecurityPolicy: Support for TykOasApiDefinition

  This update extends the security policy to include TykOasApiDefinition resources within the access_rights_array, allowing you to manage security policies for both Tyk Classic APIs and Tyk OAS APIs. By specifying the API kind, you can now apply rate limits, quotas, and other access controls to Tyk OAS APIs, streamlining security management in mixed environments.

  Learn More: TykOasApiDefinition in Security Policy

• ApiDefinition: Support for Event Handler

  Tyk Operator now supports event handler integration for ApiDefinition, enabling webhooks to be triggered by specific API events. This allows for real-time, event-driven automation between Tyk and other systems, sending notifications or executing actions as events occur in the API lifecycle. The event_handlers field in the ApiDefinition CRD makes it easy to set up webhook-driven processes for better control and automation across your services.

  Learn More: Event Webhook with Tyk Classic

• ApiDefinition: Support timeout Field in Advanced Cache Control

  The advanced cache configuration for ApiDefinition now supports a timeout field, providing greater control over cache behavior. You can define specific cache timeouts for different API paths, allowing for more fine-tuned control over caching strategies. This feature helps optimize API performance, particularly for high-traffic endpoints requiring precise cache management.

  extended_paths:
    advance_cache_config:
      - path: "/json"    
        method: "GET"
        cache_response_codes: [200, 204]
        timeout: 120
  

• ApiDefinition: Support new Fields in `VersionDefinition`

  VersionDefinition within ApiDefinition has been expanded to include additional fields, offering more granular control over API versioning and path management. These new fields allow you to configure version handling more flexibly, enhancing your ability to manage API versions and customize how version data is processed in API paths.

Changed

• Go Version Updated to 1.22

  The underlying Go runtime for Tyk Operator has been updated to version 1.22. This upgrade brings performance improvements, enhanced security, and compatibility with the latest Go libraries, ensuring Tyk Operator remains efficient and secure in production environments.

Further Information

Upgrading Tyk

Please refer to the upgrading Tyk page for further guidance on the upgrade strategy.

FAQ

Please visit our Developer Support page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.