Documentation ¶
Overview ¶
Package vlabs stores an experimental api model for acs
Index ¶
- Constants
- func GetVNETSubnetIDComponents(vnetSubnetID string) (string, string, string, string, error)
- type AgentPoolProfile
- func (a *AgentPoolProfile) GetSubnet() string
- func (a *AgentPoolProfile) HasDisks() bool
- func (a *AgentPoolProfile) IsAvailabilitySets() bool
- func (a *AgentPoolProfile) IsCustomVNET() bool
- func (a *AgentPoolProfile) IsLinux() bool
- func (a *AgentPoolProfile) IsManagedDisks() bool
- func (a *AgentPoolProfile) IsStorageAccount() bool
- func (a *AgentPoolProfile) IsWindows() bool
- func (a *AgentPoolProfile) SetSubnet(subnet string)
- func (a *AgentPoolProfile) Validate() error
- type CertificateProfile
- type ClassicAgentPoolProfileType
- type ContainerService
- type KeyVaultCertificate
- type KeyVaultID
- type KeyVaultSecrets
- type KubernetesConfig
- type LinuxProfile
- type MasterProfile
- type OSType
- type OrchestratorProfile
- type OrchestratorType
- type Properties
- type ProvisioningState
- type ResourcePurchasePlan
- type ServicePrincipalProfile
- type WindowsProfile
Constants ¶
const ( // DCOS is the string constant for DCOS orchestrator type and defaults to DCOS188 DCOS = "DCOS" // DCOS188 is the string constant for DCOS 1.8.8 orchestrator type DCOS188 OrchestratorType = "DCOS188" // DCOS187 is the string constant for DCOS 1.8.7 orchestrator type DCOS187 OrchestratorType = "DCOS187" // DCOS184 is the string constant for DCOS 1.8.4 orchestrator type DCOS184 = "DCOS184" // DCOS173 is the string constant for DCOS 1.7.3 orchestrator type DCOS173 = "DCOS173" // Swarm is the string constant for the Swarm orchestrator type Swarm = "Swarm" // Kubernetes is the string constant for the Kubernetes orchestrator type Kubernetes = "Kubernetes" // SwarmMode is the string constant for the Swarm Mode orchestrator type SwarmMode = "SwarmMode" )
the orchestrators supported by vlabs
const ( // MinAgentCount are the minimum number of agents per agent pool MinAgentCount = 1 // MaxAgentCount are the maximum number of agents per agent pool MaxAgentCount = 100 // MinPort specifies the minimum tcp port to open MinPort = 1 // MaxPort specifies the maximum tcp port to open MaxPort = 65535 // MaxDisks specifies the maximum attached disks to add to the cluster MaxDisks = 4 // MinDiskSizeGB specifies the minimum attached disk size MinDiskSizeGB = 1 // MaxDiskSizeGB specifies the maximum attached disk size MaxDiskSizeGB = 1024 )
validation values
const ( // AvailabilitySet means that the vms are in an availability set AvailabilitySet = "AvailabilitySet" // VirtualMachineScaleSets means that the vms are in a virtual machine scaleset VirtualMachineScaleSets = "VirtualMachineScaleSets" )
Availability profiles
const ( // StorageAccountClassic means that we follow the older versions (09-30-2016, 03-30-2016) // storage account naming conventions StorageAccountClassic = "StorageAccountClassic" // StorageAccount means that the nodes use raw storage accounts for their os and attached volumes StorageAccount = "StorageAccount" // ManagedDisks means that the nodes use managed disks for their os and attached volumes ManagedDisks = "ManagedDisks" )
storage profiles
const (
// APIVersion is the version of this API
APIVersion = "vlabs"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AgentPoolProfile ¶
type AgentPoolProfile struct { Name string `json:"name"` Count int `json:"count"` VMSize string `json:"vmSize"` DNSPrefix string `json:"dnsPrefix,omitempty"` OSType OSType `json:"osType,omitempty"` Ports []int `json:"ports,omitempty"` AvailabilityProfile string `json:"availabilityProfile"` StorageProfile string `json:"storageProfile"` DiskSizesGB []int `json:"diskSizesGB,omitempty"` VnetSubnetID string `json:"vnetSubnetID,omitempty"` FQDN string `json:"fqdn,omitempty"` // contains filtered or unexported fields }
AgentPoolProfile represents an agent pool definition
func (*AgentPoolProfile) GetSubnet ¶
func (a *AgentPoolProfile) GetSubnet() string
GetSubnet returns the read-only subnet for the agent pool
func (*AgentPoolProfile) HasDisks ¶
func (a *AgentPoolProfile) HasDisks() bool
HasDisks returns true if the customer specified disks
func (*AgentPoolProfile) IsAvailabilitySets ¶
func (a *AgentPoolProfile) IsAvailabilitySets() bool
IsAvailabilitySets returns true if the customer specified disks
func (*AgentPoolProfile) IsCustomVNET ¶
func (a *AgentPoolProfile) IsCustomVNET() bool
IsCustomVNET returns true if the customer brought their own VNET
func (*AgentPoolProfile) IsLinux ¶
func (a *AgentPoolProfile) IsLinux() bool
IsLinux returns true if the agent pool is linux
func (*AgentPoolProfile) IsManagedDisks ¶
func (a *AgentPoolProfile) IsManagedDisks() bool
IsManagedDisks returns true if the customer specified managed disks
func (*AgentPoolProfile) IsStorageAccount ¶
func (a *AgentPoolProfile) IsStorageAccount() bool
IsStorageAccount returns true if the customer specified storage account
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 CertificateProfile ¶
type CertificateProfile struct { // CaCertificate is the certificate authority certificate. CaCertificate string `json:"caCertificate,omitempty"` // ApiServerCertificate is the rest api server certificate, and signed by the CA APIServerCertificate string `json:"apiServerCertificate,omitempty"` // ApiServerPrivateKey is the rest api server private key, and signed by the CA APIServerPrivateKey string `json:"apiServerPrivateKey,omitempty"` // ClientCertificate is the certificate used by the client kubelet services and signed by the CA ClientCertificate string `json:"clientCertificate,omitempty"` // ClientPrivateKey is the private key used by the client kubelet services and signed by the CA ClientPrivateKey string `json:"clientPrivateKey,omitempty"` // KubeConfigCertificate is the client certificate used for kubectl cli and signed by the CA KubeConfigCertificate string `json:"kubeConfigCertificate,omitempty"` // KubeConfigPrivateKey is the client private key used for kubectl cli and signed by the CA KubeConfigPrivateKey string `json:"kubeConfigPrivateKey,omitempty"` // contains filtered or unexported fields }
CertificateProfile represents the definition of the master cluster The JSON parameters could be either a plain text, or referenced to a secret in a keyvault. In the latter case, the format of the parameter's value should be "/subscriptions/<SUB_ID>/resourceGroups/<RG_NAME>/providers/Microsoft.KeyVault/vaults/<KV_NAME>/secrets/<NAME>[/<VERSION>]" where:
<SUB_ID> is the subscription ID of the keyvault <RG_NAME> is the resource group of the keyvault <KV_NAME> is the name of the keyvault <NAME> is the name of the secret <VERSION> (optional) is the version of the secret (default: the latest version)
func (*CertificateProfile) GetCAPrivateKey ¶
func (c *CertificateProfile) GetCAPrivateKey() string
GetCAPrivateKey returns the ca private key
func (*CertificateProfile) SetCAPrivateKey ¶
func (c *CertificateProfile) SetCAPrivateKey(caPrivateKey string)
SetCAPrivateKey sets the ca private key
type ClassicAgentPoolProfileType ¶
type ClassicAgentPoolProfileType string
ClassicAgentPoolProfileType represents types of classic profiles
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 KeyVaultCertificate ¶
type KeyVaultCertificate struct { CertificateURL string `json:"certificateUrl,omitempty"` CertificateStore string `json:"certificateStore,omitempty"` }
KeyVaultCertificate specifies a certificate to install On Linux, the certificate file is placed under the /var/lib/waagent directory with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for the private key. Both of these files are .pem formatted. On windows the certificate will be saved in the specified store.
type KeyVaultID ¶
type KeyVaultID struct {
ID string `json:"id,omitempty"`
}
KeyVaultID specifies a key vault
type KeyVaultSecrets ¶
type KeyVaultSecrets struct { SourceVault KeyVaultID `json:"sourceVault,omitempty"` VaultCertificates []KeyVaultCertificate `json:"vaultCertificates,omitempty"` }
KeyVaultSecrets specifies certificates to install on the pool of machines from a given key vault the key vault specified must have been granted read permissions to CRP
type KubernetesConfig ¶
type KubernetesConfig struct {
KubernetesImageBase string `json:"kubernetesImageBase,omitempty"`
}
KubernetesConfig contains the Kubernetes config structure, containing Kubernetes specific configuration
type LinuxProfile ¶
type LinuxProfile struct { AdminUsername string `json:"adminUsername"` SSH struct { PublicKeys []struct { KeyData string `json:"keyData"` } `json:"publicKeys"` } `json:"ssh"` Secrets []KeyVaultSecrets `json:"secrets,omitempty"` }
LinuxProfile represents the linux parameters 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"` VMSize string `json:"vmSize"` VnetSubnetID string `json:"vnetSubnetID,omitempty"` FirstConsecutiveStaticIP string `json:"firstConsecutiveStaticIP,omitempty"` StorageProfile string `json:"storageProfile,omitempty"` // 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 the master cluster
func (*MasterProfile) GetSubnet ¶
func (m *MasterProfile) GetSubnet() string
GetSubnet returns the read-only subnet for the master
func (*MasterProfile) IsCustomVNET ¶
func (m *MasterProfile) IsCustomVNET() bool
IsCustomVNET returns true if the customer brought their own VNET
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"` KubernetesConfig KubernetesConfig `json:"kubernetesConfig,omitempty"` }
OrchestratorProfile contains Orchestrator properties
func (*OrchestratorProfile) IsSwarmMode ¶
func (o *OrchestratorProfile) IsSwarmMode() bool
IsSwarmMode returns true if this template is for Swarm Mode orchestrator
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,omitempty"` ServicePrincipalProfile ServicePrincipalProfile `json:"servicePrincipalProfile"` CertificateProfile CertificateProfile `json:"certificateProfile"` }
Properties represents the ACS cluster definition
func (*Properties) HasWindows ¶
func (p *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:"servicePrincipalClientID,omitempty"` Secret string `json:"servicePrincipalClientSecret,omitempty"` }
ServicePrincipalProfile contains the client and secret used by the cluster for Azure Resource CRUD The 'Secret' parameter could be either a plain text, or referenced to a secret in a keyvault. In the latter case, the format of the parameter's value should be "/subscriptions/<SUB_ID>/resourceGroups/<RG_NAME>/providers/Microsoft.KeyVault/vaults/<KV_NAME>/secrets/<NAME>[/<VERSION>]" where:
<SUB_ID> is the subscription ID of the keyvault <RG_NAME> is the resource group of the keyvault <KV_NAME> is the name of the keyvault <NAME> is the name of the secret. <VERSION> (optional) is the version of the secret (default: the latest version)
type WindowsProfile ¶
type WindowsProfile struct { AdminUsername string `json:"adminUsername,omitempty"` AdminPassword string `json:"adminPassword,omitempty"` Secrets []KeyVaultSecrets `json:"secrets,omitempty"` }
WindowsProfile represents the windows parameters passed to the cluster