v4.1.0

What's Changed

• bump chart versions from 3.0.0 to 4.0.0 across all components by @ilijabojanovic in #427
• TT-15877 bump tyk-stack by @bsten-tyk in #428
• TT-15867 - rollout new Jira linter by @bsten-tyk in #431
• [TT-15895] updated component versions to latest for v4.0.1 by @andrei-tyk in #430
• TT-15867 Jira linter concurrency by @bsten-tyk in #434
• [TT-15895] - bump chart versions from 4.0.0 to 4.0.1 across all components by @ilijabojanovic in #435
• [TT-12933] Add Topology Spread Constraint to the Gateway by @LLe27 in #426
• [TT-16095, GH-432] Operator Tolerations by @pablitoc in #436
• [TT-16074] Updated component default tags for new release by @andrei-tyk in #438

New Contributors

• @ilijabojanovic made their first contribution in #427
• @bsten-tyk made their first contribution in #428
• @pablitoc made their first contribution in #436

Full Changelog: v4.0.0...v4.1.0

v4.0.0

What's Changed

• [tyk-dashboard] Bad env variable name for TYK_DB_USESHARDEDANALYTICS by @AlexisDuf in #405
• Revert "[tyk-dashboard] Bad env variable name for TYK_DB_USESHARDEDANALYTICS" by @olamilekan000 in #406
• TT-15035 Make the mongo-graph pump configurable via Helm values by default by @LLe27 in #412
• [TT-15362] fixed containerSecurityContext fields being misplaced by @andrei-tyk in #415
• TT-15193: update component charts tag version by @olamilekan000 in #410
• [TT-15131 TT-14660] added redis sentinel to db and mdcb and fixed it for other components by @LLe27 in #414
• [TT-15477] added operator env var only if operator is enabled by @andrei-tyk in #417
• TT-15131 - Add sentinel environment support in the dashboard and mdcb components COPY by @andrei-tyk in #416
• [TT-14660] removed duplicate sentinel password configs for db and mdcb by @LLe27 in #418
• [TT-15362] incorrect fs group placement in tyk helm chart by @andrei-tyk in #420
• [TT-15193] update component charts tag version by @andrei-tyk in #421
• [TT-15657] changed latest vers to LTS and moved all umbrella charts to EE gateway image by @andrei-tyk in #422
• [TT-15111] Added visor code review by @lghiur in #425

New Contributors

• @AlexisDuf made their first contribution in #405
• @lghiur made their first contribution in #425

Full Changelog: v3.0.0...v4.0.0

v3.0.0

What's Changed

• TT-13635 (ci): add workflow for alpha Helm chart releases by @buraksekili in #371
• [TT-13614] Add tests.enabled to values.yaml to allow tests to be turned off by @zalbiraw in #357
• [TT-13588] Add new field to support configuration of TYK_API_PORT by @komalsukhani in #372
• [TT-13680] feat: support reading headers from Kubernetes Secrets by @buraksekili in #375
• [TT-13615] Add imageRegistry by @zalbiraw in #361
• TT-13751: add forbid security env to dashboard by @olamilekan000 in #377
• TT-11901: expose Tyk-Pump health check route by @olamilekan000 in #370
• TT-11901: make provision for nil probes if healthcheck is enabled by @olamilekan000 in #378
• TT-13866: change triggers workflow when changes are detected in operator component charts template by @olamilekan000 in #380
• [TT-12309] Remove hardcoded environment variables by @komalsukhani in #379
• [TT-14005] fix pump svc annotation by @zalbiraw in #389
• TT-13942 Adds startupProbe to tyk-gateway by @vanny96 in #376
• [TT-13934] Add tolerations, affinity and node selector to tyk-bootstrap and tyk-operator by @zalbiraw in #381
• [TT-13760]Default secure for Tyk Dashboard admin view by @buraksezer in #394
• [TT-13081] Add support of access logs in gateway by @komalsukhani in #393
• TT-14348: add containerSecurityContext to tyk-stack and tyk-control-plane values by @olamilekan000 in #397
• Migrate operator 1.2.0 helm changes by @komalsukhani in #399
• TT-14266: update component charts tag version by @olamilekan000 in #396
• Update chart versions for 3.0 release by @komalsukhani in #400

New Contributors

• @buraksezer made their first contribution in #394

Full Changelog: v2.2.0...v3.0.0

Tyk Charts v2.2.0

What's Changed

