v0.14.0

What's new?

Highlights

Snapshot tool usability enhancements

1. We have released the Tyk Operator docker image so you can run snapshot tool directly now,

e.g. docker run -it --rm --env-file=.env -v "$(pwd)":/dist tykio/tyk-operator:{tag} [FLAGS]

2. Allow use of --category flag with --separate flag, so you can export API definitions from one category and Policies into separate files.

For details, please refer to updated snapshot documentation here.

Improve performance and fix errors during reconciliation

1. Reduce number of external API calls to Tyk Gateway / Dashboard by calling Update API only if the hashes of an existing resource and updated resource is different during reconciliation.
2. Adds an additional check in delete method of ApiDefinition to handle unexpected status responses (500) from older version of Tyk Gateway while deleting non-existent APIs.
3. Adds an additional check in update method of ApiDefinition to handle update of a non-existent API. If ApiDefinition does not exist in Tyk, Operator will create it; otherwise, Operator will update it.

Notes on updating to v0.14.0

We have updated the control-plane labels from controller-manager to tyk-operator-controller-manager. It is to avoid selector issues if you are running multiple controllers that was built with kubebuilder. In case of helm upgrade failure, please delete and install tyk-operator again.

Change Log

Updated

• Update github workflow to test each PR against Tyk v4.0 as well (#546) @zalbiraw
• Allow Snapshot tool to filter by category regardless of the flags set (#565) @zalbiraw @buraksekili @singhpr
• Documentation of snapshot tool, in order to explain how to use Snapshot with Docker. (#581) @buraksekili @caroltyk
• Remove hardcoded TLS keys from integration tests to prevent possible CI failures (#580) (#589) @buraksekili

Added

• Added hostNetwork Support(#537) @rdcwaldrop1 @singhpr @buraksekili
• Added venom tests for operator regression test set (#562) @singhpr @komalsukhani
• Added a new test case to cover whether reconciliation covers creation of (#575) @buraksekili
• Added venom test for QA-1053-mock-response-plugin (#578) @singhpr
• Added Contribution Guideline (#576) @buraksekili

Fixed

• Remove ORGID from SecurityPolicy CRs while using Snapshot tool (#577) @zalbiraw @singhpr
• Prevent reading Kubernetes config while using operator snapshot as a CLI command (this means you don't need to have a running Kubernetes cluster when running operator snapshot). (#569) @buraksekili @letzya
• Fixed reconciliation failures when ApiDefinition does not exist on Tyk storage. (#561) (#566) @buraksekili @singhpr
• Fixed BDD tests dependency of curl. Instead of running curl within a container, implemented a port-forward mechanism to send raw HTTP requests to pods. (#570) @buraksekili
• Fixed extra Update calls to Tyk GW / Dashboard. If no changes are made to ApiDefinition resource, Operator won't send a request to Tyk GW / Dashboard. (#571) @buraksekili
• Updated control-plane labels from controller-manager to tyk-operator-controller-manager to avoid selector issues (#583) @zalbiraw @singhpr

Tested with

Tyk Gateway and Dashboard v3.2, v4.0, v4.3, v5.0
Kubernetes version v1.19.16, v1.20.15, v1.21.14, v1.22.15, v1.23.12, v1.24.6, v1.25.2