trident-template v0.0.23

Trident

Introduction

Trident is a manifest-based templating engine for reusing configuration files. It is designed to be simple & flexible.

It takes inspiration from Kustomize and Helm, but is designed to be more generative & general-purpose.

Concepts

• Base Configurations These are un-templated configurations that are used as the base for your output.
• Templates This is a YAML file that describes any patches to apply to the base configuration. Unlike Kustomize, Trident templates are indeed templates, and can contain templating logic. (This is not a condemnation of Kustomize, which is a great tool, but rather a different design choice.)
• Manifest: A YAML file that describes a set of resources.
• Schema An optional JSON Schema Specification to be applied to each resource defined in the manifest. This is useful for validation or applying defaults.

But to elaborate, imagine that you have a base configuration, and 15 services that can borrow from this base configuration.

With Trident, you can set up your base configuration, and define a manifest that describes the 15 services. The template can take values from the manifest, and apply them to the base configurations, and output 15 different sets of configurations.

Example

Here's a potential example of a Trident manifest:

# manifest.yaml
name: Users
replicas: 3
--- 
name: Orders
replicas: 5
--- 
name: Payments
replicas: 2

You could define a base configuration that looks like this:

# base/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: Unknown
spec:
    replicas: 1

And a template that looks like this:

# template.yaml
$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
metadata:
  name: {{name}}
spec:
  replicas: {{replicas}}

When you run Trident, it will apply the manifest to the template, and merge the results with the base configuration. The output would be three different deployment files, one for each service.

If you wanted, you could also specify a schema to make sure that the output is valid:

{
    "type": "object",
    "properties": {
        "name": {
            "type": "string"
        },
        "replicas": {
            "type": "integer",
            "minimum": 1,
            "default": 1
        }
    },
    "required": ["name", "replicas"]
}

Which would ensure that the manifest is valid & apply defaults if necessary.

Templates can also specify that multiple resources should be outputted, and can be output to different directories / any depth.

To define multiple resources in the template, you can use the --- separator, like in the manifest.

Templating Language

Trident uses Handlebars as its templating language. This is a simple, flexible language that is easy to learn.

You can read more about Handlebars here.

We have added a few custom helpers to make it easier to work with configurations,

We also support the methods from Handlebars-Helpers.

We recommend strongly that you check out the handlebars documentation directly, but you're able to use any of the built-in helpers in your templates, such as if, each, etc.

Example:

# template.yaml
$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
metadata:
  name: {{name}}