• [TT-13326] - Adds sidecars by @vanny96 in #336
• [TT-13210] Add log level and format vars by @LLe27 in #333
• TT-13449 Fixed template name of opentelemetry caFilePath by @dklenke in #344
• [TT-11247] Adds customization for liveness and readiness probes by @vanny96 in #346
• TT-13448 Adds capability to customize HPA behavior by @vanny96 in #348
• [TT-13461] - Fix mdcb service by @zalbiraw in #352
• TT-13082 - Add Tyk Streams support by @buraksekili in #353
• Set tyk operator license key in OSS chart by @komalsukhani in #359
• [TT-13082] cont'd: enable streaming by default by @buraksekili in #360
• [TT-13445] Add opa support by @zalbiraw in #350
• Add support of audit logs configurations by @komalsukhani in #356
• Update component versions by @komalsukhani in #354
• Update Tyk Operator CRD for version operator-release-v1.1.0 by @Tyk-ITS in #368

New Contributors

• @vanny96 made their first contribution in #336
• @LLe27 made their first contribution in #333
• @dklenke made their first contribution in #344

Full Changelog: v2.1.0...v2.2.0

v2.1.0

What's Changed

• TT-12922: update helm chart component version by @olamilekan000 in #317
• Update Tyk Operator CRD for version operator-release-v0.18.8-rc-test by @Tyk-ITS in #334
• Update Tyk Operator CRD for version operator-release-v1.0.0 by @Tyk-ITS in #338
• (release): version to v2.1.0 by @buraksekili in #339

New Contributors

• @Tyk-ITS made their first contribution in #334

Full Changelog: v2.0.0...v2.1.0

Tyk Charts v2.0.0

What's Changed

• [TT-12848] Add optional extraVolumes and extraVolumeMounts to bootstrap jobs by @nbentfeld in #316
• [TT-13080], added support for path prefix/suffix matching env vars by @andrei-tyk in #319

New Contributors

• @nbentfeld made their first contribution in #316

v1.6.0

What's Changed

• Update k8s version matrix by @komalsukhani in #308
• [TT-12508] Fix dev portal ingress issue by @komalsukhani in #307
• [TT-12685] Update component version by @komalsukhani in #310
• TT-11537 added new MDCB config option healthcheck.cache_renewal_period by @sredxny in #306

Full Changelog: v1.5.0...v1.6.0

v1.5.0

What's Changed

• [TT-9514] Add tyk-operator chart as a dependency by @buraksekili in #278
• Update mongo chart version by @komalsukhani in #293
• TT-11532 added config option for the http server in mdcb 2.5.1 by @sredxny in #284
• TT-11532 deprecated healthcheck port and now use http port. MDCB 2.6 by @sredxny in #286
• Add init containers resources param by @gilankpam in #294
• [TT-12125] Add fixed window rate limiter vars by @titpetric in #292
• TT-12112 Add the value annotations to tyk-stack and component helm charts by @mgnisia in #291
• [TT-12321] Fix MDCB HealthCheck Port settings by @komalsukhani in #299
• (update): upgrade tyk-k8s-bootstrap version to 2.1.2 by @buraksekili in #303
• TT-12202: bootstrap portal using api by @olamilekan000 in #301
• [TT-12407] MDCB improvements by @komalsukhani in #302
• [TT-11730] Fixed mongo analytics settings by @komalsukhani in #296
• [TT-12294] Remove check for v3 from gateway probes by @komalsukhani in #297
• [TT-12320] Update component versions by @komalsukhani in #298
• [TT-12126] Release to 1.5.0 - Prepare artifacts for 1.5.0 helm release by @buraksekili in #305

New Contributors

• @sredxny made their first contribution in #284
• @gilankpam made their first contribution in #294
• @mgnisia made their first contribution in #291

Full Changelog: v1.4.0...v1.5.0

Tyk Charts v1.4.0

Release Highlights

General availability release of tyk-control-plane chart and tyk-mdcb chart
We’re pleased to announce the official release of the Tyk Helm Charts for Tyk Control Plane and MDCB! Following a successful beta phase, these charts are now stable and ready for production use.

With this release, we aim to provide a straightforward solution for deploying and managing Tyk Control Plane and Multi-Data Center Bridge (MDCB) using Helm Charts. Whether you’re looking for our recommended setup configurations or need flexibility to adapt to your architectural requirements, our Helm Charts have you covered.

To leverage this stable release and simplify your Tyk deployments, we invite you to explore our example setup for MDCB Control Plane using Helm Chart. Simply follow our MDCB Control Plane setup guide to get started.

Updated default Tyk versions
Tyk Charts 1.4 will install the following Tyk component versions by default.

Tyk Gateway v5.3.1
Tyk Dashboard v5.3.1
Tyk Pump v1.9.0
Tyk MDCB v2.5.1
Tyk Developer Portal v1.8.5

Changelog

Added

