Documentation ¶
Overview ¶
Package v20160930 stores api model for version "2016-09-30"
Index ¶
- Constants
- type AgentPoolProfile
- type ContainerService
- type CustomProfile
- type DiagnosticsProfile
- type JumpboxProfile
- type LinuxProfile
- type MasterProfile
- type OSType
- type OrchestratorProfile
- type OrchestratorType
- type Properties
- type ProvisioningState
- type ResourcePurchasePlan
- type ServicePrincipalProfile
- type VMDiagnostics
- type WindowsProfile
Constants ¶
const ( // Mesos is the string constant for the Mesos orchestrator type Mesos OrchestratorType = "Mesos" // DCOS is the string constant for DCOS orchestrator type and defaults to DCOS187 DCOS = "DCOS" // Swarm is the string constant for the Swarm orchestrator type Swarm = "Swarm" // Kubernetes is the string constant for the Kubernetes orchestrator type Kubernetes = "Kubernetes" )
the orchestrators supported by 2016-09-30
const ( // MinAgentCount are the minimum number of agents MinAgentCount = 1 // MaxAgentCount are the maximum number of agents MaxAgentCount = 100 )
validation values
const (
// APIVersion is the version of this API
APIVersion = "2016-09-30"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentPoolProfile ¶
type AgentPoolProfile struct { Name string `json:"name"` Count int `json:"count"` VMSize string `json:"vmSize"` DNSPrefix string `json:"dnsPrefix"` FQDN string `json:"fqdn,omitempty"` // OSType is the operating system type for agents // Set as nullable to support backward compat because // this property was added later. // If the value is null or not set, it defaulted to Linux. OSType OSType `json:"osType,omitempty"` // contains filtered or unexported fields }
AgentPoolProfile represents configuration of VMs running agent daemons that register with the master and offer resources to host applications in containers.
func (*AgentPoolProfile) GetSubnet ¶
func (a *AgentPoolProfile) GetSubnet() string
GetSubnet returns the read-only subnet for the agent pool
func (*AgentPoolProfile) IsLinux ¶
func (a *AgentPoolProfile) IsLinux() bool
IsLinux returns true if the agent pool is linux
func (*AgentPoolProfile) IsWindows ¶
func (a *AgentPoolProfile) IsWindows() bool
IsWindows returns true if the agent pool is windows
func (*AgentPoolProfile) SetSubnet ¶
func (a *AgentPoolProfile) SetSubnet(subnet string)
SetSubnet sets the read-only subnet for the agent pool
func (*AgentPoolProfile) Validate ¶
func (a *AgentPoolProfile) Validate() error
Validate implements APIObject
type ContainerService ¶
type ContainerService struct { ID string `json:"id,omitempty"` Location string `json:"location,omitempty"` Name string `json:"name,omitempty"` Plan ResourcePurchasePlan `json:"plan,omitempty"` Tags map[string]string `json:"tags,omitempty"` Type string `json:"type,omitempty"` Properties Properties `json:"properties"` }
ContainerService complies with the ARM model of resource definition in a JSON template.
type CustomProfile ¶
type CustomProfile struct {
Orchestrator string `json:"orchestrator,omitempty"`
}
CustomProfile specifies custom properties that are used for cluster instantiation. Should not be used by most users.
type DiagnosticsProfile ¶
type DiagnosticsProfile struct {
VMDiagnostics VMDiagnostics `json:"vmDiagnostics"`
}
DiagnosticsProfile setting to enable/disable capturing diagnostics for VMs hosting container cluster.
type JumpboxProfile ¶
type JumpboxProfile struct { OSType OSType `json:"osType,omitempty"` DNSPrefix string `json:"dnsPrefix"` // Jumpbox public endpoint/FQDN with port // The format will be FQDN:2376 // Not used during PUT, returned as part of GET FQDN string `json:"fqdn,omitempty"` }
JumpboxProfile dscribes properties of the jumpbox setup in the ACS container cluster.
type LinuxProfile ¶
type LinuxProfile struct { AdminUsername string `json:"adminUsername"` SSH struct { PublicKeys []struct { KeyData string `json:"keyData"` } `json:"publicKeys"` } `json:"ssh"` }
LinuxProfile represents the Linux configuration passed to the cluster
func (*LinuxProfile) Validate ¶
func (l *LinuxProfile) Validate() error
Validate implements APIObject
type MasterProfile ¶
type MasterProfile struct { Count int `json:"count"` DNSPrefix string `json:"dnsPrefix"` // Master LB public endpoint/FQDN with port // The format will be FQDN:2376 // Not used during PUT, returned as part of GET FQDN string `json:"fqdn,omitempty"` // contains filtered or unexported fields }
MasterProfile represents the definition of master cluster
func (*MasterProfile) GetSubnet ¶
func (m *MasterProfile) GetSubnet() string
GetSubnet returns the read-only subnet for the master
func (*MasterProfile) SetSubnet ¶
func (m *MasterProfile) SetSubnet(subnet string)
SetSubnet sets the read-only subnet for the master
func (*MasterProfile) Validate ¶
func (m *MasterProfile) Validate() error
Validate implements APIObject
type OrchestratorProfile ¶
type OrchestratorProfile struct {
OrchestratorType OrchestratorType `json:"orchestratorType"`
}
OrchestratorProfile contains Orchestrator properties
func (*OrchestratorProfile) Validate ¶
func (o *OrchestratorProfile) Validate() error
Validate implements APIObject
type OrchestratorType ¶
type OrchestratorType string
OrchestratorType defines orchestrators supported by ACS
type Properties ¶
type Properties struct { ProvisioningState ProvisioningState `json:"provisioningState"` OrchestratorProfile OrchestratorProfile `json:"orchestratorProfile"` MasterProfile MasterProfile `json:"masterProfile"` AgentPoolProfiles []AgentPoolProfile `json:"agentPoolProfiles"` LinuxProfile LinuxProfile `json:"linuxProfile"` WindowsProfile WindowsProfile `json:"windowsProfile"` DiagnosticsProfile DiagnosticsProfile `json:"diagnosticsProfile"` JumpboxProfile JumpboxProfile `json:"jumpboxProfile"` ServicePrincipalProfile ServicePrincipalProfile `json:"servicePrincipalProfile"` CustomProfile CustomProfile `json:"customProfile"` }
Properties represents the ACS cluster definition
func (*Properties) HasWindows ¶
func (a *Properties) HasWindows() bool
HasWindows returns true if the cluster contains windows
type ProvisioningState ¶
type ProvisioningState string
ProvisioningState represents the current state of container service resource.
const ( // Creating means ContainerService resource is being created. Creating ProvisioningState = "Creating" // Updating means an existing ContainerService resource is being updated Updating ProvisioningState = "Updating" // Failed means resource is in failed state Failed ProvisioningState = "Failed" // Succeeded means resource created succeeded during last create/update Succeeded ProvisioningState = "Succeeded" // Deleting means resource is in the process of being deleted Deleting ProvisioningState = "Deleting" // Migrating means resource is being migrated from one subscription or // resource group to another Migrating ProvisioningState = "Migrating" )
type ResourcePurchasePlan ¶
type ResourcePurchasePlan struct { Name string `json:"name,omitempty"` Product string `json:"product,omitempty"` PromotionCode string `json:"promotionCode,omitempty"` Publisher string `json:"publisher,omitempty"` }
ResourcePurchasePlan defines resource plan as required by ARM for billing purposes.
type ServicePrincipalProfile ¶
type ServicePrincipalProfile struct { ClientID string `json:"clientId,omitempty"` Secret string `json:"secret,omitempty"` }
ServicePrincipalProfile contains the client and secret used by the cluster for Azure Resource CRUD
type VMDiagnostics ¶
type VMDiagnostics struct { Enabled bool `json:"enabled"` // Specifies storage account Uri where Boot Diagnostics (CRP & // VMSS BootDiagostics) and VM Diagnostics logs (using Linux // Diagnostics Extension) will be stored. Uri will be of standard // blob domain. i.e. https://storageaccount.blob.core.windows.net/ // This field is readonly as ACS RP will create a storage account // for the customer. StorageURL neturl.URL `json:"storageUrl"` }
VMDiagnostics contains settings to on/off boot diagnostics collection in RD Host
type WindowsProfile ¶
type WindowsProfile struct { AdminUsername string `json:"adminUsername,omitempty"` AdminPassword string `json:"adminPassword,omitempty"` }
WindowsProfile represents the Windows configuration passed to the cluster