Terrajinja CLI
Is a intermediate command line interface that accepts YAML/Jinja2 template files as input in order to generate a terraform deployment
CLI command structure
Each command is represented as a command or subcommand, and there are a number of command and subcommand options available:
$ tjcli <command> {deploy,template,init} [args]
- init - creates the config directory structure
- template - list or add templates to your config
- deploy - create a deployment for your config
for additional help ad the --help parameter to the sub command e.g.:
$ tjcli template --help
Getting started
start by installing the cli using pip
$ pip install terrajinja-cli
next step is to choose a place to store your config, in general this is a git repository. you can then create the initial directory stucture in that directory
$ tjcli init
creating directory project/deployments
creating directory project/templates
creating directory project/parameters
to get some inspiration look at the available templates that have already been created for your inspiration.
$ tjcli template --list
available templates:
gitlab-runner: for creating a gitlab runner on kubernetes
you can add any of these templates to your project
$ tjcli template --add gitlab-runner
requesting to add template {args.template}...
dest: project/templates/generic_gitlab_runner_v0.0.1.yaml
adding: templates / generic_gitlab_runner_v0.0.1.yaml
dest: project/parameters/gitlab_runner.yaml
adding: parameters / gitlab_runner.yaml
Configuring a deployment
Terra jinja expects the following paths to contain YAML or Jinja2 template files:
| directory | files | description |
|---|---|---|
| parameters | YAML only | main input to be used by all deployments |
| deployments | YAML/Jinja2 | this defines the accepted parameters and what templates to execute |
| templates | YAML/Jinja2 | the templates define the terraform modules to execute |
Please refer to the documentation for the full file specifications
Deploying your deployment
Which deployment is available depends on the files you created in the deployments directory e.g.:
$ tjcli deploy -d my_deployment -a mailrelay -e test
Note that the parameters are dynamicly based on the deployment file, so the actual parameters availabe will vary on your config.
Once terrajinja created your deployment you can run cdktf to apply or destroy your deployment. e.g.:
cdktf apply
History
0.0.1 (14-03-2024)
- First code creation
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file terrajinja_cli-1.0.0.tar.gz.
File metadata
- Download URL: terrajinja_cli-1.0.0.tar.gz
- Upload date:
- Size: 41.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02cb1f863755928e26d0a4f3447e8691cfd10b5ce05d8f07b4f9182816a4ba98
|
|
| MD5 |
877c9cbef8fd90b2dd73e5d0d73580a3
|
|
| BLAKE2b-256 |
da504087c2d8fa7149ab9afc1899ec6850f80a9a55e9453bdbbf681fea5c1361
|
File details
Details for the file terrajinja_cli-1.0.0-py3-none-any.whl.
File metadata
- Download URL: terrajinja_cli-1.0.0-py3-none-any.whl
- Upload date:
- Size: 11.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fee6bbd771250a428b3c88b22013af9762ebfe0f0233251af04aff09720fe420
|
|
| MD5 |
4fa1eba79e41b25d26c2caaf097f353c
|
|
| BLAKE2b-256 |
306bc39de689ea516b24377611e812bc4f9bc16f2fb916d55de7b038b98b6b2b
|
