y-assembly

YAML Plus Imports: y-assembly

Description

This tool is meant to provide some generic "imports" or merging capability. One can combine files and apply patch files which are yaml patch compliant. Combining this functionality with yaml references and/or envsubst, makes for a really powerful and flexible combination.

Install

Download Latest Releases Here

#Linux
$ curl -sL https://github.com/xchapter7x/y-assembly/releases/download/v0.4.2/yaml_unix -o yaml && chmod +x yaml && mv yaml /usr/local/bin/.

#OSX
$ curl -sL https://github.com/xchapter7x/y-assembly/releases/download/v0.4.2/yaml_osx -o yaml && chmod +x yaml && mv yaml /usr/local/bin/.

#Windows
$ go to https://github.com/xchapter7x/y-assembly/releases/download/v0.4.2/yaml.exe and download

Use case

anywhere you are wrangling yaml (Kubernetes, BOSH, Concourse) this can help. It is generic, specifically built to provide enough flexibility to be used with any tool that likes yaml.

Assembly.yml fields and file behavior

version: and integer value representing the compatibility of the assembly record

expand_aliases: this will expand anchors and aliases in the output files (not dry but pure yaml)

base: the base file, where all others are appended or modify (can be url or local file)

output: where the output of the assembly operation will go (must be local)

imports: an array of urls or local file paths, which will be appended to the base to create the output. the array order is the order in which the files will be combined.

patches: an array of urls or local file paths, which will be patched on top of the fully assembled set of base and imports. the array order is the order in which the patches will be applied. uses yaml-patch op files for full set of commands check the compatible json patch docs

Example

-> % cd github.com/xchapter7x/y-assembly/test/e2e/cmd

-> % cat testdata/assembly.yml
---
- version: 1
  base: "testdata/base/base.yml"
  output: "testdata/outputs/cool.yml"
  imports:
  - "https://raw.githubusercontent.com/xchapter7x/y-assembly/master/test/e2e/cmd/testdata/imports/import1.yml"

- version: 1
  base: "testdata/base/base.yml"
  output: "testdata/outputs/out2.yml"
  imports:
  - "testdata/imports/import1.yml"

- version: 1
  base: "testdata/base/base.yml"
  output: "testdata/outputs/out3.yml"
  imports:
  - "https://raw.githubusercontent.com/xchapter7x/y-assembly/master/test/e2e/cmd/testdata/imports/import1.yml"
  patches:
  - "testdata/patches/patch1.yml"
  
-> % ./yaml_osx build -c testdata/assembly.yml -p

---
#  testdata/outputs/out1.yml
somecool: thing
which: has
lots:
- of
- stuff

- with
- even
- more
- imports

---
#  testdata/outputs/out2.yml
somecool: thing
which: has
lots:
- of
- stuff

- with
- even
- more
- imports

---
#  testdata/outputs/out3.yml
lots:
- of
- stuff
- with
- even
- more
- imports
somecool: thing
which: had