Gitiles
Code Review Sign In
gerrit.lfbroadband.org / voltha-docker-tools / 88200d31ecf7cbaa4e76367e25a8325953b23757
commit88200d31ecf7cbaa4e76367e25a8325953b23757[log] [tgz]
authorZack Williams <zdw@opennetworking.org>Thu Apr 02 13:36:41 2020 -0700
committerZack Williams <zdw@opennetworking.org>Thu Apr 02 14:48:18 2020 -0700
treec7ee460ee67e09e119f8adcc54f5de7ec08e2a1c
parent1f99b66cd5a75975f87dfad85b9b7562335b4638 [diff]
[VOL-2876]

Update grpc-gateway to a version with improved generation of swagger docs
Bump the golang and alpine image patch versions

Change-Id: Id8c772dd782b29586615d585a4cf6c756da0098c
5 files changed
tree: c7ee460ee67e09e119f8adcc54f5de7ec08e2a1c
  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