Skip to content

Latest commit

 

History

History
1169 lines (845 loc) · 50 KB

CHANGELOG.md

File metadata and controls

1169 lines (845 loc) · 50 KB
Raw

Changelog

For releases from v0.24.0 forward, you can find the changelog in Github releases: https://github.com/grafana/tanka/releases

0.23.1 (2022-09-28)

Bug Fixes/Enhancements

  • export: Fix getSnippetHash not considering all files #765

0.23.0 (2022-09-26)

Features

  • cli/tanka: Add new --auto-approve=(always|never|if-no-changes) option to the apply command #754
  • cli/export: Expand merging capabilities with new --merge-strategy flag #760

Bug Fixes/Enhancements

  • cli/tanka: Use exact match to find context from API server #750
  • helm: Handle dirs missing the Chart.yaml file #752
  • export: getSnippetHash: Use regexp instead of parsing whole AST for performance #758

0.22.1 (2022-06-15)

Bug Fixes/Enhancements

  • helm: Fix vendor --prune deleting charts with a custom directory #717
  • helm: Add validation at vendoring time for invalid chart names #718
  • helm: Fix cross-device link error when tmp is mounted on a different device #720

0.22.0 (2022-06-03)

Features

  • cli: Add lint command #592
  • cli: Support a diff-strategy of "none" for "tk apply" to suppress diffing #700 (jphx)
  • cli: Add a fallback to inline environment when path doesn't exist #637 (josephglanville)
  • kubectl: Support interactive diff utilities #690 (partcyborg)
  • helm: Allow defining a custom dir for each chart #706
  • helm: Add --prune option to the vendor command #707
  • helm: Check for output dir conflicts #710
  • cli/tanka: Adds support for contextNames in tk env subcommands #704 (Nashluffy)

Bug Fixes/Enhancements

  • helm: Compare semvers when checking if existing chart is up-to-date #702 (kklimonda-fn)
  • tanka: Omit empty apiServer or contextNames when listing environments #709
  • export: Fix caching in case of missing import #712
  • helm: Tighten validations for add and add-repo commands #713
  • cli/export: Un-hide the memory ballast setting #714

0.21.0 (2022-04-28)

Features

  • cli: Add Apple Silicon binary #685 (BeyondEvil)
  • tanka/cli: Add server-side apply mode #651 (smuth4)
  • tanka: Adds support for specifying valid context names for an environment #674 (Nashluffy)

Bug Fixes/Enhancements

  • cli: Remove backticks from -inject-labels flag desc #688 (colega)
  • tanka: Fix target must be a non-nil pointer #684 (maoueh)
  • tanka: Upgrade to Go 1.18 + Upgrade dependencies #697

0.20.0 (2022-02-01)

Features

  • jsonnet: Update go-jsonnet to version 0.18.0 #660
  • cli: Add --dry-run kubectl option #667
  • helm: Add option to pass --skip-tests #654 (jouve)
  • export: Introduce a configurable memory ballast #669

0.19.0 (2021-11-22)

Notice

The go.yaml library's version lock was removed. Sequence items in YAML generated from the manifestYamlFromJson native function will have a different indent level.

If you are exporting manifests from multiple environments with tk export and you wish to do it gradually, you can do it using the --selector argument. Here's an example where environments have a cluster label:

// Export the dev cluster with the new version
tk-new export outputs-dir tanka-dir --merge --selector cluster=dev
// Export other clusters with the old version
tk export outputs-dir tanka-dir --merge --selector cluster!=dev

Bug Fixes

  • helm: match Add() and AddRepos() and correct typos #641 (redradrat)
  • yaml: Remove yaml.v3's version lock #643

0.18.2 (2021-10-14)

Features

  • cli: Add --max-stack jsonnet option #619

Bug Fixes/Enhancements

  • cli: If there's a full match on an inline environment name, use it #620
  • cli: Add instructions to use --name on multiple envs error #621
  • export: Remove unnecessary os.Stat in eval cache #624
  • tanka: Upgrade to Go 1.17 #625
  • jsonnet: Fix std.thisFile #626

0.18.1 (2021-10-04)

Bug Fixes

  • kubernetes: Fix api-resources table parsing #605
  • yaml: Revert yaml.v3 bump due to changes to indent #616

