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

Class InstallConfig

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<InstallConfigBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.KubernetesResource, io.fabric8.kubernetes.api.model.Namespaced, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class InstallConfig
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<InstallConfigBuilder>, io.fabric8.kubernetes.api.model.HasMetadata, io.fabric8.kubernetes.api.model.Namespaced
    InstallConfig is the configuration for an OpenShift install.
    See Also:
    Serialized Form

    • Method Detail

      • getAdditionalTrustBundle

        public String getAdditionalTrustBundle()
        AdditionalTrustBundle is a PEM-encoded X.509 certificate bundle that will be added to the nodes' trusted certificate store.

      • setAdditionalTrustBundle

        public void setAdditionalTrustBundle​(String additionalTrustBundle)
        AdditionalTrustBundle is a PEM-encoded X.509 certificate bundle that will be added to the nodes' trusted certificate store.

      • getAdditionalTrustBundlePolicy

        public String getAdditionalTrustBundlePolicy()
        AdditionalTrustBundlePolicy determines when to add the AdditionalTrustBundle to the nodes' trusted certificate store. "Proxyonly" is the default. The field can be set to following specified values. "Proxyonly" : adds the AdditionalTrustBundle to nodes when http/https proxy is configured. "Always" : always adds AdditionalTrustBundle.

      • setAdditionalTrustBundlePolicy

        public void setAdditionalTrustBundlePolicy​(String additionalTrustBundlePolicy)
        AdditionalTrustBundlePolicy determines when to add the AdditionalTrustBundle to the nodes' trusted certificate store. "Proxyonly" is the default. The field can be set to following specified values. "Proxyonly" : adds the AdditionalTrustBundle to nodes when http/https proxy is configured. "Always" : always adds AdditionalTrustBundle.

      • getApiVersion

        public String getApiVersion()
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        getApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setApiVersion

        public void setApiVersion​(String apiVersion)
        APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
        Specified by:
        setApiVersion in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getArbiter

        public MachinePool getArbiter()
        InstallConfig is the configuration for an OpenShift install.

      • setArbiter

        public void setArbiter​(MachinePool arbiter)
        InstallConfig is the configuration for an OpenShift install.

      • getBaseDomain

        public String getBaseDomain()
        BaseDomain is the base domain to which the cluster should belong.

      • setBaseDomain

        public void setBaseDomain​(String baseDomain)
        BaseDomain is the base domain to which the cluster should belong.

      • getBootstrapInPlace

        public BootstrapInPlace getBootstrapInPlace()
        InstallConfig is the configuration for an OpenShift install.

      • setBootstrapInPlace

        public void setBootstrapInPlace​(BootstrapInPlace bootstrapInPlace)
        InstallConfig is the configuration for an OpenShift install.

      • getCapabilities

        public Capabilities getCapabilities()
        InstallConfig is the configuration for an OpenShift install.

      • setCapabilities

        public void setCapabilities​(Capabilities capabilities)
        InstallConfig is the configuration for an OpenShift install.

      • getCompute

        public List<MachinePool> getCompute()
        Compute is the configuration for the machines that comprise the compute nodes.

      • setCompute

        public void setCompute​(List<MachinePool> compute)
        Compute is the configuration for the machines that comprise the compute nodes.

      • getControlPlane

        public MachinePool getControlPlane()
        InstallConfig is the configuration for an OpenShift install.

      • setControlPlane

        public void setControlPlane​(MachinePool controlPlane)
        InstallConfig is the configuration for an OpenShift install.

      • getCpuPartitioningMode

        public String getCpuPartitioningMode()
        CPUPartitioning determines if a cluster should be setup for CPU workload partitioning at install time. When this field is set the cluster will be flagged for CPU Partitioning allowing users to segregate workloads to specific CPU Sets. This does not make any decisions on workloads it only configures the nodes to allow CPU Partitioning. The "AllNodes" value will setup all nodes for CPU Partitioning, the default is "None".

      • setCpuPartitioningMode

        public void setCpuPartitioningMode​(String cpuPartitioningMode)
        CPUPartitioning determines if a cluster should be setup for CPU workload partitioning at install time. When this field is set the cluster will be flagged for CPU Partitioning allowing users to segregate workloads to specific CPU Sets. This does not make any decisions on workloads it only configures the nodes to allow CPU Partitioning. The "AllNodes" value will setup all nodes for CPU Partitioning, the default is "None".

      • getCredentialsMode

        public String getCredentialsMode()
        CredentialsMode is used to explicitly set the mode with which CredentialRequests are satisfied.


        If this field is set, then the installer will not attempt to query the cloud permissions before attempting installation. If the field is not set or empty, then the installer will perform its normal verification that the credentials provided are sufficient to perform an installation.


        There are three possible values for this field, but the valid values are dependent upon the platform being used. "Mint": create new credentials with a subset of the overall permissions for each CredentialsRequest "Passthrough": copy the credentials with all of the overall permissions for each CredentialsRequest "Manual": CredentialsRequests must be handled manually by the user


        For each of the following platforms, the field can set to the specified values. For all other platforms, the field must not be set. AWS: "Mint", "Passthrough", "Manual" Azure: "Passthrough", "Manual" AzureStack: "Manual" GCP: "Mint", "Passthrough", "Manual" IBMCloud: "Manual" PowerVS: "Manual" Nutanix: "Manual"

      • setCredentialsMode

        public void setCredentialsMode​(String credentialsMode)
        CredentialsMode is used to explicitly set the mode with which CredentialRequests are satisfied.


        If this field is set, then the installer will not attempt to query the cloud permissions before attempting installation. If the field is not set or empty, then the installer will perform its normal verification that the credentials provided are sufficient to perform an installation.


        There are three possible values for this field, but the valid values are dependent upon the platform being used. "Mint": create new credentials with a subset of the overall permissions for each CredentialsRequest "Passthrough": copy the credentials with all of the overall permissions for each CredentialsRequest "Manual": CredentialsRequests must be handled manually by the user


        For each of the following platforms, the field can set to the specified values. For all other platforms, the field must not be set. AWS: "Mint", "Passthrough", "Manual" Azure: "Passthrough", "Manual" AzureStack: "Manual" GCP: "Mint", "Passthrough", "Manual" IBMCloud: "Manual" PowerVS: "Manual" Nutanix: "Manual"

      • getFeatureGates

        public List<String> getFeatureGates()
        FeatureGates enables a set of custom feature gates. May only be used in conjunction with FeatureSet "CustomNoUpgrade". Features may be enabled or disabled by providing a true or false value for the feature gate. E.g. "featureGates": ["FeatureGate1=true", "FeatureGate2=false"].

      • setFeatureGates

        public void setFeatureGates​(List<String> featureGates)
        FeatureGates enables a set of custom feature gates. May only be used in conjunction with FeatureSet "CustomNoUpgrade". Features may be enabled or disabled by providing a true or false value for the feature gate. E.g. "featureGates": ["FeatureGate1=true", "FeatureGate2=false"].

      • getFeatureSet

        public String getFeatureSet()
        FeatureSet enables features that are not part of the default feature set. Valid values are "Default", "TechPreviewNoUpgrade" and "CustomNoUpgrade". When omitted, the "Default" feature set is used.

      • setFeatureSet

        public void setFeatureSet​(String featureSet)
        FeatureSet enables features that are not part of the default feature set. Valid values are "Default", "TechPreviewNoUpgrade" and "CustomNoUpgrade". When omitted, the "Default" feature set is used.

      • getFips

        public Boolean getFips()
        FIPS configures https://www.nist.gov/itl/fips-general-information

      • setFips

        public void setFips​(Boolean fips)
        FIPS configures https://www.nist.gov/itl/fips-general-information

      • getImageContentSources

        public List<ImageContentSource> getImageContentSources()
        ImageContentSources lists sources/repositories for the release-image content. The field is deprecated. Please use imageDigestSources.

      • setImageContentSources

        public void setImageContentSources​(List<ImageContentSource> imageContentSources)
        ImageContentSources lists sources/repositories for the release-image content. The field is deprecated. Please use imageDigestSources.

      • getImageDigestSources

        public List<ImageDigestSource> getImageDigestSources()
        ImageDigestSources lists sources/repositories for the release-image content.

      • setImageDigestSources

        public void setImageDigestSources​(List<ImageDigestSource> imageDigestSources)
        ImageDigestSources lists sources/repositories for the release-image content.

      • getKind

        public String getKind()
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
        Specified by:
        getKind in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setKind

        public void setKind​(String kind)
        Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

      • getMetadata

        public io.fabric8.kubernetes.api.model.ObjectMeta getMetadata()
        InstallConfig is the configuration for an OpenShift install.
        Specified by:
        getMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • setMetadata

        public void setMetadata​(io.fabric8.kubernetes.api.model.ObjectMeta metadata)
        InstallConfig is the configuration for an OpenShift install.
        Specified by:
        setMetadata in interface io.fabric8.kubernetes.api.model.HasMetadata

      • getNetworking

        public Networking getNetworking()
        InstallConfig is the configuration for an OpenShift install.

      • setNetworking

        public void setNetworking​(Networking networking)
        InstallConfig is the configuration for an OpenShift install.

      • getOperatorPublishingStrategy

        public OperatorPublishingStrategy getOperatorPublishingStrategy()
        InstallConfig is the configuration for an OpenShift install.

      • setOperatorPublishingStrategy

        public void setOperatorPublishingStrategy​(OperatorPublishingStrategy operatorPublishingStrategy)
        InstallConfig is the configuration for an OpenShift install.

      • getPlatform

        public Platform getPlatform()
        InstallConfig is the configuration for an OpenShift install.

      • setPlatform

        public void setPlatform​(Platform platform)
        InstallConfig is the configuration for an OpenShift install.

      • getProxy

        public Proxy getProxy()
        InstallConfig is the configuration for an OpenShift install.

      • setProxy

        public void setProxy​(Proxy proxy)
        InstallConfig is the configuration for an OpenShift install.

      • getPublish

        public String getPublish()
        Publish controls how the user facing endpoints of the cluster like the Kubernetes API, OpenShift routes etc. are exposed. When no strategy is specified, the strategy is "External".

      • setPublish

        public void setPublish​(String publish)
        Publish controls how the user facing endpoints of the cluster like the Kubernetes API, OpenShift routes etc. are exposed. When no strategy is specified, the strategy is "External".

      • getPullSecret

        public String getPullSecret()
        PullSecret is the secret to use when pulling images.

      • setPullSecret

        public void setPullSecret​(String pullSecret)
        PullSecret is the secret to use when pulling images.

      • getSshKey

        public String getSshKey()
        SSHKey is the public Secure Shell (SSH) key to provide access to instances.

      • setSshKey

        public void setSshKey​(String sshKey)
        SSHKey is the public Secure Shell (SSH) key to provide access to instances.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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