airship/sip
Code Issues Proposed changes
sip/docs/api/sipcluster.md
Drew Walters ff4e8068d5 Add SSH access to Jump Host 
This change enables operators to SSH into a sub-cluster Jump Host from
outside the base K8s cluster using a Node Port service. Operators
authenticate using SSH authorized keys to the SIP CR.

Signed-off-by: Drew Walters <andrew.walters@att.com>
Change-Id: Ib1d94b5b0813e34014375d97f9189948af49f42c
2021-03-09 15:20:48 +00:00

8.8 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:

    BMCOpts

    (Appears on: JumpHostService)

    BMCOpts contains options for BMC communication.

    Field Description
    proxy
    bool

    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.)

    bmc
    BMCOpts
    sshAuthorizedKeys
    []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

    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
    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