spec:
{{#if replicas}}
  replicas: {{replicas}}
{{/if}}
{{#if env}}
  env:
  {{#each env}}
    - name: {{@key}}
      value: {{this}}
  {{/each}}
{{/if}}

$in is a special key that specifies the base configuration to use. This is a relative path to the base configuration. $out is a special key that specifies the output path; often you will likely template this based on the name of the resource.

There is also a $copy key that can be used to copy globs from one directory to another. This is useful for copying files that are not templated.

Example:

$copy: base/info/*.txt
$out: {{name}}/info

$replace is a special key that can be used to replace literal strings in the base configuration. For most cases, I'd recommend using patching instead as described above, but this can be useful when you need to replace a value in numerous places in the base configuration.

Example:

$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
$replace:
  SERVICE_NAME: {{name}}

This will replace all instances of SERVICE_NAME in the base configuration with the name of the service.

"Is this not a form of templating in the base configuration?" you might ask. Admittedly -- yes, yes it is. I'd encourage you to use this sparingly.

Global Variables

If you have a set of variables you want to apply across all items in your manifest, you can either import them from a file or specify them on the CLI. They are referenced in templates as $values.

For example, you could have an prod.json file that looks like so:

{
    "environment": "prod",
    "region": "us-west-2"
}

Then upon running the following command:

trident -i . -f env=prod.json

You could access these variables in your templates like so (from $values):

# template.yaml
$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
metadata:
  name: {{name}}
spec:
    replicas: {{replicas}}
    env:
        - name: ENVIRONMENT
        value: {{$values.env.environment}}
        - name: REGION
        value: {{$values.env.region}}

You can also specify these variables directly on the CLI, like so:

trident -i . -v environment=prod -v region=us-west-2

Which would allow you to access them directly off of $values in your templates.

# template.yaml
$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
metadata:
  name: {{name}}
spec:
    replicas: {{replicas}}
    env:
        - name: ENVIRONMENT
        value: {{$values.environment}}
        - name: REGION
        value: {{$values.region}}

Running Trident

To run Trident, you can use the following command:

trident -i . 

This will look for a manifest.yaml, template.yaml and an optional schema.json in the current directory, and execute the template.

You can also specify the three files directly, separated by commas, in the following order:

trident -i manifest.yaml,template.yaml,schema.json

It might be possible that you have multiple templates & manifests, so you can use the -i flag multiple times to specify multiple directories.

trident -i services -i collectors

Output

Trident can output either directly to the filesystem or to an archive.

To output to an archive, you can specify the -a flag with a path to the archive. The current formats supported are zip, tar, and tar.gz (and tgz).

For example:

trident -i . -a output.zip

The structure of the output will be determined solely by the $out key in the templates.

Supported Formats for Base Configurations

Trident currently supports YAML, JSON and XML for base configurations.

Enabling Templating in the Base Configurations

Hey! Maybe consider using $replace instead of this!

While I like how Kustomize separates the templating from the base configurations, I understand that this can be a bit cumbersome, especially if a {{name}}-like value is used in multiple places.

So while I encourage you to keep your base configurations as clean as possible, you can enable templating in the base configurations by using the flag --enableTemplateBase.

Even if you enable this flag, I strongly recommend setting up most of your patches in the templates, and use the templating sparingly for values that are used in multiple places.

Importing Values From Template Files

As described above, you can use the CLI Flags like -f and -v to import values into $values.

However, if you need something a bit more robust, you can import values from within the templates themselves.

To do this, you can use $values as a key within the template, and specify where to import the values to.

$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
$values: 
    - env: env.json
# ...

Would allow you to access $values.env in your templates.

You may also specify an object directly,

$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
$values: 
    - env: 
        - key: {{somethingFromManifest}}
        - key2: value2

Which would allow you to access $values.env.key and $values.env.key2 in your templates.

You may also import multiple files or values, and they will be merged together, like so:

$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
$values:
    - env: env.json
    - env: extra-{{name}}.json

If you wish to allow values to be shared across future templates, you can use the --allowValuesSharing flag. This will allow values imported inline by one template to be available in future templates for the same manifest item.

Additionally, if you'd like to import values directly to the root of $values, you can use '.' as the key.

$in: base/deployment.yaml
$out: {{name}}/deployment.yaml
$values: 
    - '.': env.json

Changing Output Directory

You can change the output directory for the configuration by using the $chdir key inside of a step.

$chdir: output/{{name}}

This will automatically make the directory if it doesn't exist.

NOTE: It's not recommended you use this with $in / $out, as you can specify a directory in the $out key; this is useful for changing the output directory in a template that invokes other templates, and setting up something like $chdir: output or $chdir: output/{{name}} at the root level.

Creating Directories

You can create directories by using the $mkdir key; you may not always need this, as Trident will automatically create directories for most commands if they don't exist.

$mkdir: output/{{name}}

Multiple directories can be created by using an array.

$mkdir: 
    - output/frontend/{{name}}
    - output/backend/{{name}}

Removing Files

You can remove files or directories by using the $rm key.

$rm: output/{{name}}/deployment.yaml

Multiple files or directories can be removed by using an array.

$rm: 
    - output/frontend/{{name}}/deployment.yaml
    - output/backend/{{name}}/deployment.yaml

Merging Files

You can merge files together by using $merge. This is useful for combining multiple files into a single file.

The files can be specified as a glob, and a separator can be specified to separate the files.

$merge:
    files: 
        - output/**/deployment.yaml
        - output/**/service.yaml
    separator: "---\n"
$out: output/release.yaml

The files will be appended in the order they are specified, with the separator between each file.

Calling Templates From Templates

In Trident, templates are multiplicative. This means that you can call a template from within a template, and values from either the manifest or template can be passed to the called template.

To call a template from within a template, you can use the $template key.

$template: services/template.yaml
$manifest: services/manifest.yaml
---
$template: frontend/template.yaml
$manifest: frontend/manifest.yaml

This would call the services/template.yaml with the services/manifest.yaml and the frontend/template.yaml with the frontend/manifest.yaml, allowing you to execute multiple templates in a single run.

Any $values or values from the manifest will be passed to the called template.

$chdir: output/{{name}}
$manifest: services/manifest.yaml
$template: services/template.yaml
$values:
    - env: {{name}}.json
type: service

Would allow you to access $values.env in the services/template.yaml, as well as {{type}} in the services/template.yaml (this also works with --match).

You might run the above template with the following command:

trident -i . --relative

With the manifest being:

name: Prod
---
name: Dev

Allowing you to output two different sets of configurations, one for Prod and one for Dev.

You may also specify a schema to use for the called template by using the $schema key.

$template: services/template.yaml
$schema: services/schema.json
$manifest: services/manifest.yaml

Using Multiple Manifests

As noted above, you can use $template to invoke other templates.

If you pass an array into $manifest, Trident will merge the manifests together, and merge properties with the same name.

Conceptually, this is similar to using multiple overlays in Kustomize.

$template: services/template.yaml
$manifest: 
  - services/manifest.yaml
  - services/{{$values.env}}.yaml

Now if I have services/manifest.yaml like so:

name: Users
env: 
  HOST: users
  MODE: prod
replicas: 3
---
name: Orders
env: 
  HOST: orders
  MODE: prod
replicas: 2

And a file named services/prod.yaml like so:

name: Users
replicas: 5

I could run Trident with:

trident -i . -v env=prod

And Users would be deployed with 5 replicas, and Orders would be deployed with 2 replicas.

Flags

All Template Instructions

Why "Trident"?

A trident is a multi-pronged tool; this tool is designed to give your base configurations multiple prongs, or outputs. It's also a cool word.

Installation

npm i -g trident-template