Sign inSign up

renaultdigital/helm-docs

By renaultdigital

Updated about 5 years ago

Auto-generated Docker image for norwoodj/helm-docs

Image
0

10K+

renaultdigital/helm-docs repository overview

helm-docs

Build Status

Auto-trigger docker build for kubernetes helm-docs when new release is announced.

DockerHub Badge

NOTES

The latest docker tag is the latest release version (https://github.com/helm-docs/helm-docs/releases/latest)

Please avoid to use latest tag for any production deployment. Tag with right version is the proper way, such as renaultdigital/helm-docs:3.1.1

Github Repo

https://github.com/renault-digital/helm-docs

Daily Travis CI build logs

https://travis-ci.com/github/renault-digital/docker-helm-docs

Docker image tags

https://hub.docker.com/r/renaultdigital/helm-docs/tags/

Usage

# mount local folders in container.
docker run -ti --rm -v $(pwd):/apps -w /apps \
    -v ~/.kube:/root/.kube -v ~/.helm-docs:/root/.helm-docs -v ~/.config/helm-docs:/root/.config/helm-docs \
    -v ~/.cache/helm-docs:/root/.cache/helm-docs \
    renaultdigital/helm-docs

# Run helm-docs with special version. The tag is helm-docs's version
docker run -ti --rm -v $(pwd):/apps -w /apps \
    -v ~/.kube:/root/.kube -v ~/.helm-docs:/root/.helm-docs -v ~/.config/helm-docs:/root/.config/helm-docs \
    -v ~/.cache/helm-docs:/root/.cache/helm-docs \
    renaultdigital/helm-docs:3.1.1

# run container as command
alias helm-docs="docker run -ti --rm -v $(pwd):/apps -w /apps \
    -v ~/.kube:/root/.kube -v ~/.helm-docs:/root/.helm-docs -v ~/.config/helm-docs:/root/.config/helm-docs \
    -v ~/.cache/helm-docs:/root/.cache/helm-docs \
    renaultdigital/helm-docs"
helm-docs --help

# example in ~/.bash_profile
alias helm-docs='docker run -e KUBECONFIG="/root/.kube/config:/root/.kube/some-other-context.yaml" -ti --rm -v $(pwd):/apps -w /apps \
    -v ~/.kube:/root/.kube -v ~/.helm-docs:/root/.helm-docs -v ~/.config/helm-docs:/root/.config/helm-docs \
    -v ~/.cache/helm-docs:/root/.cache/helm-docs \
    renaultdigital/helm-docs'

Why we need it

Mostly it is used during CI/CD (continuous integration and continuous delivery) or as part of an automated build/deployment

The Processes to build this image

  • Enable Travis CI cronjob on this repo to run build daily on master branch
  • Check if there are new tags/releases announced via Github REST API
  • Match the exist docker image tags via Hub.docker.io REST API
  • If not matched, build the image with release version and push to https://hub.docker.com/
  • Get the latest version from https://github.com/norwoodj/helm-docs/releases/latest, pull the image with that version, tag as renaultdigital/helm-docs:latest and push to hub.docker.com

Credits

Tag summary

Content type

Image

Digest

Size

6.2 MB

Last updated

about 5 years ago

docker pull renaultdigital/helm-docs