• OSS: Simplify Tyk Operator setup with Kubernetes Secret creation
• MDCB: Enhanced analytics configuration options
• Tyk Control Plane: Added option to enable Dashboard hybrid organisation
• Enhanced security with customisable Pod or Container security context
• Gateway: Allow Gateway to be updated if secret value is updated
• Customizable Pod Labels Across All Components
• Portal: Customizable Pod annotations in tyk-dev-portal

Changed

• Gateway/Pump: Removed the command in Gateway and Pump pod templates
• Dashboard: Allow arbitary image tags in tyk-dashboard
• Dashboard: Classic portal bootstrapping disabled by default
• Dashboard: Deprecation of hashKeys field

Fixed

• Global: Redis TLS version specification

tyk-stack 1.0.0, tyk-oss 1.2.0, tyk-data-plane 1.1.0, tyk-gateway 1.2.0, tyk-pump 1.2.0, tyk-dashboard 1.0.0, tyk-dev-portal 1.0.0, tyk-bootstrap 1.0.0

Open Source (Mozilla Public License)

Support Lifetime

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

Release Date 7 Dec 2023

Breaking Changes

• Updated the default service type of Gateway, Dashboard, Developer Portal, and Pump from NodePort to ClusterIP for better security. You can configure external access to a service with your desired method like changing service type to NodePort, LoadBalancer or configuring Ingress.
• Removed global.components.dashboard flag as it was misleading. Adapted gateway to use a gateway-specific flag gateway.useDashboardAppConfig. Set gateway.useDashboardAppConfig to true if gateway should connect to Dashboard for app configurations.

Deprecations

There are no deprecations in this release.

Upgrade instructions

You can use helm upgrade to upgrade your release

helm upgrade [RELEASE_NAME] tyk-helm/tyk-oss

Release Highlights

This version upgrades Tyk Gateway and Tyk Dashboard to v5.2.3 and Tyk Portal to 1.8.0.

Stable release of Tyk Stack, Tyk Dashboard, Tyk Developer Portal and bootstrapping 🎉

tyk-stack provides the default deployment of Tyk Self Managed on a cluster. It will deploy all required Tyk components with the settings provided in the values.yaml file.

Components charts for Tyk Dashboard, Tyk Developer Portal are also available if you want to manage deployment of Dashboard and Developer portal independently.

Please visit Tyk Docs for installation instructions.

New Gateway parameters

This version enhances Gateway charts by introducing configurations for OpenTelemetry. Their usage can be found in values.yaml:

    # opentelemetry is used to configure opentelemetry for Tyk Gateway
    opentelemetry:
      # Used to enable/disable opentelemetry
      enabled: false
      # exporter is used to define the type of the exporter to sending data in OTLP protocol
      # Valid values are "grpc" or "http"
      exporter: grpc
      # endpoint defines OpenTelemetry collector endpoint to connect to.
      endpoint: localhost:4317
      # A map of headers that will be sent with HTTP requests to the collector.
      # It should be set to map of string to string
      headers: {}
      # Timeout for establishing a connection to the collector
      connectionTimeout: 1
      # Name of the resource that will be used to identify the resource.
      resourceName: tyk
      # Type of the span processor to use. Valid values are “simple” or “batch”.
      spanProcessorType: batch
      # Type of the context propagator to use. Valid values are "tracecontext" and "b3".
      contextPropagation: tracecontext
      # TLS configuration for the exporter.
      tls:
        # Flag that can be used to enable TLS
        enabled: false
        # Flag that can be used to skip TLS verification if TLS is enabled
        insecureSkipVerify: true
        # Maximum TLS version that is supported.
        maxVersion: 1.3
        # Minimum TLS version that is supported
        minVersion: 1.2
        # Path to the cert file
        certFileName: ""
        # Path to the key file
        keyFileName: ""
        # Path to CA file
        caFileName: ""
        # Existing secret that stores TLS and CA Certificate
        certificateSecretName: ""
        # Mount path on which certificate secret should be mounted
        secretMountPath: ""
      sampling:
        # Refers to the policy used by OpenTelemetry to determine whether a particular trace should be sampled or not.
        type: "AlwaysOn"
        # Parameter for the TraceIDRatioBased sampler type and represents the percentage of traces to be sampled.
        rate: 0.5
        # Rule that ensures that if we decide to record data for a particular operation, we’ll also record data for
        # all the subsequent work that operation causes
        parentBased: false

Compatibility Notes

This release is tested on Kubernetes 1.26.3, 1.25.2, 1.24.6, 1.23.12, 1.22.15, 1.21.14, 1.20.15, Tyk Gateway v5.2.3, Tyk Dashboard v5.2.3, Tyk Pump v1.8.3, and Tyk Portal v1.8.0.

