Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 2.1 KB

DEVELOPMENT.md

File metadata and controls

78 lines (54 loc) · 2.1 KB
Raw

Tooling

Requirements

Requirement Purpose macOS
Go Compiler brew install go
Dep Dependency Management brew install dep
Docker Packaging Docker for Mac
jsonnet JSON templating tool brew install jsonnet
ffctl Gitlab CI format pip install ffctl

Usage

Testing

This project uses the built-in testing support for golang.

To run the tests for all go packages outside of the vendor directory, run:

$ make test

Building

Ensure your version of go is up to date; check that you're running v1.9 with the command:

$ go version

To build the go binary, run:

$ make build

Packaging

ALM is packaged as a set of manifests for a tectonic-x-operator specialization (tectonic-alm-operator).

A new version can be generated from the helm chart by:

  1. Modifying the deploy/tectonic-alm-operator/values.yaml file for the release to include new SHAs of the container images.
  2. Running the package make command, which takes a single variable (ver)

For example:

make ver=0.3.0 package

Will generate a new set of manifests from the helm chart in deploy/chart combined with the values.yaml file in deploy/tectonic-alm-operator, and output the rendered templates to deploy/tectonic-alm-operator/manifests/0.3.0.

See the documentation in deploy/tectonic-alm-operator for how to take the new manifests and package them as a new version of tectonic-alm-operator.

Dependency Management

Using make

These commands are handled for you via the Makefile. To install the project dependencies, run:

$ make vendor

To update dependencies, run:

$ make vendor-update
# verify changes
$ make test
$ make e2e-local-docker

The Makefile recipes for testing and builds ensure the project's dependencies are properly installed and vendored before running.