airship/sip
Code Issues Proposed changes
Files
e81e120dbfc616e93324672fd759ab4c3f2cad7f
sip/docs/api/sipcluster.md
Sean Eagan e81e120dbf Align with kubernetes api naming conventions 
This updates the api to use names consistent with the k8s api naming conventions:

https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#naming-conventions
https://github.com/kubernetes/community/blob/master/wg-naming/recommendations/001-master-control-plane.md

Signed-off-by: Sean Eagan <seaneagan1@gmail.com>
Change-Id: I46feda94ee5d22d724f5943dde32ffe0d06d7073
Signed-off-by: Sean Eagan <seaneagan1@gmail.com>
2021-02-16 16:55:19 -06:00

8.4 KiB
Raw Blame History

SIPCluster API reference

Packages:

airship.airshipit.org/v1

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

Resource Types:

    JumpHostService

    (Appears on: SIPClusterServices)

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

    Field Description
    inline
    SIPClusterService
    sshkey
    string

    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 theh Nodes image - Scheduling expectations - Scale of the group of Nodes

    Field Description
    vmFlavor
    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 that allow 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

    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

    clusterName
    string

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

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

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

    SIPClusterService

    (Appears on: JumpHostService, SIPClusterServices)

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

    SIPClusterServices

    (Appears on: SIPClusterSpec)

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

    Field Description
    loadBalancer
    []SIPClusterService

    LoadBalancer defines the sub-cluster load balancer services.
    auth
    []SIPClusterService

    Auth defines the sub-cluster authentication 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
    clusterName
    string

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

    Nodes defines the set of nodes to schedule for each vm 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

    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

    VMRole (string alias)

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

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