tyk-bootstrap-1.0.0 |
tyk-dashboard-1.0.0 |
tyk-data-plane-1.1.0 |
tyk-dev-portal-1.0.0 |
tyk-gateway-1.2.0 |
tyk-oss-1.2.0 |
tyk-pump-1.2.0 |
tyk-stack-1.0.0

---

tyk-bootstrap-1.0.0

Changelog

Added

• Added a field global.components.bootstrap to enable or disable bootstrapping.
• Added extraEnvs to support setting environment variables for jobs.

Changed

• Bootstrapping Job does not fail if there is existing ORG found in dashboard storage. If the database has been bootstrapped already, the job will proceed with creating secret with Operator and Developer Portal.
• Renamed environment variable names to be consistent with envconfig naming convention. The list of supported environment variables are documented at tyk-k8s-bootstrap.
• Remove .cluster.local from service URL to allow for named cluster support.

Removed

• Removed annotation [sidecar.istio.io/inject:](http://sidecar.istio.io/inject:) “false” from postInstall and preDelete jobs. If Tyk is deployed inside Istio service mesh, you can configure the required annotation for all jobs using values.yaml file.
• Removed unused fields from tyk-bootstrap chart values.yaml: global.servicePorts and global.components, global.tls.gateway.

tyk-dashboard-1.0.0

Changelog

Added

• Added Ingress configuration for dashboard and classic portal.
• In tyk-dashboard, a new field (dashboard.tykApiHost) allows configuring a custom service name for Tyk Gateway.

Fixed

• Fixed gateway connection string at environment variable TYK_DB_TYKAPI_HOST and TYK_DB_TYKAPI_PORT.
• Aligned the value of dashboard.overrideHostname with gwHostName yaml anchor.
• Fixed setting TYK_DB_ENABLEAGGREGATELOOKUPS via dashboard.enableAggregateLookups.
• Fixed the issue that Dashboard version <= 5.0.2 failed to start because of missing configuration file (tyk_analytics.conf). In order to fix that, if the dashboard version is <= v5.0.2, it runs init-container to create empty tyk_analytics.conf file.

Changed

• Updated Dashboard default image tag to v5.2.3.
• Updated default value for PostgreSQL sslmode (global.postgres.sslmode) from empty to disable.

• Updated default service type of Dashboard service from NodePort to ClusterIP.
• Removed .cluster.local from service URL to allow for named cluster support.

Removed

• Removed annotation traffic.sidecar.istio.io/excludeInboundPorts and traffic.sidecar.istio.io/includeInboundPorts. If Tyk is deployed inside Istio service mesh, you can configure the required annotation using values.yaml file.
• Removed support for dashboard.enableIstioIngress field in values.yaml.

tyk-data-plane-1.1.0

Breaking Changes

• Updated the default service type of Gateway and Pump service from NodePort to ClusterIP for better security. You can configure external access to a service with your desired method like changing service type to NodePort, LoadBalancer, or configuring Ingress.

Changelog

Added

• Added OpenTelemetry support under tyk-gateway.gateway.opentelemetry.

Updated

• Updated Gateway default image tag to v5.2.3.
• Updated the default service type of Gateway and Pump service from NodePort to ClusterIP. You can configure external access to a service with your desired method like changing service type to NodePort, LoadBalancer, or configuring Ingress.
• Removed .cluster.local from service URL to allow for named cluster support.

tyk-dev-portal-1.0.0

Changelog

Updated

• Updated Developer Portal default image tag to v1.8.0.
• Updated the default service type of Gateway and Pump service from NodePort to ClusterIP for better security. You can configure external access to a service with your desired method like changing service type to NodePort, LoadBalancer, or configuring Ingress.
• Updated default storage type in values.yaml from fs to db. The new default option does not require additional configuration to work.
• Updated liveliness probe from / to /live and readiness probe from / to /ready.
• Moved the database related variables in the values.yaml outside the section related to the storage of the assets inside enterprise portal. This reduces confusion, facilitating database configuration.
• Updated setting Dashboard URL in Portal using service discovery.
• User can provide developer portal configurations via secret useSecretName instead of global.secrets.useSecretName. This is to make it easier to manage portal and dashboard configuration separately.

Removed

• Removed field global.bootstrap.devPortal. You can now set both global.components.bootstrap and tyk-bootstrap.bootstrap.devPortal to true to enable portal bootstrapping.

tyk-gateway-1.2.0

Breaking Changes

• Updated the default service type of Gateway service from NodePort to ClusterIP. You can configure external access to service with your desired method like changing service type to NodePort, LoadBalancer, or configuring Ingress.

Changelog

Added

• Added OpenTelemetry support under gateway.opentelemetry.
• In tyk-gateway, new fields (`dashboardConnection...