SIPCluster API reference

Packages:

airship.airshipit.org/v1

Package v1 contains API Schema definitions for the airship v1 API group

Resource Types:

InfraConfig

(Appears on: SIPClusterSpec)

Field Description
serviceType
InfraService
optional
OptsConfig
image
string
nodelabels
map[string]string
nodePort
int
nodeInterfaceId
string

InfraService (string alias)

(Appears on: InfraConfig)

InfraService describes the type of infrastructure service that should be deployed when a sub-cluster is provisioned.

NodeSet

(Appears on: SIPClusterSpec)

NodeSet are the the list of Nodes objects workers, or master that definee eexpectations for the Tenant Clusters Includes artifacts to associate with each defined namespace Such as : - Roles for the Nodes - Flavor for theh Nodes image - Scheduling expectations - Scale of the group of Nodes

Field Description
vm-flavor
string

VMFlavor is essentially a Flavor label identifying the type of Node that meets the construction reqirements
spreadTopology
SpreadTopology

PlaceHolder until we define the real expected Implementation Scheduling define constraints the allows the SIP Scheduler to identify the required BMH’s to allow CAPI to build a cluster
count
VMCount

Count defines the scale expectations for the Nodes

OptsConfig

(Appears on: InfraConfig)

Field Description
sshkey
string
clusterIP
string

SIPCluster

SIPCluster is the Schema for the sipclusters API

Field Description
metadata
Kubernetes meta/v1.ObjectMeta 		Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
SIPClusterSpec

cluster-name
string

ClusterName is the name of the cluster to associate machines with
nodes
map[./pkg/api/v1.VMRoles]./pkg/api/v1.NodeSet

Nodes are the list of Nodes objects workers, or master that definee eexpectations of the Tenant cluster VMRole is either Control or Workers VMRole VMRoles json:"vm-role,omitempty"
infra
[]InfraConfig

InfraServices is a list of services that are deployed when a SIPCluster is provisioned.
status
SIPClusterStatus

SIPClusterSpec

(Appears on: SIPCluster)

SIPClusterSpec defines the desired state of a SIPCluster

Field Description
cluster-name
string

ClusterName is the name of the cluster to associate machines with
nodes
map[./pkg/api/v1.VMRoles]./pkg/api/v1.NodeSet

Nodes are the list of Nodes objects workers, or master that definee eexpectations of the Tenant cluster VMRole is either Control or Workers VMRole VMRoles json:"vm-role,omitempty"
infra
[]InfraConfig

InfraServices is a list of services that are deployed when a SIPCluster is provisioned.

SIPClusterStatus

(Appears on: SIPCluster)

SIPClusterStatus defines the observed state of SIPCluster

Field Description
conditions
[]Kubernetes meta/v1.Condition

SpreadTopology (string alias)

(Appears on: NodeSet)

VMCount

(Appears on: NodeSet)

VMCount

Field Description
active
int

INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run “make” to regenerate code after modifying this file
standby
int

VMRoles (string alias)

VMRoles defines the states the provisioner will report the tenant has having.

This page was automatically generated with gen-crd-api-reference-docs