0.18.0 (2021-10-01)

Features

  • export: Implement environment caching for tk export #603
  • cli: Allow partial matches in the --name option #613

Bug Fixes

  • tanka: Check executable prefix before calling stat #601 (neerolyte)
  • cli: Add hint to inline environment error #606
  • cli: Bump cli to 0.2.0 #611
  • cli: Add check to prevent using spec.json and inline envs simultaneously #614

0.17.3 (2021-08-16)

Features

  • docker: Add Kustomize binary (#597)

0.17.2 (2021-08-10)

Bug Fixes

  • export: Add more context when extract fails (#583)
  • tanka: Do not remove data, hide it (#585)

0.17.1 (2021-07-08)

Bug Fixes

  • cli: Preserve compatibility for tk init --k8s=false (#582) (harmjanblok)

0.17.0 (2021-07-02)

🎉 Big shout out to the community in this release, well done!

Features

  • helm: Add support to specify --kube-version (#578) (@olegmayko)
  • kubectl: Add "validate" diff strategy with kubectl diff --server-side (#538)

Bug Fixes

  • helm: Pass multiple --api-versions flags (#576) (@jtdoepke)
  • jsonnet: Handle TLA code properly (#574) (@mihaitodor)
  • export: Make --format respect "/" in template actions (#572) (@dewe)

0.16.0 (2021-06-01)

✨ Tanka now defaults to k8s-alpha

tk init will now install k8s-alpha as the default library for k.libsonnet. It is currently defaults to Kubernetes v1.20 however you can pick your own version or disable it:

tk init --k8s=1.18
tk init --k8s=false

Features

Bug Fixes

  • kubernetes: Remove resources with altered state (#539) (@StevenPG)

0.15.1 (2021-04-27)

Features

  • helm: Add support for --no-hooks switch in Helm template (#545) (@PatTheSilent)
  • export: Only call FindEnvs once (#553)

Bug Fixes

  • kubernetes: Don't fail on listing namespaces (#549)

0.15 (2021-03-22)

Half the changes introduced in this version come from the community, great job y'all!

⚠️ Pruning label changed

With enabling pruning on inline environments (#511) we fixed pruning. Instead of just setting the prune label tanka.dev/environment to the environment name, Tanka now sets it to a hash of the environment name and path it is on.

This solves 2 problems:

  • Ensures pruning works properly on inline environments.
  • Label values in Kubernetes have a 63 characters limit, environment names can be longer.

The effect of this is that all environments using spec.injectLabels will show a diff on the tanka.dev/environment label. To ensure a proper migration, execute tk apply and tk prune with Tanka v0.14 before running v0.15 so all stale objects are pruned before the label changes.

Thanks @craigfurman for pulling this together.

Features

  • cli: Add tk env add|set --inject-labels flag (#505) (@curusarn)
  • cli: Add tk diff --exit-zero flag (#506) (@craigfurman)
  • cli: tk env list sorts environments by name (#521)
  • cli: Pruning warns before deleting namespaces (#531)
  • cli: Add tk status --name flag and sort Spec.data (#533)
  • tooling: tk tool imports works on both files and paths (#517)
  • kubernetes: support .metadata.generateName (#529) (@wojciechka)
  • helm: Only update helm repositories when necessary (#535) (@craigfurman)

Bug Fixes

  • cli ✨: Enable pruning on inline environments (#511) (@craigfurman)
  • cli: Do not silently fail on find/List (#515)
  • cli: Split diff and non-diff output (#537) (@craigfurman)
  • tooling: tk tool imports shows path info to error message (#518)
  • jsonnet: TLA in export panic (#519) (@morlay)

0.14 (2021-02-03)

🏗️ Multiple inline environments

As a next step in the inline environment area, this release supports multiple inline environments. In case there are multiple environments in your workflow, you can use --name to specify the environment you want to diff or apply.

tk apply --name us-central1 environments/dev
tk diff --name europe-west2 environments/prod

🔨 Export multiple environments

As part of Grafana Labs' continuous delivery setup, we developed a fast and effective way to export all our environments. In v0.14, we have built this into tk export.

⚠️ breaking change: the arguments for tk export have switched places!

path to an environment can be added multiple times:

tk export <outputDir> <path> [<path>...] [flags]

Some examples:

# Format based on environment {{env.<...>}}
$ tk export exportDir environments/dev/ --format '{{env.metadata.labels.cluster}}/{{env.spec.namespace}}//{{.kind}}-{{.metadata.name}}'
# Export multiple environments
$ tk export exportDir environments/dev/ environments/qa/
# Recursive export
$ tk export exportDir environments/ --recursive
# Recursive export with labelSelector
$ tk export exportDir environments/ -r -l team=infra

Features

  • tanka ✨: Handle multiple inline environments (#476)
  • jsonnet: Vendor jsonnet v0.17.0 (#445)
  • cli: Extend Tanka with scripts through tk- prefix on PATH (#412)
  • cli ✨: Export multiple environments with a single tk export command (#450)
  • cli: Initialize inline environments (#451)
  • cli: Add Helm Chart repositories with tk tool charts add-repo (#455)
  • cli: Add --with-prune option for tk diff (#469) (@curusarn)
  • api: Loader interface (#459, #467)
  • api: Faster environment discovery and faster tk env list (#468)

Bug Fixes

  • jpath: Support nested calling again (#456)
  • cli: Ensure TLACode works with EvalScript (#464)
  • jsonnet: Restore tk.env (#482, #498)

BREAKING

  • cli: The argument order of tk export changed due to #450:
# old:
$ tk export <environment> <outputDir>

# new:
$ tk export <outputDir> <environment> [<environment...>]

0.13 (2020-12-11)

🏗️ Inline environments

One of the most debated features of the past months has landed: defining Tanka Environments inline. It is now possible to leverage all powerful Jsonnet concepts to modify your Tanka Environments. See https://tanka.dev/inline-environments for more details.

☸️ Kustomize support

In 0.12 we brought in Helm support, similarly Tanka now also comes with Kustomize support.

  • We have refactored helm-util into tanka-util to support both helm.template() and kustomize.build() use cases from a common base.
  • Jsonnet-native overwriting of Kustomizations

Have a look at https://tanka.dev/kustomize on how to use all this goodness. Also https://tanka.dev/helm has been updated to match the library changes.

This feature is currently experimental. We believe it is feature complete, but further usage in the field may lead to adjustments

✨ Export JSONNET_PATH

Tanka ❤️ Jsonnet, and so do you. With this release, you can now access the JSONNET_PATH that Tanka uses to find all libraries. Try something this in your environment:

$ JSONNET_PATH=$(tk tool jpath environments/prometheus) jsonnet-lint environments/prometheus/main.jsonnet

💬 Github Discussions

The Tanka project is trying out GitHub Discussions as the primary support channel:

  • 🔍 It is searchable, so information never gets lost in Slack again
  • 👥 No longer sign-up for two platforms
  • 📣 Reach both, the team and other community members

Head over to https://github.com/grafana/tanka/discussions and start the discussion!

Features

  • jsonnet: Allow alternative entrypoints (#389)
  • jsonnet ✨: Support for inline environment (#403)
  • jsonnet, cli ✨: tk tool jpath can be used to export JSONNET_PATH (#427)
  • jsonnet, docker: Add openssh-client to Docker image (#429) (@xvzf)
  • k8s ✨: Render Kustomize into Jsonnet (#422)
  • k8s: Add metadata.Namespace directive, always the path relative to the project root (#435)
  • helm: Chart tool: Check chart versions and update accordingly (#420) (@craigfurman)
  • helm,docker: Add helm client to Docker image (#430) (@ducharmemp)
  • api: Introduce the concept of Evaluators (#431)

Bug Fixes

  • helm: Chart tool: Detect already pulled charts (#402) (justinwalz)
  • helm: Chart tool: Use new URL for stable helm repo (#425)
  • cli: Environment path as name relative to the project root (#404) (mwasilew2)
  • cli: Normalize tk fmt paths on Windows (#411) (nlowe)
  • cli: Confirmation prompts on Windows (#413) (nlowe)

0.12 (2020-10-05)

Like good wine, some things need time. After 3 months of intense development we have another Tanka release ready:

☸️ Helm support

This one is huge! Tanka can now load Helm Charts:

  • helm-util provides helm.template() to load them from inside Jsonnet
  • Declarative vendoring using tk tool charts
  • Jsonnet-native overwriting of chart contents

Just by upgrading to 0.12, you have access to every single Helm chart on the planet, right inside of Tanka! Read more on https://tanka.dev/helm

This feature is currently experimental. We believe it is feature complete, but further usage in the field may lead to adjustments

🏠 Top Level Arguments

Tanka now supports the --tla-str and --tla-code flags from the jsonnet cli to late-bind data into the evaluation in a well-defined way. See https://tanka.dev/jsonnet/injecting-values for more details.

✨ Inline Eval

Ever wanted to pull another value out of Jsonnet that does not comply to the Kubernetes object rules Tanka imposes onto everything? Wait no longer and use tk eval -e:

$ tk eval environments/prometheus -e prometheus_rules

Above returns $.prometheus_rules as JSON. Every Jsonnet selector is supported:

$ tk eval environments/prometheus -e 'foo.bar[0]'

Features

  • k8s, jsonnet ✨: Support for Helm. In combination with helm-util, Tanka can now load resources from Helm Charts. (#336)
  • k8s: Default metadata from spec.json (#366)
  • helm: Charttool: Adds tk tool charts for easy management of vendored Helm charts (#367), (#369)
  • helm: Require Helm Charts to be available locally (#370)
  • helm: Configurable name format (#381)
  • cli: Filtering (-t) now supports negative expressions (-t !deployment/.*) to exclude resources (#339)
  • cli ✨: Inline eval (Use tk eval -e to extract nested fields) (#378)
  • cli: Custom paging (PAGER env var) (#373)
  • cli: Predict plain directories if outside a project (#357)
  • jsonnet ✨: Top Level Arguments can now be specified using --tla-str and --tla-code (#340)

Bug Fixes

  • yaml: Pin yaml library to v2.2.8 to avoid whitespace changes (#386)
  • cli: Actually respect TANKA_JB_PATH (#350)
  • k8s: Update kubectl v1.18.0 warning (#371)
  • jsonnet: Load main.jsonnet using full path. This makes std.thisFile usable (#370)
  • jsonnet: Import path resolution now works on Windows (#331)
  • jsonnet: Arrays are now supported at the top level (#321)

BREAKING

  • api: Struct based Go API: Modifies our Go API (github.com/grafana/tanka/pkg/tanka) to be based on structs instead of variadic arguments. This has no impact on daily usage of Tanka. (#376)
  • jsonnet: ExtVar flags are now --ext-str and --ext-code (were --extVar and --extCode) (#340)

0.11.1 (2020-07-17)

This is a minor release with one bugfix and one minor feature.

Features

  • process: With 0.11.0, tanka started automatically adding namespaces to all manifests it processed. We updated this to not add a namespace to cluster-wide object types in order to make handling of these resources more consistent in different workflows. (#320)

Bug Fixes

  • export: Fix inverted logic while checking if a file already exists. This broke tk export entirely. (#317)

0.11.0 (2020-07-07)

2 months later and here we are with another release! Packed with many detail-improvements, this is what we want to highlight:

✨ Enhanced Kubernetes resource handling

From now on, Tanka handles the resources it extracts from your Jsonnet output in an enhanced way:

  1. Lists: Contents of lists, such as RoleBindingList are automatically flattened into the resource stream Tanka works with. This makes sure they are properly labeled for garbage collection, etc.
  2. Default namespaces: While you could always define the default namespace (the one for resources without an explicit one) in spec.json, this information is now also persisted into the YAML returned by tk show and tk export. See https://tanka.dev/namespaces for more information.

🔨 More powerful exporting

tk export can now do even more than just writing YAML files to disk:

  1. --extension can be used to control the file-extension (defaults to .yaml)
  2. When you put a / in your --format for the filename, Tanka creates a directory or you. This allows e.g. sorting by namespace: --format='{{.metadata.namespace}}/{{.kind}}-{{.metadata.name}}'
  3. Using --merge, you can export multiple environments into the same directory tree, so you get the full YAML picture of your entire cluster!

📠 Easier shell scripting

The tk env list command now has a --names option making it easy to operate on multiple environments:

# diff all environments:
for e in $(tk env list --names); do
  tk diff $e;
done

Also, to use a more granular subset of your environments, you can now use --selector / -l to match against metadata.labels of defined in your spec.json:

$ tk env list -l status=dev

Features

  • cli: tk env list now supports label selectors, similar to kubectl get -l (#295)
  • cli: If spec.apiServer of spec.json lacks a protocol, it now defaults to https (#289)
  • cli: tk delete command to teardown environments (#313)
  • cli: Support different file-extensions than .yaml for tk export (#294) (@marthjod)
  • cli: Support creating sub-directories in tk export (#300) (@simonfrey)
  • cli: Allow writing into existing folders during tk export (#314)
  • tooling: tk tool imports now follows symbolic links (#302), (#303)
  • process: List types are now unwrapped by Tanka itself (#306)
  • process: Automatically set metadata.namespace to the value of spec.namespace if not set from Jsonnet (#312)

Bug Fixes

  • jsonnet: Using import "tk" twice no longer panics (#290)
  • tooling: tk tool imports no longer gets stuck when imports are recursive (#298)
  • process: Fully deterministic recursion, so that error messages are consistent (#307)

0.10.0 (2020-05-07)

New month, new release! And this one ships with a long awaited feature:

✨ Garbage collection

Tanka can finally clean up behind itself. By optionally attaching a tanka.dev/environment label to each resource it creates, we can find these afterwards and purge those removed from the Jsonnet code. No more dangling resources!

⚠️ Keep in mind this is still experimental!

To get started, enable labeling in your environment's spec.json:

  "spec": {
+   "injectLabels": true,
  }

Don't forget to tk apply afterwards! From now on, Tanka can clean up using tk prune.

Docs: https://tanka.dev/garbage-collection

⛵ Logo

Tanka now has it's very own logo, and here it is:

📦 Package managers

Tanka is now present in some package managers, notably brew for macOS and the AUR of ArchLinux! See the updated install instructions to make sure to use these if possible.

Features:

  • cli: TANKA_JB_PATH environment variable introduced to set the jb binary if required (#272). Thanks @qckzr
  • kubernetes: Garbage collection (#251)

Bug Fixes

  • kubernetes: Resource sorting is now deterministic (#259)

0.9.2 (2020-04-19)

Mini-release to fix an issue with our Makefile (required for packaging). No changes in functionality.

Bug Fixes

  • build: Enable static Makefile target on all operating systems (#262)

0.9.1 (2020-04-08)

Small patch release to fix a panic issue with tk apply.

Bug Fixes

  • kubernetes: don't panic on failed diff (#256)

0.9.0 (2020-04-07)

This release includes a critical fix, update ASAP.

Another Tanka release is here, just in time for Easter. Enjoy the built-in formatter, much more intelligent apply and several important bug fixes.

🚨 Alert: kubectl diff changes resources 🚨

The recently released kubectl version v1.18.0 includes a critical issue that causes kubectl diff (and so tk diff as well) to apply the changes.

This can be very harmful, so Tanka decided to require you to downgrade to v1.17.x, until the fix in kubectl version v1.18.1 is released.

✨ Highlight: Jsonnet formatter (tk fmt)

Since jsonnetfmt was rewritten in Go recently, Tanka now ships it as tk fmt. Just run tk fmt . to keep all Jsonnet files recursively formatted.

🚀 Highlight: Sorting during apply

When using tk apply, Tanka now automatically sorts your objects based on dependencies between them, so that for example CustomResourceDefinitions created before being used, all in the same run. No more partly failed applies!

Features

  • kubernetes ✨: Objects are now sorted by dependency before apply (#244)
  • cli: Env var TANKA_KUBECTL_PATH can now be used to set a custom kubectl binary (#221)
  • jsonnet ✨ : Bundle jsonnetfmt as tk fmt (#241)
  • docker: The Docker image now includes GNU less, instead of the BusyBox one (#232)
  • docker: Added kubectl, jsonnet-bundler, coreutils, git and diffutils to the Docker image, so Tanka can be fully used in there. (#243)

Bug Fixes

  • cli: The diff shown on tk apply is now colored again (#216)
  • client: The namespace patch file saved to a temporary location is now removed after run (#225)
  • client: Scanning for the correct context won't panic anymore, but print a proper error (#228)
  • client: Use os.PathListSeparator during context patching, so that Tanka also works on non-UNIX platforms (e.g. Windows) (#242)
  • kubernetes 🚨: Refuse to diff on kubectl version v1.18.0, because of above mentioned unfixed issue (#254)
  • kubernetes: Apply no longer aborts when diff fails (#231)
  • kubernetes ✨: Namespaces that will be created in the same run are now properly handled during diff (#237)

Other

  • cli: Migrates from spf13/cobra to much smaller go-clix/cli. This cuts our dependencies to a minimum. (#235)

0.8.0 (2020-02-13)

(@xvzf) The next big one is here! Feature packed with environment overriding and tk export. Furthermore lots of bugs were fixed, so using Tanka should be much smoother now!

Highlight: Overriding vendor per Environment (#198)

It is now possible, to have a vendor/ directory managed by jb on an environment basis: https://tanka.dev/libraries/overriding. This means you can test out changes in libraries in single environments (like dev), without affecting others (like prod).

Notice:

Changes done in the last release (v0.7.1) can cause indentation changes when using std.manifestYAMLFromJSON(), related to bumping gopkg.in/yaml.v2 to gopkg.in/yaml.v3.
Please encourage all your teammembers to upgrade to at least v0.7.1 to avoid whitespace-only diffs on your projects.

Features

  • cli: tk export can be used to write all generated Kubernetes resources to .yaml files

Bug Fixes

  • kubernetes: Fail on diff when kubectl had an internal error (#213)
  • kubernetes: Stop injecting namespaces into wrong places:
    Tanka was injecting the default namespace into resources of all kinds, regardless of whether they actually took one. This caused errors, so we stopped doing this. From now on, the default namespace will only be injected when the resource is actually namespaced. (#208)
  • cli: tk diff colors:
    Before, the coloring was unstable when scrolling up and down. We fixed this by pressing CAPS-LOCK.
    Furthermore, the output of tk diff now also works on light color schemes, without messing up the background color. (#210)
  • cli: Proper --version output:
    The release binaries now show the real semver on tk --version, instead of the git commit sha. (#201)
  • cli: Print diff on apply again:
    While refactoring, we accidentally forgot to dereference a pointer, so that tk apply showed a memory address instead of the actual differences, which was kinda pointless. (#200)

0.7.1 (2020-02-06)

This is a smaller release focused on critical bug fixes and some other minor enhancements. While features are included, none of them are significant, meaning they are part of a patch release.

Critical: parseYaml works now

Before, std.native('parseYaml') did not work at all, a line of code got lost during merge/rebase, resulting in parseYaml returning invalid data, that Jsonnet could not process. This issue has been fixed in (#195).

Jsonnet update

The built-in Jsonnet compiler has been upgraded to the lastest master 07fa4c0. In some cases, this should provide up to 50% more speed, especially when base64 is involved, which is now natively implemented. (#196)

Features

  • cli: tk env set|add has been extended by --server-from-context, which allows to parse $KUBECONFIG to find the apiServer's IP directly from that file, instead of having to manually specify it by hand. (#184)
  • jsonnet: vendor overrides:
    It is now possible to have a vendor/ directory per environment, so that updating upstream libraries can be done gradually. (#185)
  • kubernetes: disable kubectl validation: tk apply now takes --validate=false to pass that exact flag to kubectl as well, for disabling the integrated schema validation. (#186)

Bug Fixes

  • jsonnet, cli: Stable environment name: The value of (import "tk").env.name does not anymore depend on how Tanka was invoked, but will always be the relative path from <rootDir> to the environment's directory. (#182)
  • jsonnet: The nativeFunc parseYaml has been fixed to actually return a valid result (#195)

0.7.0 (2020-01-21)

The promised big update is here! In the last couple of weeks a lot has happened.

Grafana Labs announced Tanka to the public, and the project got a lot of positive feedback, shown both on HackerNews and in a 500+ increase in GitHub stars!

While we do not ship big new features this time, we ironed out many annoyances and made the overall experience a lot better:

Better website + tutorial (#134)

Our new website is published! It does not only look super sleek and performs like a supercar, we also revisited (and rewrote) the most of the content, to provide especially new users a good experience.

This especially includes the new tutorial, which gives new and probably even more experienced users a good insight into how Tanka is meant to be used.

🚨🚨 Disabling import ".yaml" (#176) 🚨🚨

Unfortunately, we had to disable the feature that allowed to directly import YAML files using the familiar import syntax, introduced in v0.6.0, because it caused serious issues with importstr, which became unusable.

While our extensions to the Jsonnet language are cool, it is a no-brainer that compatibility with upstream Jsonnet is more important. We will work with the maintainers of Jsonnet to find a solution to enable both, importstr and import ".yaml"

Workaround:

- import "foo.yaml"
+ std.parseYaml(importstr "foo.yaml")

k.libsonnet installation (#140)

Previously, installing k.libsonnet was no fun. While the library is required for nearly every Tanka project, it was not possible to install it properly using jb, manual work was required.

From now on, Tanka automatically takes care of this. A regular tk init installs everything you need. In case you prefer another solution, disable this new thing using tk init --k8s=false.

Features

  • cli, kubernetes: k.libsonnet is now automatically installed on tk init (#140):
    Before, installing k.libsonnet was a time consuming manual task. Tanka now takes care of this, as long as jb is present on the $PATH. See https://tanka.dev/tutorial/k-lib#klibsonnet for more details.
  • cli: tk env --server-from-context:
    This new flag allows to infer the cluster IP from an already set up kubectl context. No need to remember IP's anymore – and they are even autocompleted on the shell. (#145)
  • cli, jsonnet: extCode, extVar:
    -e / --extCode and --extVar allow using std.extVar() in Tanka as well. In general, -e is the flag to use, because it correctly handles all Jsonnet types (string, int, bool). Strings need quoting! (#178)
  • jsonnet: The contents of spec.json are now accessible from Jsonnet using (import "tk").env. (#163)
  • jsonnet: Lists ([ ]) are now fully supported, at an arbitrary level of nesting! (#166)

Bug Fixes

  • jsonnet: nil values are ignored from the output. This allows to disable objects using the if ... then {} pattern, which returns nil if false (#162).
  • cli: -t / --target is now case-insensitive (#130)

0.6.1 (2020-01-06)

First release of the new year! This one is a quick patch that lived on master for some time, fixing an issue with the recent "missing namespaces" enhancement leading to apply being impossible when no namespace is included in Jsonnet.

More to come soon :D

0.6.0 (2019-11-27)

It has been quite some time since the last release during which Tanka has become much more mature, especially regarding the code quality and structure.

Furthermore, Tanka has just hit the 100 Stars 🎉

Notable changes include:

API (#97)

The most notable change is probably the Go API, available at https://godoc.org/github.com/grafana/tanka/pkg/tanka, which allows to use all features of Tanka directly from any other Golang application, without needing to exec the binary. The API is inspired by the command line parameters and should feel very similar.

Importing YAML (#106)

It is now possible to import .yaml documents directly from Jsonnet. Just use the familiar syntax import "foo.yaml" like you would with JSON.

Missing Namespaces (#120)

Tanka now handles namespaces that are not yet created, in a more user friendly way than `kubectl** does natively.
During diff, all objects of an in-existent namespace are shown as new and when applying, namespaces are applied first to allow applying in a single step.

Features

  • tool/imports: import analysis using upstream jsonnet: Due to recent changes to google/jsonnet, we can now use the upstream compiler for static import analysis (#84)
  • Array output: The output of Jsonnet may now be an array of Manifests. Nested arrays are not supported yet. (#112)

Bug Fixes

0.5.0 (2019-09-20)

This version adds a set of commands to manipulate environments (tk env add, rm, set, list) (#73). The commands are mostly ks env compatible, allowing tk env be used as a drop-in replacement in scripts.

Furthermore, an error message has been improved, to make sure users can differentiate between parse issues in .jsonnet and spec.json (#71).

0.4.0 (2019-09-06)

After nearly a month, the next feature packed release of Tanka is ready! Highlights include the new documentation website https://tanka.dev, regular expression support for targets, diff histograms and several bug-fixes.

Features

  • cli: tk show now aborts by default, when invoked in a non-interactive session. Use --dangerous-allow-redirect to disable this safe-guard (#47).
  • kubernetes: Regexp Targets: It is now possible to use regular expressions when specifying the targets using --target / -t. Use it to easily select multiple objects at once: https://tanka.dev/targets/#regular-expressions (#64).
  • kubernetes: Diff histogram: Tanka now allows to summarize the differences between the live configuration and the local one, by using the unix diffstat(1) utility. Gain a sneek peek at a change using tk diff -s .! (#67)

Bug Fixes

  • kubernetes: Tanka does not fail anymore, when the configuration file spec.json is missing from an Environment. While you cannot apply or diff, the show operation works totally fine (#56, #63).
  • kubernetes: Errors from kubectl are now correctly passed to the user (#61).
  • cli: tk diff does not output useless empty lines (\n) anymore (#62).

0.3.0 (2019-08-13)

Tanka v0.3.0 is here!

This version includes lots of tiny fixes and detail improvements, to make it easier for everyone to configure their Kubernetes clusters.

Enjoy target support, enhancements to the diff UX and an improved CLI experience.

Features

The most important feature is target support (#30) (caf205a): Using --target=kind/name, you can limit your working set to a subset of the objects, e.g. to do a staged rollout.

There where some other features added:

  • cli: autoApprove, forceApply (#35) (626b097): allows to skip the interactive verification. Furthermore, kubectl can now be invoked with --force.
  • cli: print deprecated warnings in verbose mode. (#39) (6de170d): Warnings about the deprecated configs are only printed in verbose mode
  • kubernetes: add namespace to apply preamble (#23) (9e2d927): The interactive verification now shows the metadata.namespace as well.
  • cli: diff UX enhancements (#34) (7602a19): The user experience of the tk diff subcommand has been improved:
    • if the output is too long to fit on a single screen, the systems PAGER is invoked
    • if differences are found, the exit status is set to 16.
    • When tk apply is invoked, the diff is shown again, to make sure you apply what you want

Bug Fixes

  • cli: invalid command being executed twice (#42) (28c6898): When the command failed, it was executed twice, due to an error in the error handling of the CLI.
  • cli: config miss (#22) (32bc8a4): It was not possible to use the new configuration format, due to an error in the config parsing.
  • cli: remove datetime from log (#24) (1e37b20)
  • kubernetes: correct diff type on 1.13 (#31) (574f946): On kubernetes 1.13.0, subset was used, although native is already supported.
  • kubernetes: Nil pointer deference in subset diff. (#36) (f53c2b5)
  • kubernetes: sort during reconcile (#33) (ab9c43a): The output of the reconcilation phase is now stable in ordering

0.2.0 (2019-08-07)

Features

  • cli: Completions (#7) (aea3bdf): Tanka is now able auto-complete most of the command line arguments and flags. Supported shells are bash, zsh and fish.
  • cmd: allow the baseDir to be passed as an argument (#6) (55adf80), (#12) (3248bb9): tk breaks with the current behaviour and requires the baseDir / environment to be passed explicitely on the command line, instead of assuming it as pwd. This is because it allows more go-like UX. It is also very handy for scripts not needing to switch the directory.
  • kubernetes: subset-diff (#11) (13f6fdd): tk diff support for version below Kubernetes 1.13 is here 🎉! The strategy is called subset diff and effectively compares only the fields already present in the config. This allows the (hopefully) most bloat-free experience possible without server side diff.
  • tooling: import analysis (#10) (ce2b0d3): Adds tk tool imports, which allows to list all imports of a single file (even transitive ones). Optionally pass a git commit hash, to check whether any of the changed files is imported, to figure out which environments need to be re-applied.

0.1.0 (2019-07-31)

This release marks the begin of tanka's history 🎉!

As of now, tanka aims to nearly seemlessly connect to the point where ksonnet left. The current feature-set is basic, but usable: The three main workflow commands are available (show, diff, apply), environments are supported, code-sharing is done using jb.

Stay tuned!

Features

  • kubernetes: Show (7c4bee8): Equivalent to ks show, allows previewing the generated yaml.
  • kubernetes: Diff (a959f38): Uses the kubectl diff to obtain a sanitized difference betweent the current and the desired state. Requires Kubernetes 1.13+
  • kubernetes: Apply (8fcb4c1): Applies the changes to the cluster (like ks apply)
  • kubernetes: Apply approval (4c6414f): Requires a typed yes to apply, gives the user the chance to verify cluster and context.
  • kubernetes: Smart context (2b3fd3c): Infers the correct context from the spec.json. Prevents applying the correct config to the wrong cluster.
  • Init Command (ff8857c): Initializes a new repository with the suggested directory structure.