Documentation
¶
Overview ¶
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Code generated by azure-service-operator-codegen. DO NOT EDIT. Copyright (c) Microsoft Corporation. Licensed under the MIT license.
Index ¶
- Constants
- type APIServerProfile
- type APIServerProfile_STATUS
- type ClusterProfile
- type ClusterProfile_STATUS
- type ConsoleProfile_STATUS
- type EffectiveOutboundIP_STATUS
- type EncryptionAtHost
- type EncryptionAtHost_STATUS
- type FipsValidatedModules
- type FipsValidatedModules_STATUS
- type IngressProfile
- type IngressProfile_STATUS
- type LoadBalancerProfile
- type LoadBalancerProfile_STATUS
- type ManagedOutboundIPs
- type ManagedOutboundIPs_STATUS
- type MasterProfile
- type MasterProfile_STATUS
- type NetworkProfile
- type NetworkProfile_STATUS
- type OpenShiftClusterProperties
- type OpenShiftClusterProperties_STATUS
- type OpenShiftCluster_STATUS
- type OpenShiftCluster_Spec
- type OutboundType
- type OutboundType_STATUS
- type PreconfiguredNSG
- type PreconfiguredNSG_STATUS
- type ProvisioningState_STATUS
- type ServicePrincipalProfile
- type ServicePrincipalProfile_STATUS
- type SystemData_CreatedByType_STATUS
- type SystemData_LastModifiedByType_STATUS
- type SystemData_STATUS
- type Visibility
- type Visibility_STATUS
- type WorkerProfile
- type WorkerProfile_STATUS
Constants ¶
const ( EncryptionAtHost_Disabled = EncryptionAtHost("Disabled") EncryptionAtHost_Enabled = EncryptionAtHost("Enabled") )
const ( FipsValidatedModules_Disabled = FipsValidatedModules("Disabled") FipsValidatedModules_Enabled = FipsValidatedModules("Enabled") )
const ( OutboundType_Loadbalancer = OutboundType("Loadbalancer") OutboundType_UserDefinedRouting = OutboundType("UserDefinedRouting") )
const ( PreconfiguredNSG_Disabled = PreconfiguredNSG("Disabled") PreconfiguredNSG_Enabled = PreconfiguredNSG("Enabled") )
const ( Visibility_Private = Visibility("Private") Visibility_Public = Visibility("Public") )
const ( ProvisioningState_STATUS_AdminUpdating = ProvisioningState_STATUS("AdminUpdating") ProvisioningState_STATUS_Canceled = ProvisioningState_STATUS("Canceled") ProvisioningState_STATUS_Creating = ProvisioningState_STATUS("Creating") ProvisioningState_STATUS_Deleting = ProvisioningState_STATUS("Deleting") ProvisioningState_STATUS_Failed = ProvisioningState_STATUS("Failed") ProvisioningState_STATUS_Succeeded = ProvisioningState_STATUS("Succeeded") ProvisioningState_STATUS_Updating = ProvisioningState_STATUS("Updating") )
const ( SystemData_CreatedByType_STATUS_Application = SystemData_CreatedByType_STATUS("Application") SystemData_CreatedByType_STATUS_Key = SystemData_CreatedByType_STATUS("Key") SystemData_CreatedByType_STATUS_ManagedIdentity = SystemData_CreatedByType_STATUS("ManagedIdentity") SystemData_CreatedByType_STATUS_User = SystemData_CreatedByType_STATUS("User") )
const ( SystemData_LastModifiedByType_STATUS_Application = SystemData_LastModifiedByType_STATUS("Application") SystemData_LastModifiedByType_STATUS_Key = SystemData_LastModifiedByType_STATUS("Key") SystemData_LastModifiedByType_STATUS_ManagedIdentity = SystemData_LastModifiedByType_STATUS("ManagedIdentity") SystemData_LastModifiedByType_STATUS_User = SystemData_LastModifiedByType_STATUS("User") )
const ( EncryptionAtHost_STATUS_Disabled = EncryptionAtHost_STATUS("Disabled") EncryptionAtHost_STATUS_Enabled = EncryptionAtHost_STATUS("Enabled") )
const ( FipsValidatedModules_STATUS_Disabled = FipsValidatedModules_STATUS("Disabled") FipsValidatedModules_STATUS_Enabled = FipsValidatedModules_STATUS("Enabled") )
const ( OutboundType_STATUS_Loadbalancer = OutboundType_STATUS("Loadbalancer") OutboundType_STATUS_UserDefinedRouting = OutboundType_STATUS("UserDefinedRouting") )
const ( PreconfiguredNSG_STATUS_Disabled = PreconfiguredNSG_STATUS("Disabled") PreconfiguredNSG_STATUS_Enabled = PreconfiguredNSG_STATUS("Enabled") )
const ( Visibility_STATUS_Private = Visibility_STATUS("Private") Visibility_STATUS_Public = Visibility_STATUS("Public") )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIServerProfile ¶
type APIServerProfile struct {
// Visibility: API server visibility.
Visibility *Visibility `json:"visibility,omitempty"`
}
APIServerProfile represents an API server profile.
type APIServerProfile_STATUS ¶
type APIServerProfile_STATUS struct {
// Ip: The IP of the cluster API server.
Ip *string `json:"ip,omitempty"`
// Url: The URL to access the cluster API server.
Url *string `json:"url,omitempty"`
// Visibility: API server visibility.
Visibility *Visibility_STATUS `json:"visibility,omitempty"`
}
APIServerProfile represents an API server profile.
type ClusterProfile ¶
type ClusterProfile struct {
// Domain: The domain for the cluster.
Domain *string `json:"domain,omitempty"`
// FipsValidatedModules: If FIPS validated crypto modules are used
FipsValidatedModules *FipsValidatedModules `json:"fipsValidatedModules,omitempty"`
// PullSecret: The pull secret for the cluster.
PullSecret *string `json:"pullSecret,omitempty"`
// ResourceGroupId: The ID of the cluster resource group.
ResourceGroupId *string `json:"resourceGroupId,omitempty"`
// Version: The version of the cluster.
Version *string `json:"version,omitempty"`
}
ClusterProfile represents a cluster profile.
type ClusterProfile_STATUS ¶
type ClusterProfile_STATUS struct {
// Domain: The domain for the cluster.
Domain *string `json:"domain,omitempty"`
// FipsValidatedModules: If FIPS validated crypto modules are used
FipsValidatedModules *FipsValidatedModules_STATUS `json:"fipsValidatedModules,omitempty"`
// ResourceGroupId: The ID of the cluster resource group.
ResourceGroupId *string `json:"resourceGroupId,omitempty"`
// Version: The version of the cluster.
Version *string `json:"version,omitempty"`
}
ClusterProfile represents a cluster profile.
type ConsoleProfile_STATUS ¶
type ConsoleProfile_STATUS struct {
// Url: The URL to access the cluster console.
Url *string `json:"url,omitempty"`
}
ConsoleProfile represents a console profile.
type EffectiveOutboundIP_STATUS ¶
type EffectiveOutboundIP_STATUS struct {
// Id: The fully qualified Azure resource id of an IP address resource.
Id *string `json:"id,omitempty"`
}
EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer.
type EncryptionAtHost ¶
type EncryptionAtHost string
EncryptionAtHost represents encryption at host state +kubebuilder:validation:Enum={"Disabled","Enabled"}
type EncryptionAtHost_STATUS ¶
type EncryptionAtHost_STATUS string
EncryptionAtHost represents encryption at host state
type FipsValidatedModules ¶
type FipsValidatedModules string
FipsValidatedModules determines if FIPS is used. +kubebuilder:validation:Enum={"Disabled","Enabled"}
type FipsValidatedModules_STATUS ¶
type FipsValidatedModules_STATUS string
FipsValidatedModules determines if FIPS is used.
type IngressProfile ¶
type IngressProfile struct {
// Name: The ingress profile name.
Name *string `json:"name,omitempty"`
// Visibility: Ingress visibility.
Visibility *Visibility `json:"visibility,omitempty"`
}
IngressProfile represents an ingress profile.
type IngressProfile_STATUS ¶
type IngressProfile_STATUS struct {
// Ip: The IP of the ingress.
Ip *string `json:"ip,omitempty"`
// Name: The ingress profile name.
Name *string `json:"name,omitempty"`
// Visibility: Ingress visibility.
Visibility *Visibility_STATUS `json:"visibility,omitempty"`
}
IngressProfile represents an ingress profile.
type LoadBalancerProfile ¶
type LoadBalancerProfile struct {
// ManagedOutboundIps: The desired managed outbound IPs for the cluster public load balancer.
ManagedOutboundIps *ManagedOutboundIPs `json:"managedOutboundIps,omitempty"`
}
LoadBalancerProfile represents the profile of the cluster public load balancer.
type LoadBalancerProfile_STATUS ¶
type LoadBalancerProfile_STATUS struct {
// EffectiveOutboundIps: The list of effective outbound IP addresses of the public load balancer.
EffectiveOutboundIps []EffectiveOutboundIP_STATUS `json:"effectiveOutboundIps,omitempty"`
// ManagedOutboundIps: The desired managed outbound IPs for the cluster public load balancer.
ManagedOutboundIps *ManagedOutboundIPs_STATUS `json:"managedOutboundIps,omitempty"`
}
LoadBalancerProfile represents the profile of the cluster public load balancer.
type ManagedOutboundIPs ¶
type ManagedOutboundIPs struct {
// Count: Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load
// balancer. Allowed values are in the range of 1 - 20. The default value is 1.
Count *int `json:"count,omitempty"`
}
ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.
type ManagedOutboundIPs_STATUS ¶
type ManagedOutboundIPs_STATUS struct {
// Count: Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load
// balancer. Allowed values are in the range of 1 - 20. The default value is 1.
Count *int `json:"count,omitempty"`
}
ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer.
type MasterProfile ¶
type MasterProfile struct {
DiskEncryptionSetId *string `json:"diskEncryptionSetId,omitempty"`
// EncryptionAtHost: Whether master virtual machines are encrypted at host.
EncryptionAtHost *EncryptionAtHost `json:"encryptionAtHost,omitempty"`
SubnetId *string `json:"subnetId,omitempty"`
// VmSize: The size of the master VMs.
VmSize *string `json:"vmSize,omitempty"`
}
MasterProfile represents a master profile.
type MasterProfile_STATUS ¶
type MasterProfile_STATUS struct {
// DiskEncryptionSetId: The resource ID of an associated DiskEncryptionSet, if applicable.
DiskEncryptionSetId *string `json:"diskEncryptionSetId,omitempty"`
// EncryptionAtHost: Whether master virtual machines are encrypted at host.
EncryptionAtHost *EncryptionAtHost_STATUS `json:"encryptionAtHost,omitempty"`
// SubnetId: The Azure resource ID of the master subnet.
SubnetId *string `json:"subnetId,omitempty"`
// VmSize: The size of the master VMs.
VmSize *string `json:"vmSize,omitempty"`
}
MasterProfile represents a master profile.
type NetworkProfile ¶
type NetworkProfile struct {
// LoadBalancerProfile: The cluster load balancer profile.
LoadBalancerProfile *LoadBalancerProfile `json:"loadBalancerProfile,omitempty"`
// OutboundType: The OutboundType used for egress traffic.
OutboundType *OutboundType `json:"outboundType,omitempty"`
// PodCidr: The CIDR used for OpenShift/Kubernetes Pods.
PodCidr *string `json:"podCidr,omitempty"`
// PreconfiguredNSG: Specifies whether subnets are pre-attached with an NSG
PreconfiguredNSG *PreconfiguredNSG `json:"preconfiguredNSG,omitempty"`
// ServiceCidr: The CIDR used for OpenShift/Kubernetes Services.
ServiceCidr *string `json:"serviceCidr,omitempty"`
}
NetworkProfile represents a network profile.
type NetworkProfile_STATUS ¶
type NetworkProfile_STATUS struct {
// LoadBalancerProfile: The cluster load balancer profile.
LoadBalancerProfile *LoadBalancerProfile_STATUS `json:"loadBalancerProfile,omitempty"`
// OutboundType: The OutboundType used for egress traffic.
OutboundType *OutboundType_STATUS `json:"outboundType,omitempty"`
// PodCidr: The CIDR used for OpenShift/Kubernetes Pods.
PodCidr *string `json:"podCidr,omitempty"`
// PreconfiguredNSG: Specifies whether subnets are pre-attached with an NSG
PreconfiguredNSG *PreconfiguredNSG_STATUS `json:"preconfiguredNSG,omitempty"`
// ServiceCidr: The CIDR used for OpenShift/Kubernetes Services.
ServiceCidr *string `json:"serviceCidr,omitempty"`
}
NetworkProfile represents a network profile.
type OpenShiftClusterProperties ¶
type OpenShiftClusterProperties struct {
// ApiserverProfile: The cluster API server profile.
ApiserverProfile *APIServerProfile `json:"apiserverProfile,omitempty"`
// ClusterProfile: The cluster profile.
ClusterProfile *ClusterProfile `json:"clusterProfile,omitempty"`
// IngressProfiles: The cluster ingress profiles.
IngressProfiles []IngressProfile `json:"ingressProfiles,omitempty"`
// MasterProfile: The cluster master profile.
MasterProfile *MasterProfile `json:"masterProfile,omitempty"`
// NetworkProfile: The cluster network profile.
NetworkProfile *NetworkProfile `json:"networkProfile,omitempty"`
// ServicePrincipalProfile: The cluster service principal profile.
ServicePrincipalProfile *ServicePrincipalProfile `json:"servicePrincipalProfile,omitempty"`
// WorkerProfiles: The cluster worker profiles.
WorkerProfiles []WorkerProfile `json:"workerProfiles,omitempty"`
}
OpenShiftClusterProperties represents an OpenShift cluster's properties.
type OpenShiftClusterProperties_STATUS ¶
type OpenShiftClusterProperties_STATUS struct {
// ApiserverProfile: The cluster API server profile.
ApiserverProfile *APIServerProfile_STATUS `json:"apiserverProfile,omitempty"`
// ClusterProfile: The cluster profile.
ClusterProfile *ClusterProfile_STATUS `json:"clusterProfile,omitempty"`
// ConsoleProfile: The console profile.
ConsoleProfile *ConsoleProfile_STATUS `json:"consoleProfile,omitempty"`
// IngressProfiles: The cluster ingress profiles.
IngressProfiles []IngressProfile_STATUS `json:"ingressProfiles,omitempty"`
// MasterProfile: The cluster master profile.
MasterProfile *MasterProfile_STATUS `json:"masterProfile,omitempty"`
// NetworkProfile: The cluster network profile.
NetworkProfile *NetworkProfile_STATUS `json:"networkProfile,omitempty"`
// ProvisioningState: The cluster provisioning state.
ProvisioningState *ProvisioningState_STATUS `json:"provisioningState,omitempty"`
// ServicePrincipalProfile: The cluster service principal profile.
ServicePrincipalProfile *ServicePrincipalProfile_STATUS `json:"servicePrincipalProfile,omitempty"`
// WorkerProfiles: The cluster worker profiles.
WorkerProfiles []WorkerProfile_STATUS `json:"workerProfiles,omitempty"`
// WorkerProfilesStatus: The cluster worker profiles status.
WorkerProfilesStatus []WorkerProfile_STATUS `json:"workerProfilesStatus,omitempty"`
}
OpenShiftClusterProperties represents an OpenShift cluster's properties.
type OpenShiftCluster_STATUS ¶
type OpenShiftCluster_STATUS struct {
// Id: Fully qualified resource ID for the resource. Ex -
// /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Id *string `json:"id,omitempty"`
// Location: The geo-location where the resource lives
Location *string `json:"location,omitempty"`
// Name: The name of the resource
Name *string `json:"name,omitempty"`
// Properties: The cluster properties.
Properties *OpenShiftClusterProperties_STATUS `json:"properties,omitempty"`
// SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.
SystemData *SystemData_STATUS `json:"systemData,omitempty"`
// Tags: Resource tags.
Tags map[string]string `json:"tags,omitempty"`
// Type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Type *string `json:"type,omitempty"`
}
OpenShiftCluster represents an Azure Red Hat OpenShift cluster.
type OpenShiftCluster_Spec ¶
type OpenShiftCluster_Spec struct {
// Location: The geo-location where the resource lives
Location *string `json:"location,omitempty"`
Name string `json:"name,omitempty"`
// Properties: The cluster properties.
Properties *OpenShiftClusterProperties `json:"properties,omitempty"`
// Tags: Resource tags.
Tags map[string]string `json:"tags,omitempty"`
}
func (OpenShiftCluster_Spec) GetAPIVersion ¶
func (cluster OpenShiftCluster_Spec) GetAPIVersion() string
GetAPIVersion returns the ARM API version of the resource. This is always "2023-11-22"
func (*OpenShiftCluster_Spec) GetName ¶
func (cluster *OpenShiftCluster_Spec) GetName() string
GetName returns the Name of the resource
func (*OpenShiftCluster_Spec) GetType ¶
func (cluster *OpenShiftCluster_Spec) GetType() string
GetType returns the ARM Type of the resource. This is always "Microsoft.RedHatOpenShift/openShiftClusters"
type OutboundType ¶
type OutboundType string
The outbound routing strategy used to provide your cluster egress to the internet. +kubebuilder:validation:Enum={"Loadbalancer","UserDefinedRouting"}
type OutboundType_STATUS ¶
type OutboundType_STATUS string
The outbound routing strategy used to provide your cluster egress to the internet.
type PreconfiguredNSG ¶
type PreconfiguredNSG string
PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets +kubebuilder:validation:Enum={"Disabled","Enabled"}
type PreconfiguredNSG_STATUS ¶
type PreconfiguredNSG_STATUS string
PreconfiguredNSG represents whether customers want to use their own NSG attached to the subnets
type ProvisioningState_STATUS ¶
type ProvisioningState_STATUS string
ProvisioningState represents a provisioning state.
type ServicePrincipalProfile ¶
type ServicePrincipalProfile struct {
// ClientId: The client ID used for the cluster.
ClientId *string `json:"clientId,omitempty" optionalConfigMapPair:"ClientId"`
// ClientSecret: The client secret used for the cluster.
ClientSecret *string `json:"clientSecret,omitempty"`
}
ServicePrincipalProfile represents a service principal profile.
type ServicePrincipalProfile_STATUS ¶
type ServicePrincipalProfile_STATUS struct {
// ClientId: The client ID used for the cluster.
ClientId *string `json:"clientId,omitempty"`
}
ServicePrincipalProfile represents a service principal profile.
type SystemData_CreatedByType_STATUS ¶
type SystemData_CreatedByType_STATUS string
type SystemData_LastModifiedByType_STATUS ¶
type SystemData_LastModifiedByType_STATUS string
type SystemData_STATUS ¶
type SystemData_STATUS struct {
// CreatedAt: The timestamp of resource creation (UTC).
CreatedAt *string `json:"createdAt,omitempty"`
// CreatedBy: The identity that created the resource.
CreatedBy *string `json:"createdBy,omitempty"`
// CreatedByType: The type of identity that created the resource.
CreatedByType *SystemData_CreatedByType_STATUS `json:"createdByType,omitempty"`
// LastModifiedAt: The timestamp of resource last modification (UTC)
LastModifiedAt *string `json:"lastModifiedAt,omitempty"`
// LastModifiedBy: The identity that last modified the resource.
LastModifiedBy *string `json:"lastModifiedBy,omitempty"`
// LastModifiedByType: The type of identity that last modified the resource.
LastModifiedByType *SystemData_LastModifiedByType_STATUS `json:"lastModifiedByType,omitempty"`
}
Metadata pertaining to creation and last modification of the resource.
type Visibility ¶
type Visibility string
Visibility represents visibility. +kubebuilder:validation:Enum={"Private","Public"}
type WorkerProfile ¶
type WorkerProfile struct {
// Count: The number of worker VMs.
Count *int `json:"count,omitempty"`
DiskEncryptionSetId *string `json:"diskEncryptionSetId,omitempty"`
// DiskSizeGB: The disk size of the worker VMs.
DiskSizeGB *int `json:"diskSizeGB,omitempty"`
// EncryptionAtHost: Whether master virtual machines are encrypted at host.
EncryptionAtHost *EncryptionAtHost `json:"encryptionAtHost,omitempty"`
// Name: The worker profile name.
Name *string `json:"name,omitempty"`
SubnetId *string `json:"subnetId,omitempty"`
// VmSize: The size of the worker VMs.
VmSize *string `json:"vmSize,omitempty"`
}
WorkerProfile represents a worker profile.
type WorkerProfile_STATUS ¶
type WorkerProfile_STATUS struct {
// Count: The number of worker VMs.
Count *int `json:"count,omitempty"`
// DiskEncryptionSetId: The resource ID of an associated DiskEncryptionSet, if applicable.
DiskEncryptionSetId *string `json:"diskEncryptionSetId,omitempty"`
// DiskSizeGB: The disk size of the worker VMs.
DiskSizeGB *int `json:"diskSizeGB,omitempty"`
// EncryptionAtHost: Whether master virtual machines are encrypted at host.
EncryptionAtHost *EncryptionAtHost_STATUS `json:"encryptionAtHost,omitempty"`
// Name: The worker profile name.
Name *string `json:"name,omitempty"`
// SubnetId: The Azure resource ID of the worker subnet.
SubnetId *string `json:"subnetId,omitempty"`
// VmSize: The size of the worker VMs.
VmSize *string `json:"vmSize,omitempty"`
}
WorkerProfile represents a worker profile.