airship/airshipctl

History

Sirajudeen 8971bc4882 skip generating etherenet_mac_address when null * Host-generator template is generating a null value like below when host catalogue is not having any mac value for the interface. ethernet_mac_address: <no value> * added another condition to ethernet_mac_address generation logic so generate only if macAddresses is provided and if it has value for the respective interface ( oam, pxe ...) Closes: #404 Change-Id: I2fafe5ceaa4c58855a17929c1c41d60045d1675a		2021-08-26 20:58:35 +00:00
..
local-resource	skip generating etherenet_mac_address when null	2021-08-26 20:58:35 +00:00
Dockerfile	Switching airshipctl and krm-functions to kustomize 4.2.0	2021-07-22 17:06:32 +00:00
main.go	Switching airshipctl and krm-functions to kustomize 4.2.0	2021-07-22 17:06:32 +00:00
README.md	Container build for Templater plugin	2020-10-22 00:07:24 +00:00

README.md

Templater function

This plugin is an implementation of a templater function written using go and uses the kyaml and airshipctl libraries for parsing the input and writing the output.

Function implementation

The function is implemented as an image, and built using make image.

Function invocation

The function is invoked by authoring a Local Resource with metadata.annotations.[config.kubernetes.io/function] and running:

kustomize fn run local-resource/

This exits non-zero if there is an error.

Running the Example

Run the function with:

kustomize fn run local-resource/

The generated resources will appear in local-resource/

$ cat local-resource/*

apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  name: node-1
spec:
  bootMACAddress: 00:aa:bb:cc:dd

apiVersion: metal3.io/v1alpha1
kind: BareMetalHost
metadata:
  name: node-2
spec:
  bootMACAddress: 00:aa:bb:cc:ee
...

Configuration file format

Templater configuration resource is represented as a standard k8s resource with Group, Version, Kind and Metadata header. Templater configuration is defined using template and values fields with following structure.

values:
  hosts:
  - macAddress: 00:aa:bb:cc:dd
    name: node-1
  - macAddress: 00:aa:bb:cc:ee
    name: node-2
template: |
  {{ range .hosts -}}
  ---
  apiVersion: metal3.io/v1alpha1
  kind: BareMetalHost
  metadata:
    name: {{ .name }}
  spec:
    bootMACAddress: {{ .macAddress }}
  {{ end -}}

values defines the substituion value as Map. template defines the template with placeholders to substitue the value from the values Map