airship/airshipctl
Code Issues Proposed changes
655fdb2661
airshipctl/manifests/function/hostgenerator-m3
History
Alexey Odinokov 431043972c Added m3-gen integrity checks 
Without that check we may get firmware: null
that will be a mistake

Change-Id: Ib86a5ff7b54a6a280768832646f612568da93046
2021-05-11 05:19:42 +00:00
..
replacements Pin krm function calls 2021-03-24 09:28:54 -05:00
hosttemplate.yaml Added m3-gen integrity checks 2021-05-11 05:19:42 +00:00
kustomization.yaml Add an m3 host generator function 2020-07-17 15:30:26 -05:00
README.md Deduplicate airshipctl manifest networking 2020-10-21 16:26:10 -05:00

README.md

Function: hostgenerator-m3

This function constructs a collection of Metal3 BareMetalHost resources, along with associated configuration Secrets. It solves for a couple of things:

  1. pulling the nitty gritty details for generating BMH into one reusable place,
  2. allowing the site-specific details to be filled in via catalogues of values

This function leverages a couple of different plugins in sequence: The airshipctl Replacement plugin, which pulls the site-specific data from the catalogue documents into a Templater plugin configuration; and then the airshipctl Templater plugin, which generates a variable number of BMHs in a data-driven fashion.

To use this function, do the following:

  • Supply a networking catalogue, which outlines things that are typically common across hosts in a site, such as networking interfaces, DNS servers, and other networking info. Example: manifests/type/gating/shared/catalogues/common-networking.yaml

  • Supply a host-catalogue, which contains host-specific data, such as IP addresses and BMC information. Example: manifests/site/test-site/shared/catalogues/hosts.yaml

  • Supply a host-generation-catalogue for each phase that needs to deploy one or more BMHs. This catalogue simply lists the specific hosts that should be deployed during that phase. Example: manifests/site/test-site/ephemeral/bootstrap/hostgenerator/host-generation.yaml

  • If any per-host changes need to be made, they can be layered on top as site- or phase-specific Kustomize patches against the generated documents. E.g, if one host has a different network interface name, or if different details need to be used during ISO bootstrapping and normal deployment. Example: manifests/site/test-site/ephemeral/bootstrap/baremetalhost.yaml