Gitiles
Code Review Sign In
gerrit.opencord.org / voltha-docker-tools / 5cb1cce82918daf118082c3132ce96376b58fc4a
commit5cb1cce82918daf118082c3132ce96376b58fc4a[log] [tgz]
authorMatteo Scandolo <matteo.scandolo@gmail.com>Thu Nov 19 17:39:13 2020 -0800
committerMatteo Scandolo <matteo.scandolo@gmail.com>Fri Nov 20 12:25:05 2020 -0800
treec15a5927b32c689c93aa7db3b4e40ee311729fc2
parent49a3545faa7f81604126477ecb2f5510d3db52b1 [diff]
Using golang:1.13.9-alpine as base container for the gocover-cobertura tool (it requires Golang to be installed)

Change-Id: Ie09642e350c579b4f759da4adad0ce766ec3673d
3 files changed
tree: c15a5927b32c689c93aa7db3b4e40ee311729fc2
  1. .dockerignore
  2. .gitreview
  3. Makefile
  4. README.md
  5. VERSION
  6. docker/
README.md

Dockerized Tools for Voltha

This repo contains Dockerfiles used to generate versioned tool containers.

Versioning

Final docker images are tagged with the image version from the VERSION file. This allows projects to specify a single "voltha toolchain version" and get all relevant tool versions.

The VERSION file should be changed using these rules:

  • Bump Patch version if:
    • Patch version of a tool has changed.
    • This repo's supporting files have changed (Makefile, readme, etc.) This rule assumes that the containers generated are backwards-compatible; if they are not, bump the major version instead.
  • Bump Minor version if:
    • Minor version of a tool has changed.
    • A new tool has been added.
  • Bump Major version if:
    • Major version of a tool has changed.
  • Bump patch/minor/major version according to semver rules if a Dockerfile is changed.
  • Reset lesser versions if greater versions change.
  • Do not use -dev versions.

Tool Usage

Only use containers tagged with <VERSION>-tool.
Do NOT use containers tagged with tool-<TOOL_VERSION>.

Some examples of how to use these containers:

  • golang - docker run --rm --user $(id -u):$(id -g) -v $PWD:/app -v gocache:/.cache -v gocache-${VOLTHA_TOOLS_VERSION}:/go/pkg voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-golang go <args>
  • golangci-lint - docker run --rm --user $(id -u):$(id -g) -v $PWD:/app -v gocache:/.cache -v gocache-${VOLTHA_TOOLS_VERSION}:/go/pkg voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-golangci-lint golangci-lint <args>
  • protoc - docker run --rm --user $(id -u):$(id -g) -v $PWD:/app voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-protoc protoc <args>
  • hadolint - docker run --rm --user $(id -u):$(id -g) -v $PWD:/app voltha/voltha-ci-tools:${VOLTHA_TOOLS_VERSION}-hadolint hadolint <args>

Details:

  • --user is specified so that generated files have sane ownership and permissions.
  • -v bind-mounts the local folder into the container.
  • -v is also used by golang containers to bind-mount volumes for caches.

Key Commands

  • make build to build containers
  • make lint to lint the Dockerfiles
  • make docker-push to push built containers to a registry