Tyk MDCB v2.7 Release Notes

Licensed Protected Product

This page contains all release notes for version 2.7 displayed in reverse chronological order

Support Lifetime

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

2.7.0 Release Notes

Release date 12 August 2024

Breaking Changes

This release has no breaking changes.

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, however with the introduction of new healthcheck endpoints we encourage customers to start using the new /liveness and /readiness endpoints and avoid using the old /health endpoint.

Recommendations for users:

• Migrate to new health check endpoints in order to get more detailed information. For Kubernetes users, use Helm Charts v1.6 to upgrade MDCB to set liveness and readiness probes of MDCB deployment to the new health check endpoints.

Upgrade instructions

If you are using a 2.6.x version, we advise you to upgrade ASAP to this latest release. If you are on an older version, you should skip 2.6.0 and upgrade directly to this release.

Release Highlights

New Health check probes

Two new health check endpoints have been added to improve monitoring and diagnostics:

1. /liveness: This endpoint provides a quick check to determine if the MDCB application is alive and running.
2. /readiness: This endpoint offers a detailed status of components and dependencies required for MDCB to serve traffic. It includes status checks for:
   • Database connectivity
   • Redis connectivity
   • RPC server status

These new endpoints allow for more granular monitoring of MDCB’s operational status, enabling quicker identification and resolution of potential issues.

New Configuration Access Endpoint

Two new /config and /env endpoints have been implemented, allowing developers to access the current configuration state of the MDCB instance in real-time. This feature provides:

• Secure access to configuration data
• Automatic redaction of sensitive information
• Up-to-date view of the running configuration

This addition enhances debugging capabilities and provides valuable insights into the MDCB instance’s current settings.

Please refer to the changelog below.

Downloads

• Docker image v2.7.0

• docker pull tykio/tyk-mdcb-docker:v2.7.0
  

Changelog

Added

• Added `/liveness` endpoint for quick checks on MDCB application status

  Added `/liveness` endpoint that reports if MDCB is running. It returns status 200 if MDCB is alive. It returns status 503 if MDCB is not operational. In that case, a restart is recommended.
• Implemented `/readiness` endpoint to detail status of critical components and dependencies

  Added `/readiness` endpoint that reports if MDCB is ready to serve request. It returns status 200 if MDCB is ready. It returns status 503 if MDCB or one of the dependencies is not ready.
• Introduced `/config` endpoint for secure, real-time access to MDCB instance configuration

  Added `/config` endpoint that returns MDCB instance configuration in JSON format. It requires an administrative key provided in the `x-tyk-authorization` header for access, ensuring secure and controlled usage. Successful requests return MDCB JSON configurations with passwords and sensitive information redacted.
• Introduced `/env` endpoint for secure, real-time access to MDCB instance configuration

  Added `/env` endpoint that returns MDCB instance configuration as a list of environment variable keys and values. It requires an administrative key provided in the `x-tyk-authorization` header for access, ensuring secure and controlled usage. Successful requests returns a list of environment variable keys and values with passwords and sensitive information redacted.

Updated

• Update for compatibility with API definitions for Tyk v5.5

  MDCB 2.7.0 supports Tyk API definitions up to Tyk Gateway v5.5.0. Please use MDCB 2.7.x with Tyk Gateway v5.5.0+.

Further Information

Upgrading Tyk

Please refer to the upgrading Tyk page for further guidance with respect to 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.