Package io.fabric8.openshift.api.model.installer.azure.v1

Class Platform

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<PlatformBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class Platform
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<PlatformBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    Platform stores all the global configuration that all machinesets use.
    See Also:
    Serialized Form

    • Method Detail

      • getArmEndpoint

        public String getArmEndpoint()
        ARMEndpoint is the endpoint for the Azure API when installing on Azure Stack.

      • setArmEndpoint

        public void setArmEndpoint​(String armEndpoint)
        ARMEndpoint is the endpoint for the Azure API when installing on Azure Stack.

      • getBaseDomainResourceGroupName

        public String getBaseDomainResourceGroupName()
        BaseDomainResourceGroupName specifies the resource group where the Azure DNS zone for the base domain is found. This field is optional when creating a private cluster, otherwise required.

      • setBaseDomainResourceGroupName

        public void setBaseDomainResourceGroupName​(String baseDomainResourceGroupName)
        BaseDomainResourceGroupName specifies the resource group where the Azure DNS zone for the base domain is found. This field is optional when creating a private cluster, otherwise required.

      • getCloudName

        public String getCloudName()
        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".

      • setCloudName

        public void setCloudName​(String cloudName)
        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".

      • getClusterOSImage

        public String getClusterOSImage()
        ClusterOSImage is the url of a storage blob in the Azure Stack environment containing an RHCOS VHD. This field is required for Azure Stack and not applicable to Azure.

      • setClusterOSImage

        public void setClusterOSImage​(String clusterOSImage)
        ClusterOSImage is the url of a storage blob in the Azure Stack environment containing an RHCOS VHD. This field is required for Azure Stack and not applicable to Azure.

      • getComputeSubnet

        public String getComputeSubnet()
        ComputeSubnet specifies an existing subnet for use by compute nodes

      • setComputeSubnet

        public void setComputeSubnet​(String computeSubnet)
        ComputeSubnet specifies an existing subnet for use by compute nodes

      • getControlPlaneSubnet

        public String getControlPlaneSubnet()
        ControlPlaneSubnet specifies an existing subnet for use by the control plane nodes

      • setControlPlaneSubnet

        public void setControlPlaneSubnet​(String controlPlaneSubnet)
        ControlPlaneSubnet specifies an existing subnet for use by the control plane nodes

      • getCustomerManagedKey

        public CustomerManagedKey getCustomerManagedKey()
        Platform stores all the global configuration that all machinesets use.

      • setCustomerManagedKey

        public void setCustomerManagedKey​(CustomerManagedKey customerManagedKey)
        Platform stores all the global configuration that all machinesets use.

      • getDefaultMachinePlatform

        public MachinePool getDefaultMachinePlatform()
        Platform stores all the global configuration that all machinesets use.

      • setDefaultMachinePlatform

        public void setDefaultMachinePlatform​(MachinePool defaultMachinePlatform)
        Platform stores all the global configuration that all machinesets use.

      • getNetworkResourceGroupName

        public String getNetworkResourceGroupName()
        NetworkResourceGroupName specifies the network resource group that contains an existing VNet

      • setNetworkResourceGroupName

        public void setNetworkResourceGroupName​(String networkResourceGroupName)
        NetworkResourceGroupName specifies the network resource group that contains an existing VNet

      • getOutboundType

        public String getOutboundType()
        OutboundType is a strategy for how egress from cluster is achieved. When not specified default is "Loadbalancer". "NatGateway" is only available in TechPreview.

      • setOutboundType

        public void setOutboundType​(String outboundType)
        OutboundType is a strategy for how egress from cluster is achieved. When not specified default is "Loadbalancer". "NatGateway" is only available in TechPreview.

      • getRegion

        public String getRegion()
        Region specifies the Azure region where the cluster will be created.

      • setRegion

        public void setRegion​(String region)
        Region specifies the Azure region where the cluster will be created.

      • getResourceGroupName

        public String getResourceGroupName()
        ResourceGroupName is the name of an already existing resource group where the cluster should be installed. This resource group should only be used for this specific cluster and the cluster components will assume ownership of all resources in the resource group. Destroying the cluster using installer will delete this resource group. This resource group must be empty with no other resources when trying to use it for creating a cluster. If empty, a new resource group will created for the cluster.

      • setResourceGroupName

        public void setResourceGroupName​(String resourceGroupName)
        ResourceGroupName is the name of an already existing resource group where the cluster should be installed. This resource group should only be used for this specific cluster and the cluster components will assume ownership of all resources in the resource group. Destroying the cluster using installer will delete this resource group. This resource group must be empty with no other resources when trying to use it for creating a cluster. If empty, a new resource group will created for the cluster.

      • getUserTags

        public Map<String,​String> getUserTags()
        UserTags has additional keys and values that the installer will add as tags to all resources that it creates on AzurePublicCloud alone. Resources created by the cluster itself may not include these tags.

      • setUserTags

        public void setUserTags​(Map<String,​String> userTags)
        UserTags has additional keys and values that the installer will add as tags to all resources that it creates on AzurePublicCloud alone. Resources created by the cluster itself may not include these tags.

      • getVirtualNetwork

        public String getVirtualNetwork()
        VirtualNetwork specifies the name of an existing VNet for the installer to use

      • setVirtualNetwork

        public void setVirtualNetwork​(String virtualNetwork)
        VirtualNetwork specifies the name of an existing VNet for the installer to use

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)