Config Refactor: Design Metadata File Format

[lb4368]

Proposed change
Design generic metadata file format to be referenced by airship config (#255) for metadata information about the manifests.

See https://go.gliffy.com/go/publish/13297704.

Would this contain a reference to a phase plan (#261)

[airshipbot]

Related Change #738146

Subject: Add repository metadata
Link: https://review.opendev.org/738146
Status: MERGED
Owner: Kostyantyn Kalynovskyi (kkalynovskyi@mirantis.com)

Approvals

Code-Review
+2 Dmitry Ukov
+1 Ruslan Aliev
+2 Matt McEuen
Verified
+2 Zuul
Workflow
+1 Matt McEuen

Last Updated: 2020-07-10 17:15:05 CDT

[airshipbot]

A [Related Change](https://review.opendev.org/738146 was merged. This issue may be ready to close.

[teoyaomiqui]

For now we have designed a basic metadata format, that hold two items only, it will be extended if needed in the future:

// Metadata holds entrypoints for phases, inventory and clusterctl
type Metadata struct {
	Inventory *InventoryMeta `json:"inventory,omitempty"`
	PhaseMeta *PhaseMeta     `json:"phase,omitempty"`
}

// InventoryMeta holds inventory metadata, this is to be extended in the future
// when we have more information how to handle non-baremetal inventories
// path is a kustomize entrypoint against which we will build bundle containing bmh hosts
type InventoryMeta struct {
	Path string `json:"path,omitempty"`
}

// PhaseMeta holds phase metadata, right now it is only path, but maybe extended further
// path is a kustomize entrypoint against which we will build bundle with phase objects
type PhaseMeta struct {
	Path string `json:"path,omitempty"`
}

Closing the issue, as this simple design is sufficient. It's extension should be defined in new issue if needed.