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

Class HiveConfigSpec

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<HiveConfigSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class HiveConfigSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<HiveConfigSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    HiveConfigSpec defines the desired state of Hive
    See Also:
    Serialized Form

    • Method Detail

      • getAdditionalCertificateAuthoritiesSecretRef

        public List<io.fabric8.kubernetes.api.model.LocalObjectReference> getAdditionalCertificateAuthoritiesSecretRef()
        AdditionalCertificateAuthoritiesSecretRef is a list of references to secrets in the TargetNamespace that contain an additional Certificate Authority to use when communicating with target clusters. These certificate authorities will be used in addition to any self-signed CA generated by each cluster on installation. The cert data should be stored in the Secret key named 'ca.crt'.

      • setAdditionalCertificateAuthoritiesSecretRef

        public void setAdditionalCertificateAuthoritiesSecretRef​(List<io.fabric8.kubernetes.api.model.LocalObjectReference> additionalCertificateAuthoritiesSecretRef)
        AdditionalCertificateAuthoritiesSecretRef is a list of references to secrets in the TargetNamespace that contain an additional Certificate Authority to use when communicating with target clusters. These certificate authorities will be used in addition to any self-signed CA generated by each cluster on installation. The cert data should be stored in the Secret key named 'ca.crt'.

      • getArgoCDConfig

        public ArgoCDConfig getArgoCDConfig()
        HiveConfigSpec defines the desired state of Hive

      • setArgoCDConfig

        public void setArgoCDConfig​(ArgoCDConfig argoCDConfig)
        HiveConfigSpec defines the desired state of Hive

      • getAwsPrivateLink

        public AWSPrivateLinkConfig getAwsPrivateLink()
        HiveConfigSpec defines the desired state of Hive

      • setAwsPrivateLink

        public void setAwsPrivateLink​(AWSPrivateLinkConfig awsPrivateLink)
        HiveConfigSpec defines the desired state of Hive

      • getBackup

        public BackupConfig getBackup()
        HiveConfigSpec defines the desired state of Hive

      • setBackup

        public void setBackup​(BackupConfig backup)
        HiveConfigSpec defines the desired state of Hive

      • getClusterVersionPollInterval

        public String getClusterVersionPollInterval()
        ClusterVersionPollInterval is a string duration indicating how much time must pass before checking whether we need to update the hive.openshift.io/version* labels on ClusterDeployment. If zero or unset, we'll only reconcile when the ClusterDeployment changes.

      • setClusterVersionPollInterval

        public void setClusterVersionPollInterval​(String clusterVersionPollInterval)
        ClusterVersionPollInterval is a string duration indicating how much time must pass before checking whether we need to update the hive.openshift.io/version* labels on ClusterDeployment. If zero or unset, we'll only reconcile when the ClusterDeployment changes.

      • getControllersConfig

        public ControllersConfig getControllersConfig()
        HiveConfigSpec defines the desired state of Hive

      • setControllersConfig

        public void setControllersConfig​(ControllersConfig controllersConfig)
        HiveConfigSpec defines the desired state of Hive

      • getDeleteProtection

        public String getDeleteProtection()
        DeleteProtection can be set to "enabled" to turn on automatic delete protection for ClusterDeployments. When enabled, Hive will add the "hive.openshift.io/protected-delete" annotation to new ClusterDeployments. Once a ClusterDeployment has been installed, a user must remove the annotation from a ClusterDeployment prior to deleting it.

      • setDeleteProtection

        public void setDeleteProtection​(String deleteProtection)
        DeleteProtection can be set to "enabled" to turn on automatic delete protection for ClusterDeployments. When enabled, Hive will add the "hive.openshift.io/protected-delete" annotation to new ClusterDeployments. Once a ClusterDeployment has been installed, a user must remove the annotation from a ClusterDeployment prior to deleting it.

      • getDeploymentConfig

        public List<DeploymentConfig> getDeploymentConfig()
        DeploymentConfig is used to configure (pods/containers of) the Deployments generated by hive-operator.

      • setDeploymentConfig

        public void setDeploymentConfig​(List<DeploymentConfig> deploymentConfig)
        DeploymentConfig is used to configure (pods/containers of) the Deployments generated by hive-operator.

      • getDeprovisionsDisabled

        public Boolean getDeprovisionsDisabled()
        DeprovisionsDisabled can be set to true to block deprovision jobs from running.

      • setDeprovisionsDisabled

        public void setDeprovisionsDisabled​(Boolean deprovisionsDisabled)
        DeprovisionsDisabled can be set to true to block deprovision jobs from running.

      • getDisabledControllers

        public List<String> getDisabledControllers()
        DisabledControllers allows selectively disabling Hive controllers by name. The name of an individual controller matches the name of the controller as seen in the Hive logging output.

      • setDisabledControllers

        public void setDisabledControllers​(List<String> disabledControllers)
        DisabledControllers allows selectively disabling Hive controllers by name. The name of an individual controller matches the name of the controller as seen in the Hive logging output.

      • getExportMetrics

        public Boolean getExportMetrics()
        ExportMetrics has been disabled and has no effect. If upgrading from a version where it was active, please be aware of the following in your HiveConfig.Spec.TargetNamespace (default `hive` if unset): 1) ServiceMonitors named hive-controllers and hive-clustersync; 2) Role and RoleBinding named prometheus-k8s; 3) The `openshift.io/cluster-monitoring` metadata.label on the Namespace itself. You may wish to delete these resources. Or you may wish to continue using them to enable monitoring in your environment; but be aware that hive will no longer reconcile them.

      • setExportMetrics

        public void setExportMetrics​(Boolean exportMetrics)
        ExportMetrics has been disabled and has no effect. If upgrading from a version where it was active, please be aware of the following in your HiveConfig.Spec.TargetNamespace (default `hive` if unset): 1) ServiceMonitors named hive-controllers and hive-clustersync; 2) Role and RoleBinding named prometheus-k8s; 3) The `openshift.io/cluster-monitoring` metadata.label on the Namespace itself. You may wish to delete these resources. Or you may wish to continue using them to enable monitoring in your environment; but be aware that hive will no longer reconcile them.

      • getFailedProvisionConfig

        public FailedProvisionConfig getFailedProvisionConfig()
        HiveConfigSpec defines the desired state of Hive

      • setFailedProvisionConfig

        public void setFailedProvisionConfig​(FailedProvisionConfig failedProvisionConfig)
        HiveConfigSpec defines the desired state of Hive

      • getFeatureGates

        public FeatureGateSelection getFeatureGates()
        HiveConfigSpec defines the desired state of Hive

      • setFeatureGates

        public void setFeatureGates​(FeatureGateSelection featureGates)
        HiveConfigSpec defines the desired state of Hive

      • getGlobalPullSecretRef

        public io.fabric8.kubernetes.api.model.LocalObjectReference getGlobalPullSecretRef()
        HiveConfigSpec defines the desired state of Hive

      • setGlobalPullSecretRef

        public void setGlobalPullSecretRef​(io.fabric8.kubernetes.api.model.LocalObjectReference globalPullSecretRef)
        HiveConfigSpec defines the desired state of Hive

      • getLogLevel

        public String getLogLevel()
        LogLevel is the level of logging to use for the Hive controllers. Acceptable levels, from coarsest to finest, are panic, fatal, error, warn, info, debug, and trace. The default level is info.

      • setLogLevel

        public void setLogLevel​(String logLevel)
        LogLevel is the level of logging to use for the Hive controllers. Acceptable levels, from coarsest to finest, are panic, fatal, error, warn, info, debug, and trace. The default level is info.

      • getMachinePoolPollInterval

        public String getMachinePoolPollInterval()
        MachinePoolPollInterval is a string duration indicating how much time must pass before checking whether remote resources related to MachinePools need to be reapplied. Set to zero to disable polling -- we'll only reconcile when hub objects change. The default interval is 30m.

      • setMachinePoolPollInterval

        public void setMachinePoolPollInterval​(String machinePoolPollInterval)
        MachinePoolPollInterval is a string duration indicating how much time must pass before checking whether remote resources related to MachinePools need to be reapplied. Set to zero to disable polling -- we'll only reconcile when hub objects change. The default interval is 30m.

      • getMaintenanceMode

        public Boolean getMaintenanceMode()
        MaintenanceMode can be set to true to disable the hive controllers in situations where we need to ensure nothing is running that will add or act upon finalizers on Hive types. This should rarely be needed. Sets replicas to 0 for the hive-controllers deployment to accomplish this.

      • setMaintenanceMode

        public void setMaintenanceMode​(Boolean maintenanceMode)
        MaintenanceMode can be set to true to disable the hive controllers in situations where we need to ensure nothing is running that will add or act upon finalizers on Hive types. This should rarely be needed. Sets replicas to 0 for the hive-controllers deployment to accomplish this.

      • getManagedDomains

        public List<ManageDNSConfig> getManagedDomains()
        ManagedDomains is the list of DNS domains that are managed by the Hive cluster When specifying 'manageDNS: true' in a ClusterDeployment, the ClusterDeployment's baseDomain should be a direct child of one of these domains, otherwise the ClusterDeployment creation will result in a validation error.

      • setManagedDomains

        public void setManagedDomains​(List<ManageDNSConfig> managedDomains)
        ManagedDomains is the list of DNS domains that are managed by the Hive cluster When specifying 'manageDNS: true' in a ClusterDeployment, the ClusterDeployment's baseDomain should be a direct child of one of these domains, otherwise the ClusterDeployment creation will result in a validation error.

      • getMetricsConfig

        public MetricsConfig getMetricsConfig()
        HiveConfigSpec defines the desired state of Hive

      • setMetricsConfig

        public void setMetricsConfig​(MetricsConfig metricsConfig)
        HiveConfigSpec defines the desired state of Hive

      • getPrivateLink

        public PrivateLinkConfig getPrivateLink()
        HiveConfigSpec defines the desired state of Hive

      • setPrivateLink

        public void setPrivateLink​(PrivateLinkConfig privateLink)
        HiveConfigSpec defines the desired state of Hive

      • setReleaseImageVerificationConfigMapRef

        public void setReleaseImageVerificationConfigMapRef​(ReleaseImageVerificationConfigMapReference releaseImageVerificationConfigMapRef)
        HiveConfigSpec defines the desired state of Hive

      • getServiceProviderCredentialsConfig

        public ServiceProviderCredentials getServiceProviderCredentialsConfig()
        HiveConfigSpec defines the desired state of Hive

      • setServiceProviderCredentialsConfig

        public void setServiceProviderCredentialsConfig​(ServiceProviderCredentials serviceProviderCredentialsConfig)
        HiveConfigSpec defines the desired state of Hive

      • getSyncSetReapplyInterval

        public String getSyncSetReapplyInterval()
        SyncSetReapplyInterval is a string duration indicating how much time must pass before SyncSet resources will be reapplied. The default reapply interval is two hours.

      • setSyncSetReapplyInterval

        public void setSyncSetReapplyInterval​(String syncSetReapplyInterval)
        SyncSetReapplyInterval is a string duration indicating how much time must pass before SyncSet resources will be reapplied. The default reapply interval is two hours.

      • getTargetNamespace

        public String getTargetNamespace()
        TargetNamespace is the namespace where the core Hive components should be run. Defaults to "hive". Will be created if it does not already exist. All resource references in HiveConfig can be assumed to be in the TargetNamespace. NOTE: Whereas it is possible to edit this value, causing hive to "move" its core components to the new namespace, the old namespace is not deleted, as it will still contain resources created by kubernetes and/or other OpenShift controllers.

      • setTargetNamespace

        public void setTargetNamespace​(String targetNamespace)
        TargetNamespace is the namespace where the core Hive components should be run. Defaults to "hive". Will be created if it does not already exist. All resource references in HiveConfig can be assumed to be in the TargetNamespace. NOTE: Whereas it is possible to edit this value, causing hive to "move" its core components to the new namespace, the old namespace is not deleted, as it will still contain resources created by kubernetes and/or other OpenShift controllers.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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