SIPCluster API reference

Packages:

airship.airshipit.org/v1

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

Resource Types:

BMCOpts

(Appears on: JumpHostService)

BMCOpts contains options for BMC communication.

Field Description
proxy
bool

BMHRole (string alias)

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

JumpHostService

(Appears on: SIPClusterServices)

JumpHostService is an infrastructure service type that represents the sub-cluster jump-host service.

Field Description
SIPClusterService
SIPClusterService

(Members of SIPClusterService are embedded into this type.)

nodePort
int
bmc
BMCOpts
sshAuthorizedKeys
[]string
nodeSSHPrivateKeys
string

NodeSSHPrivateKeys holds the name of a Secret in the same namespace as the SIPCluster CR, whose key values each represent an ssh private key that can be used to access the cluster nodes. They are mounted into the jumphost with the secret keys serving as file names relative to a common directory, and then configured as identity files in the SSH config file of the default user.

LoadBalancerServiceControlPlane

(Appears on: SIPClusterServices)

LoadBalancerServiceControlPlane is an infrastructure service type that represents the sub-cluster load balancer service.

Field Description
SIPClusterService
SIPClusterService

(Members of SIPClusterService are embedded into this type.)

nodePort
int

LoadBalancerServiceWorker

(Appears on: SIPClusterServices)

LoadBalancerServiceWorker is an infrastructure service type that represents the sub-cluster load balancer service.

Field Description
SIPClusterService
SIPClusterService

(Members of SIPClusterService are embedded into this type.)

nodePortRange
PortRange

TODO: Remove the inherited single NodePort field via refactoring. It is unused for this service since we have the below node port range instead.

NodeCount

(Appears on: NodeSet)

NodeCount

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

NodeSet

(Appears on: SIPClusterSpec)

NodeSet are the the list of Nodes objects workers, or ControlPlane that define expectations for the Tenant Clusters Includes artifacts to associate with each defined namespace Such as : - Roles for the Nodes - Flavor for the Nodes image - Anti-affinity expectations - Scale of the group of Nodes

Field Description
labelSelector
Kubernetes meta/v1.LabelSelector

LabelSelector is the BMH label selector to use.
topologyKey
string

TopologyKey is similar to the same named field in the kubernetes Pod anti-affinity API. If two BMHs are labeled with this key and have identical values for that label, they are considered to be in the same topology domain, and thus only one will be scheduled.
count
NodeCount

Count defines the scale expectations for the Nodes

PortRange

(Appears on: LoadBalancerServiceWorker)

PortRange represents a range of ports.

Field Description
start
int

Start is the starting port number in the range.
end
int

End is the ending port number in the range.

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

nodes
map[./pkg/api/v1.BMHRole]./pkg/api/v1.NodeSet

Nodes defines the set of nodes to schedule for each BMH role.
services
SIPClusterServices

Services defines the services that are deployed when a SIPCluster is provisioned.
status
SIPClusterStatus

SIPClusterService

(Appears on: JumpHostService, LoadBalancerServiceControlPlane, LoadBalancerServiceWorker)

Field Description
image
string
nodeLabels
map[string]string
nodeInterfaceId
string
clusterIP
string

SIPClusterServices

(Appears on: SIPClusterSpec)

SIPClusterServices defines the services that are deployed when a SIPCluster is provisioned.

Field Description
loadBalancerControlPlane
[]LoadBalancerServiceControlPlane

LoadBalancer defines the sub-cluster load balancer services.
loadBalancerWorker
[]LoadBalancerServiceWorker

LoadBalancer defines the sub-cluster load balancer services.
jumpHost
[]JumpHostService

JumpHost defines the sub-cluster jump host services.

SIPClusterSpec

(Appears on: SIPCluster)

SIPClusterSpec defines the desired state of a SIPCluster

Field Description
nodes
map[./pkg/api/v1.BMHRole]./pkg/api/v1.NodeSet

Nodes defines the set of nodes to schedule for each BMH role.
services
SIPClusterServices

Services defines the 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

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