diff --git a/.gitignore b/.gitignore index ba66fddf9ad4a8ff598d12e371425d8fc2d4ff73..fb61da3867c2a2cbd4e8d2a35a2d3fa2268408e1 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,5 @@ __pycache__/ .mypy_cache/ .pytest_cache/ .pylintrc +build/ +dist/ diff --git a/readme.md b/readme.md index 1c00172250eb020ebc54b012b66e7f00b7a43a00..a21ffaf267c286a33b88d2c909ab736d48747e4e 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,33 @@ # vs-starter -Creates the docker configuration using the rendered helm templates +Creates a docker configuration using the rendered helm templates + +## Install + +Can be installed by cloning and running + +```shell +python setup.py install +``` + + +## Usage + +The package works on rendered helm templates so the templates from helm should be +rendered first with: + +```shell +helm template <stack-name> chart --output-dir <output-dir> --values values.custom.yaml +``` + +Afterwards the `vs_starter` command is available: + +```shell +Usage: vs_starter [OPTIONS] HELM_CONFIG_PATH OUTPUT_PATH + +Options: + -p, --param KEY=VALUE parameters for the jinja templates [slug, + service_url, release_version, sftp, + shibauth_renderer, shibauth_cache] [required] + --help Show this message and exit. +```