admin

Documentation

Index

• Constants
• type APIServerProfile
• type ClusterProfile
• type ConsoleProfile
• type IngressProfile
• type Install
• type InstallPhase
• type MasterProfile
• type NetworkProfile
• type OpenShiftCluster
• type OpenShiftClusterList
• type OpenShiftClusterProperties
• type ProvisioningState
• type ServicePrincipalProfile
• type VMSize
• type Visibility
• type WorkerProfile

Constants

const APIVersion = "admin"

APIVersion contains a version string as it will be used by clients

Types

type APIServerProfile

type APIServerProfile struct {
	Visibility Visibility `json:"visibility,omitempty"`
	URL        string     `json:"url,omitempty"`
	IP         string     `json:"ip,omitempty"`
}

APIServerProfile represents an API server profile.

type ClusterProfile

type ClusterProfile struct {
	Domain          string `json:"domain,omitempty"`
	Version         string `json:"version,omitempty"`
	ResourceGroupID string `json:"resourceGroupId,omitempty"`
}

ClusterProfile represents a cluster profile.

type ConsoleProfile

type ConsoleProfile struct {
	URL string `json:"url,omitempty"`
}

ConsoleProfile represents a console profile.

type IngressProfile

type IngressProfile struct {
	Name       string     `json:"name,omitempty"`
	Visibility Visibility `json:"visibility,omitempty"`
	IP         string     `json:"ip,omitempty"`
}

IngressProfile represents an ingress profile.

type Install

type Install struct {
	Now   time.Time    `json:"now,omitempty"`
	Phase InstallPhase `json:"phase"`
}

Install represents an install process.

type InstallPhase

type InstallPhase int

InstallPhase represents an install phase.

const (
	InstallPhaseBootstrap InstallPhase = iota
	InstallPhaseRemoveBootstrap
)

InstallPhase constants.

type MasterProfile

type MasterProfile struct {
	VMSize   VMSize `json:"vmSize,omitempty"`
	SubnetID string `json:"subnetId,omitempty"`
}

MasterProfile represents a master profile.

type NetworkProfile

type NetworkProfile struct {
	PodCIDR     string `json:"podCidr,omitempty"`
	ServiceCIDR string `json:"serviceCidr,omitempty"`

	PrivateEndpointIP string `json:"privateEndpointIp,omitempty"`
}

NetworkProfile represents a network profile.

type OpenShiftCluster

type OpenShiftCluster struct {
	ID         string                     `json:"id,omitempty" mutable:"case"`
	Name       string                     `json:"name,omitempty" mutable:"case"`
	Type       string                     `json:"type,omitempty" mutable:"case"`
	Location   string                     `json:"location,omitempty"`
	Tags       map[string]string          `json:"tags,omitempty"`
	Properties OpenShiftClusterProperties `json:"properties,omitempty"`
}

OpenShiftCluster represents an Azure Red Hat OpenShift cluster.

type OpenShiftClusterList

type OpenShiftClusterList struct {
	// The list of OpenShift clusters.
	OpenShiftClusters []*OpenShiftCluster `json:"value"`

	// The link used to get the next page of operations.
	NextLink string `json:"nextLink,omitempty"`
}

OpenShiftClusterList represents a list of OpenShift clusters.

type OpenShiftClusterProperties

type OpenShiftClusterProperties struct {
	ProvisioningState       ProvisioningState       `json:"provisioningState,omitempty"`
	FailedProvisioningState ProvisioningState       `json:"failedProvisioningState,omitempty"`
	ClusterProfile          ClusterProfile          `json:"clusterProfile,omitempty"`
	ConsoleProfile          ConsoleProfile          `json:"consoleProfile,omitempty"`
	ServicePrincipalProfile ServicePrincipalProfile `json:"servicePrincipalProfile,omitempty"`
	NetworkProfile          NetworkProfile          `json:"networkProfile,omitempty"`
	MasterProfile           MasterProfile           `json:"masterProfile,omitempty"`
	WorkerProfiles          []WorkerProfile         `json:"workerProfiles,omitempty"`
	APIServerProfile        APIServerProfile        `json:"apiserverProfile,omitempty"`
	IngressProfiles         []IngressProfile        `json:"ingressProfiles,omitempty"`
	Install                 *Install                `json:"install,omitempty"`
	StorageSuffix           string                  `json:"storageSuffix,omitempty"`
}

OpenShiftClusterProperties represents an OpenShift cluster's properties.

type ProvisioningState

type ProvisioningState string

ProvisioningState represents a provisioning state.

const (
	ProvisioningStateCreating      ProvisioningState = "Creating"
	ProvisioningStateUpdating      ProvisioningState = "Updating"
	ProvisioningStateAdminUpdating ProvisioningState = "AdminUpdating"
	ProvisioningStateDeleting      ProvisioningState = "Deleting"
	ProvisioningStateSucceeded     ProvisioningState = "Succeeded"
	ProvisioningStateFailed        ProvisioningState = "Failed"
)

ProvisioningState constants

type ServicePrincipalProfile

type ServicePrincipalProfile struct {
	TenantID string `json:"tenantId,omitempty"`
	ClientID string `json:"clientId,omitempty"`
}

ServicePrincipalProfile represents a service principal profile.

type VMSize

type VMSize string

VMSize represents a VM size.

const (
	VMSizeStandardD2sV3 VMSize = "Standard_D2s_v3"
	VMSizeStandardD4sV3 VMSize = "Standard_D4s_v3"
	VMSizeStandardD8sV3 VMSize = "Standard_D8s_v3"
)

VMSize constants.

type Visibility

type Visibility string

Visibility represents visibility.

const (
	VisibilityPublic  Visibility = "Public"
	VisibilityPrivate Visibility = "Private"
)

Visibility constants

type WorkerProfile

type WorkerProfile struct {
	Name       string `json:"name,omitempty"`
	VMSize     VMSize `json:"vmSize,omitempty"`
	DiskSizeGB int    `json:"diskSizeGB,omitempty"`
	SubnetID   string `json:"subnetId,omitempty"`
	Count      int    `json:"count,omitempty"`
}

WorkerProfile represents a worker profile.