A log of all ksonnet release changes

v0.9.1 (2017-03-08)

This patch focuses on fixes around usability bugs.

Closed issues:

  • version 0.9 - ks show not picking up env param overrides [\#346](
  • ks delete default fails #342

Merged pull requests:

v0.9.0 (2017-03-05)

Iteration Plan

Full Changelog

To update older ksonnet applications, run ks upgrade --help.


This release focuses on two major areas:

  1. Changes to the underlying ksonnet-lib dependency and utilizing them in ks. The changes involve a major uplift to how the ksonnet language APIs are generated, so that support for future Kubernetes versions are easier.

  2. Improvements to the support for environments and components. Environments are now able to specify targets, to apply a subset of components as opposed to all components. We’ve introduced the concept of component namespaces to add division and hierarchy to components. We’ve also added commands to support removing and listing of components.

Changes to Environment Metadata

spec.json > app.yaml

In 0.8.0, each ks application contained a spec.json file per environment. This file contained the environment specification details; corresponding to a Kubernetes cluster server address and namespace.


  "server": "",
  "namespace": "default"

With 0.9.0, we will be consolidating majority of the application specification details into a top-level app.yaml file. As opposed to opening multiple files, this approach will make it easier for users to configure changes in a single place. Similar to spec.json, this metadata will be auto-generated when a environment is created or modified from the command line. However, it is also meant to be user-modifiable.


apiVersion: 0.0.1
      namespace: default
    k8sVersion: v1.7.0
    path: default
name: new
      commitSha: 422d521c05aa905df949868143b26445f5e4eda5
      refSpec: master
    protocol: github
version: 0.0.1

You will notice a couple new fields under the environments field.

  1. destination is identical to the contents of the previous spec.json, containing the server address and namespace that this environment points to.

  2. k8sVersion is the Kubernetes version of the server pointed to at the destination field.

  3. path is the relative path in the environments directory that contains other metadata associated with this environment. By default, path is the environment name.

Consolidation of lib files

In 0.8.0, each environment’s .metadata directory stored 3 files related to the generated ksonnet-lib. It was unecessary and also costly as the number of environments grow. We didn’t need to store multiple copies of the same API version on disk.

With 0.9.0, the Kubernetes API version that each environment uses will be recorded in the environment specification (as seen in the previous section). The metadata files are cached once locally per k8s API version in lib.

These files also no longer need to be checked into source control, as ks will auto-generate lib files that aren’t found.

Targets & Component Namespaces

In 0.8.0, there was no simple way for users to declare that a environment should only operate on a subset of components.

With 0.9.0, environments can now choose the set of components that they wish to operate (i.e., apply, delete, etc.) on. These targets can be specified in the app.yaml file, mentioned in an earlier section.

For example, if the components directory is structured as follows:

├── components
│   ├── auth
│   │   ├── ca-secret.jsonnet
│   │   ├── params.libsonnet
│   │   └── tls-certificate.jsonnet
│   ├── dev
│   │   ├── memcached.jsonnet
│   │   └── params.libsonnet
│   ├── params.libsonnet
│   └── prod
│   ...

An environment configuration in app.yaml may appear as follows:

    k8sVersion: 1.7.0
      namespace: default
      - auth
      - dev

In the above example, the dev environment would only operate on the components within the auth and dev component namespaces.

Note: Component files do not need to be namespaced. Top-level components and individual component files can also be referenced by targets.

Command Changes

ks component list

ks component list is a new command. See docs here.

ks component rm

ks component rm is a new command. See docs here.

ksonnet-lib Changes

  • Create Jsonnet AST printer
  • Convert ksonnet-lib generation process to Asonnet AST


Closed issues:

  • tutorial document as linked from Google seems semi-broken? #322
  • Incorrect imports in ks generated files #321
  • delete component ERROR strconv.Atoi: parsing “8+”: invalid syntax #316
  • ks param set when used with boolean does not create string value #311
  • Move custom constructors k8s.libsonnet to k.libsonnet #304
  • ERROR user: Current not implemented on linux/amd64 #298
  • Difficulty handling components unique to environments #292
  • ks delete ERROR strconv.Atoi #272
  • Create darwin binaries and make the available via brew #270
  • Unable to install packages with the same name under different registries #269
  • prototypes can’t rely on a registry name, but they do #262
  • Confirm that ksonnet-lib generation works for Kubernetes 1.9#260
  • ks can’t recognise the registry ‘kubeflow’#258
  • website is not available#256
  • ks init fails when using $KUBECONFIG env var#251
  • Badly formatted client-go version string#250
  • Remove components#243
  • List components#242

Merged pull requests:

v0.8.0 (2017-12-20)

Full Changelog

Implemented enhancements:

  • Package list/install is awkward #195
  • Rework demos/examples in light of #169 #194

Fixed bugs:

  • param set incorrectly supporting hyphenated param names #214
  • Makefile hardcodes version #198
  • Accurately read/write non-ASCII param identifiers #219 (jessicayuen)

Closed issues:

  • Packages should be able to depend on other packages #238
  • YAML components are currently disabled; docs say they aren’t #208
  • Confusing info in ks version #199
  • Support/document using github token to increase rate limits #196
  • Issue with redis-stateless prototype #193
  • ks version missing/incorrect data #170
  • Create binary releases #131
  • Check apiVersion numbers #75
  • Add links to #20

Merged pull requests: