cluster

Documentation

Index

• Constants
• func CreateCluster(cmv1Client *cmv1.Client, config Spec, dryRun bool) (*cmv1.Cluster, error)
• func DropOpenshiftVPrefix(v string) string
• func EnsureOpenshiftVPrefix(v string) string
• func GetAvailableUpgrades(client *cmv1.Client, versionID string, productID string) ([]string, error)
• func GetCluster(connection *sdk.Connection, key string) (cluster *cmv1.Cluster, err error)
• func GetClusterOauthURL(cluster *cmv1.Cluster) string
• func GetEnabledVersions(client *cmv1.Client, channelGroup string) (versions []string, defaultVersion string, err error)
• func GetGroups(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.Group, error)
• func GetIdentityProviders(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.IdentityProvider, error)
• func GetIngresses(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.Ingress, error)
• func GetMachinePools(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.MachinePool, error)
• func GetUpgradePolicies(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.UpgradePolicy, error)
• func GetVersionID(cluster *cmv1.Cluster) string
• func IsValidClusterKey(clusterKey string) bool
• func PrintClusterDescription(connection *sdk.Connection, cluster *cmv1.Cluster) error
• func UpdateCluster(client *cmv1.ClustersClient, clusterID string, config Spec) error
• func ValidateClusterExpiration(expirationTime string, expirationDuration time.Duration) (expiration time.Time, err error)
• type AWSCredentials
• type AddOnItem
  • func GetClusterAddOns(connection *sdk.Connection, clusterID string) ([]*AddOnItem, error)
• type Autoscaling
• type CCS
• type GCPCredentials
• type Spec

Constants

const (
	ProviderAWS = "aws"
	ProviderGCP = "gcp"
)

Functions

func CreateCluster

func CreateCluster(cmv1Client *cmv1.Client, config Spec, dryRun bool) (*cmv1.Cluster, error)

func DropOpenshiftVPrefix

func DropOpenshiftVPrefix(v string) string

func EnsureOpenshiftVPrefix

func EnsureOpenshiftVPrefix(v string) string

func GetAvailableUpgrades

func GetAvailableUpgrades(
	client *cmv1.Client, versionID string, productID string) ([]string, error)

func GetCluster

func GetCluster(connection *sdk.Connection, key string) (cluster *cmv1.Cluster, err error)

func GetClusterOauthURL

func GetClusterOauthURL(cluster *cmv1.Cluster) string

func GetEnabledVersions

func GetEnabledVersions(client *cmv1.Client, channelGroup string) (
	versions []string, defaultVersion string, err error)

GetEnabledVersions returns the versions with enabled=true, and the one that has default=true. The returned strings are the IDs without "openshift-v" prefix (e.g. "4.6.0-rc.4-candidate") sorted in approximate SemVer order (handling of text parts is somewhat arbitrary).

func GetGroups

func GetGroups(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.Group, error)

func GetIdentityProviders

func GetIdentityProviders(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.IdentityProvider, error)

func GetIngresses

func GetIngresses(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.Ingress, error)

func GetMachinePools

func GetMachinePools(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.MachinePool, error)

func GetUpgradePolicies

func GetUpgradePolicies(client *cmv1.ClustersClient, clusterID string) ([]*cmv1.UpgradePolicy, error)

func GetVersionID

func GetVersionID(cluster *cmv1.Cluster) string

func IsValidClusterKey

func IsValidClusterKey(clusterKey string) bool

func PrintClusterDescription

func PrintClusterDescription(connection *sdk.Connection, cluster *cmv1.Cluster) error

func UpdateCluster

func UpdateCluster(client *cmv1.ClustersClient, clusterID string, config Spec) error

func ValidateClusterExpiration

func ValidateClusterExpiration(
	expirationTime string,
	expirationDuration time.Duration,
) (expiration time.Time, err error)

Types

type AWSCredentials

type AWSCredentials struct {
	AccountID       string
	AccessKeyID     string
	SecretAccessKey string
}

type AddOnItem

type AddOnItem struct {
	ID        string
	Name      string
	State     string
	Available bool
}

func GetClusterAddOns

func GetClusterAddOns(connection *sdk.Connection, clusterID string) ([]*AddOnItem, error)

type Autoscaling

type Autoscaling struct {
	Enabled     bool
	MinReplicas int
	MaxReplicas int
}

type CCS

type CCS struct {
	Enabled bool
	AWS     AWSCredentials
	GCP     GCPCredentials
}

type GCPCredentials

type GCPCredentials struct {
	Type                    string `json:"type"`
	ProjectID               string `json:"project_id"`
	PrivateKeyID            string `json:"private_key_id"`
	PrivateKey              string `json:"private_key"`
	ClientEmail             string `json:"client_email"`
	ClientID                string `json:"client_id"`
	AuthURI                 string `json:"auth_uri"`
	TokenURI                string `json:"token_uri"`
	AuthProviderX509CertURL string `json:"auth_provider_x509_cert_url"`
	ClientX509CertURL       string `json:"client_x509_cert_url"`
}

type Spec

type Spec struct {
	// Basic configs
	Name           string
	Region         string
	Provider       string
	CCS            CCS
	Flavour        string
	MultiAZ        bool
	Version        string
	ChannelGroup   string
	Expiration     time.Time
	EtcdEncryption bool

	// Scaling config
	ComputeMachineType string
	ComputeNodes       int
	Autoscaling        Autoscaling

	// Network config
	MachineCIDR net.IPNet
	ServiceCIDR net.IPNet
	PodCIDR     net.IPNet
	HostPrefix  int
	Private     *bool

	// Properties
	CustomProperties map[string]string
}

Spec is the configuration for a cluster spec.