Documentation
¶
Overview ¶
Package azure contains API Schema definitions for Azure cluster. +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/openshift/hive/apis/hive
Index ¶
Constants ¶
const DefaultDiskType string = "Premium_LRS"
DefaultDiskType holds the default Azure disk type used by the VMs.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CloudEnvironment ¶
type CloudEnvironment string
CloudEnvironment is the name of the Azure cloud environment +kubebuilder:validation:Enum="";AzurePublicCloud;AzureUSGovernmentCloud;AzureChinaCloud;AzureGermanCloud
const ( // PublicCloud is the general-purpose, public Azure cloud environment. PublicCloud CloudEnvironment = "AzurePublicCloud" // USGovernmentCloud is the Azure cloud environment for the US government. USGovernmentCloud CloudEnvironment = "AzureUSGovernmentCloud" // ChinaCloud is the Azure cloud environment used in China. ChinaCloud CloudEnvironment = "AzureChinaCloud" // GermanCloud is the Azure cloud environment used in Germany. GermanCloud CloudEnvironment = "AzureGermanCloud" )
func (CloudEnvironment) Name ¶
func (e CloudEnvironment) Name() string
Name returns name that Azure uses for the cloud environment. See https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13
type DiskEncryptionSet ¶
type DiskEncryptionSet struct {
// SubscriptionID defines the Azure subscription the disk encryption
// set is in.
SubscriptionID string `json:"subscriptionId,omitempty"`
// ResourceGroup defines the Azure resource group used by the disk
// encryption set.
ResourceGroup string `json:"resourceGroup"`
// Name is the name of the disk encryption set.
Name string `json:"name"`
}
DiskEncryptionSet defines the configuration for a disk encryption set.
func (*DiskEncryptionSet) DeepCopy ¶
func (in *DiskEncryptionSet) DeepCopy() *DiskEncryptionSet
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DiskEncryptionSet.
func (*DiskEncryptionSet) DeepCopyInto ¶
func (in *DiskEncryptionSet) DeepCopyInto(out *DiskEncryptionSet)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*DiskEncryptionSet) ToID ¶
func (d *DiskEncryptionSet) ToID() string
ToID creates an Azure resource ID for the disk encryption set. It is possible to return a non-valid ID when SubscriptionID is empty. This should never happen since if SubscriptionID is empty, it is set to the current subscription. Also, should it somehow be empty and this returns an invalid ID, the validation code will produce an error when checked against the validation.RxDiskEncryptionSetID regular expression.
type MachinePool ¶
type MachinePool struct {
// Zones is list of availability zones that can be used.
// eg. ["1", "2", "3"]
Zones []string `json:"zones,omitempty"`
// InstanceType defines the azure instance type.
// eg. Standard_DS_V2
InstanceType string `json:"type"`
// OSDisk defines the storage for instance.
OSDisk `json:"osDisk"`
// OSImage defines the image to use for the OS.
// +optional
OSImage *OSImage `json:"osImage,omitempty"`
}
MachinePool stores the configuration for a machine pool installed on Azure.
func (*MachinePool) DeepCopy ¶
func (in *MachinePool) DeepCopy() *MachinePool
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MachinePool.
func (*MachinePool) DeepCopyInto ¶
func (in *MachinePool) DeepCopyInto(out *MachinePool)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Metadata ¶
type Metadata struct {
// ResourceGroupName is the name of the resource group in which the cluster resources were created.
ResourceGroupName *string `json:"resourceGroupName"`
}
Metadata contains Azure metadata (e.g. for uninstalling the cluster).
func (*Metadata) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Metadata.
func (*Metadata) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OSDisk ¶
type OSDisk struct {
// DiskSizeGB defines the size of disk in GB.
//
// +kubebuilder:validation:Minimum=0
DiskSizeGB int32 `json:"diskSizeGB"`
// DiskType defines the type of disk.
// For control plane nodes, the valid values are Premium_LRS and StandardSSD_LRS.
// Default is Premium_LRS.
// +optional
// +kubebuilder:validation:Enum=Standard_LRS;Premium_LRS;StandardSSD_LRS
DiskType string `json:"diskType,omitempty"`
// DiskEncryptionSet defines a disk encryption set.
//
// +optional
*DiskEncryptionSet `json:"diskEncryptionSet,omitempty"`
}
OSDisk defines the disk for machines on Azure.
func (*OSDisk) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OSDisk.
func (*OSDisk) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OSImage ¶
type OSImage struct {
// Publisher is the publisher of the image.
Publisher string `json:"publisher"`
// Offer is the offer of the image.
Offer string `json:"offer"`
// SKU is the SKU of the image.
SKU string `json:"sku"`
// Version is the version of the image.
Version string `json:"version"`
}
OSImage is the image to use for the OS of a machine.
func (*OSImage) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OSImage.
func (*OSImage) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Platform ¶
type Platform struct {
// CredentialsSecretRef refers to a secret that contains the Azure account access
// credentials.
CredentialsSecretRef corev1.LocalObjectReference `json:"credentialsSecretRef"`
// Region specifies the Azure region where the cluster will be created.
Region string `json:"region"`
// BaseDomainResourceGroupName specifies the resource group where the azure DNS zone for the base domain is found
BaseDomainResourceGroupName string `json:"baseDomainResourceGroupName,omitempty"`
// cloudName is the name of the Azure cloud environment which can be used to configure the Azure SDK
// with the appropriate Azure API endpoints.
// If empty, the value is equal to "AzurePublicCloud".
// +optional
CloudName CloudEnvironment `json:"cloudName,omitempty"`
}
Platform stores all the global configuration that all machinesets use.
func (*Platform) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Platform.
func (*Platform) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Platform) SetBaseDomain ¶
SetBaseDomain parses the baseDomainID and sets the related fields on azure.Platform
Source Files