v20170930

Documentation

Index

• Constants
• type OSType
• type OrchestratorProfile
  • func (o *OrchestratorProfile) ValidateForUpgrade() error
• type OrchestratorVersionProfile
  • func (o *OrchestratorVersionProfile) Validate() error
• type OrchestratorVersionProfileList
• type PoolUpgradeProfile
• type UpgradeProfile

Constants

const (
	// DCOS is the string constant for DCOS orchestrator type and defaults to DCOS187
	DCOS string = "DCOS"
	// Swarm is the string constant for the Swarm orchestrator type
	Swarm string = "Swarm"
	// Kubernetes is the string constant for the Kubernetes orchestrator type
	Kubernetes string = "Kubernetes"
	// DockerCE is the string constant for the Docker CE orchestrator type
	DockerCE string = "DockerCE"
)

the orchestrators supported by 2017-07-01

const (
	// APIVersion is the version of this API
	APIVersion = "2017-09-30"
)

Types

type OSType

type OSType string

OSType represents OS types of agents

type OrchestratorProfile

type OrchestratorProfile struct {
	OrchestratorType    string `json:"orchestratorType"`
	OrchestratorRelease string `json:"orchestratorRelease"`
	OrchestratorVersion string `json:"orchestratorVersion"`
}

OrchestratorProfile contains orchestrator properties:

• type: kubernetes, DCOS, etc.
• release: major and minor version numbers
• version: major, minor, and patch version numbers

func (*OrchestratorProfile) ValidateForUpgrade

func (o *OrchestratorProfile) ValidateForUpgrade() error

ValidateForUpgrade validates upgrade input data

type OrchestratorVersionProfile

type OrchestratorVersionProfile struct {
	OrchestratorProfile
	Default  bool                   `json:"default,omitempty"`
	Upgrades []*OrchestratorProfile `json:"upgrades,omitempty"`
}

OrchestratorVersionProfile contains information of a supported orchestrator version:

• orchestrator type and version
• whether this orchestrator version is deployed by default if orchestrator release is not specified
• list of available upgrades for this orchestrator version

func (*OrchestratorVersionProfile) Validate

func (o *OrchestratorVersionProfile) Validate() error

Validate implements APIObject

type OrchestratorVersionProfileList

type OrchestratorVersionProfileList struct {
	Orchestrators []*OrchestratorVersionProfile `json:"orchestrators"`
}

OrchestratorVersionProfileList contains list of version profiles for supported orchestrators

type PoolUpgradeProfile

type PoolUpgradeProfile struct {
	OrchestratorProfile
	Name     string                 `json:"name,omitempty"`
	OSType   string                 `json:"osType,omitempty"`
	Upgrades []*OrchestratorProfile `json:"upgrades,omitempty"`
}

PoolUpgradeProfile contains pool properties:

• orchestrator type and version
• pool name (for agent pool)
• OS type of the VMs in the pool
• list of applicable upgrades

type UpgradeProfile

type UpgradeProfile struct {
	ControlPlaneProfile *PoolUpgradeProfile   `json:"controlPlaneProfile"`
	AgentPoolProfiles   []*PoolUpgradeProfile `json:"agentPoolProfiles"`
}

UpgradeProfile contains cluster properties:

• orchestrator type and version for the cluster
• list of pool profiles, constituting the cluster