package
1.1.16
Repository: https://github.com/openshift/hive.git
Documentation: pkg.go.dev

# Functions

GetMergedPullSecretName returns name for merged pull secret name per cluster deployment.

# Constants

ArgoCDEnvVar is the name of the environment variable used to tell the controller manager to enable ArgoCD integration.
ArgoCDNamespaceEnvVar is the name of the environment variable used to specify the ArgoCD namespace.
AWSAccessKeyIDSecretKey is the key we use in a Kubernetes Secret containing AWS credentials for the access key ID.
AWSChinaRegionPrefix is the prefix for regions in AWS China.
AWSChinaRoute53Region is the region to use for AWS China route53 operations.
AWSConfigSecretKey is the key we use in a Kubernetes Secret containing AWS config.
AWSCredsMount is the location where the AWS credentials secret is mounted for uninstall pods.
AWSPrivateLinkControllerConfigFileEnvVar if present, points to a simple text file that includes configuration for aws-private-link-controller.
AWSRoute53Region is the region to use for route53 operations.
AWSSecretAccessKeySecretKey is the key we use in a Kubernetes Secret containing AWS credentials for the access key ID.
AzureCredentialsEnvVar is the name of the environment variable pointing to the location where Azure credentials can be found.
AzureCredentialsName is the name of the Azure credentials file or secret key.
BoundServiceAccountSigningKeyEnvVar contains the path to the bound service account signing key and is set in the install pod for AWS STS clusters.
BoundServiceAccountSigningKeyFile is the Secret key and filename where a ServiceAccount signing key will be projected into the install pod.
CheckpointName is the name of the object in each namespace in which the namespace's backup information is stored.
ClusterClaimRemoveClusterAnnotation is used by the cluster claim controller to mark that the cluster that are previously claimed is no longer required and therefore should be removed/deprovisioned and removed from the pool.
ClusterDeploymentNameLabel is the label that is used to identify a relationship to a given cluster deployment object.
ClusterDeploymentPoolSpecHashAnnotation annotates a ClusterDeployment.
ClusterDeprovisionNameLabel is the label that is used to identify a relationship to a given cluster deprovision object.
ClusterIngressSuffix is the suffix used when naming objects having to do with cluster ingress.
ClusterPoolNameLabel is the label that is used to signal that a namespace was created to house a ClusterDeployment created for a ClusterPool.
ClusterProvisionNameLabel is the label that is used to identify a relationship to a given cluster provision object.
ControlPlaneCertificateSuffix is the suffix used when naming objects having to do control plane certificates.
CreatedByHiveLabel is the label used for artifacts for external systems we integrate with that were created by Hive.
DefaultHiveNamespace is the default namespace where core hive components will run.
DeprovisionsDisabledEnvVar is the name of the environment variable used to tell the controller manager to skip processing of any ClusterDeprovisions.
DisableInstallLogPasswordRedactionAnnotation is an annotation used on ClusterDeployments to disable the installmanager functionality which refuses to print output if it appears to contain a password or sensitive info.
DNSZoneTypeChild is used as a value of DNSZoneTypeLabel that says the DNSZone is specifically used as the forwarding zone for the target cluster.
DNSZoneTypeLabel is the label that is used to identify what a DNSZone is being used for.
FakeClusterInstallEnvVar is the environment variable Hive will set for the installmanager pod to request a fake install.
GCPCredentialsName is the name of the GCP credentials file or secret key.
GlobalPullSecret is the environment variable for controllers to get the global pull secret.
HiveAWSServiceProviderCredentialsSecretRefEnvVar is the environment variable specifying what secret to use for assuming the service provider credentials for AWS clusters.
HiveConfigName is the one and only name for a HiveConfig supported in the cluster.
HiveFakeClusterAnnotation can be set to true on a cluster deployment to create a fake cluster that never provisions resources, and all communication with the cluster will be faked.
HiveFeatureGatesEnabledEnvVar is the the environment variable specifying the comma separated list of feature gates that are enabled.
HiveManagedLabel is a label added to any resources we sync to the remote cluster to help identify that they are managed by Hive, and any manual changes may be undone the next time the resource is reconciled.
HiveNamespaceEnvVar is the environment variable for the namespace where the core hive-controllers and hiveadmission will run.
No description provided by the author
HiveReleaseImageVerificationConfigMapNamespaceEnvVar is used to configure the config map that will be used to verify the release images being used for cluster deployments.
IdentityProviderSuffix is the suffix used when naming objects having to do with identity provider.
InstallJobLabel is the label used for artifacts specific to Hive cluster installations.
InstallLogsAWSRegionEnvVar is the environment variable specifying the region to use with S3.
InstallLogsAWSS3BucketEnvVar is the environment variable specifying the S3 bucket to use.
InstallLogsAWSServiceEndpointEnvVar is the environment variable specifying the S3 endpoint to use.
InstallLogsCredentialsSecretRefEnvVar is the environment variable specifying what secret to use for storing logs.
InstallLogsUploadProviderAWS is used to specify that AWS is the cloud provider to upload logs to.
InstallLogsUploadProviderEnvVar is used to specify which object store provider is being used.
JobTypeDeprovision is used as a value of JobTypeLabel that says the Job is specifically running the deprovisioner.
JobTypeImageSet is used as a value of JobTypeLabel that says the Job is specifically running to determine which imageset to use.
JobTypeLabel is the label that is used to identify what a Job is being used for.
JobTypeProvision is used as a value of JobTypeLabel that says the Job is specifically running the provisioner.
KubeconfigSecretKey is the key used inside of a secret containing a kubeconfig.
LibvirtSSHPrivKeyPathEnvVar is the environment variable Hive will set for the installmanager pod to point to the path where we mount in the SSH key for connecting to the bare metal libvirt provisioning host.
MachineManagementAnnotation.
MachinePoolNameLabel is the label that is used to identify the MachinePool which owns a particular resource.
ManagedDomainsFileEnvVar if present, points to a simple text file that includes a valid managed domain per line.
ManagedDomainsVolumeName is the name of the volume that will point to the configmap containing the managed domain configuration.
MinBackupPeriodSecondsEnvVar is the name of the environment variable used to tell the controller manager the minimum period of time between backups.
OpenStackCredentialsName is the name of the OpenStack credentials file.
OvirtConfigEnvVar is the environment variable specifying the oVirt config path.
OvirtCredentialsName is the name of the oVirt credentials file.
PasswordSecretKey is a key used to store a password inside of a secret containing username / password credentials.
PauseOnInstallFailureAnnotation is an annotation used on ClusterDeployments to trigger a sleep after an install failure for the specified duration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ProtectedDeleteAnnotation is an annotation used on ClusterDeployments to indicate that the ClusterDeployment cannot be deleted.
ProtectedDeleteEnvVar is the name of the environment variable used to tell the controller manager whether protected delete is enabled.
PVCTypeInstallLogs is used as a value of PVCTypeLabel that says the PVC specifically stores installer logs.
PVCTypeLabel is the label that is used to identify what a PVC is being used for.
RawKubeconfigSecretKey is the key we use in a Kubernetes Secret containing the raw (unmodified) form of an admin kubeconfig.
ReconcileIDLen is the length of the random strings we generate for contextual loggers in controller Reconcile functions.
RelocateAnnotation is an annotation used on ClusterDeployments and DNSZones to indicate that the resource is involved in a relocation between Hive instances.
SecretTypeKubeAdminCreds is used as a value of SecretTypeLabel that says the secret is specifically used for storing kubeadmin credentials.
SecretTypeKubeConfig is used as a value of SecretTypeLabel that says the secret is specifically used for storing a kubeconfig.
SecretTypeLabel is the label that is used to identify what a Secret is being used for.
SecretTypeMergedPullSecret is used as a value of SecretTypeLabel that says the secret is specifically used for storing a pull secret.
SelectorSyncSetNameLabel is the label that is used to identify a relationship to a given selector syncset object.
SSHPrivateKeySecretKey is the key we use in a Kubernetes Secret containing an SSH private key.
SSHPrivKeyPathEnvVar is the environment variable Hive will set for the installmanager pod to point to the path where we mount in the SSH key to be configured on the cluster hosts.
SupportedContractImplementationsFileEnvVar if present, points to a simple json file that includes a list of contracts and their supported implementations.
SyncSetMetricsGroupAnnotation can be applied to non-selector SyncSets to make them part of a group for which first applied metrics can be reported.
SyncSetNameLabel is the label that is used to identify a relationship to a given syncset object.
SyncsetPauseAnnotation is a annotation used by clusterDeployment, if it's true, then we will disable syncing to a specific cluster.
SyncSetTypeControlPlaneCerts is used as a value of SyncSetTypeLabel that says the syncset is specifically used to distribute control plane certificates.
SyncSetTypeIdentityProvider is used as a value of SyncSetTypeLabel that says the syncset is specifically used to distribute identity provider information.
SyncSetTypeLabel is the label that is used to identify what a SyncSet is being used for.
SyncSetTypeRemoteIngress is used as a value of SyncSetTypeLabel that says the syncset is specifically used to distribute remote ingress information.
TLSCrtSecretKey is the key we use in a Kubernetes Secret containing a TLS certificate.
TLSKeySecretKey is the key we use in a Kubernetes Secret containing a TLS certificate key.
UninstallJobLabel is the label used for artifacts specific to Hive cluster deprovision.
UsernameSecretKey is a key used to store a username inside of a secret containing username / password credentials.
VeleroBackupEnvVar is the name of the environment variable used to tell the controller manager to enable velero backup integration.
VeleroNamespaceEnvVar is the name of the environment variable used to tell the controller manager which namespace velero backup objects should be created in.
VersionMajorLabel is a label applied to ClusterDeployments to show the version of the cluster in the form "[MAJOR]".
VersionMajorMinorLabel is a label applied to ClusterDeployments to show the version of the cluster in the form "[MAJOR].[MINOR]".
VersionMajorMinorPatchLabel is a label applied to ClusterDeployments to show the version of the cluster in the form "[MAJOR].[MINOR].[PATCH]".
VSphereDataCenterEnvVar is the environment variable specifying the vSphere datacenter.
VSphereDataStoreEnvVar is the environment variable specifying the vSphere default datastore.
VSphereNetworkEnvVar is the environment variable specifying the vSphere network.
VSpherePasswordEnvVar is the environment variable specifying the vSphere password.
VSphereTLSCACertsEnvVar is the environment variable containing : delimited paths to vSphere CA certificates.
VSphereUsernameEnvVar is the environent variable specifying the vSphere username.
VSphereVCenterEnvVar is the environment variable specifying the vSphere vCenter host.
WaitForInstallCompleteExecutionsAnnotation is an annotation used on ClusterDeployments to set additional waits for the cluster provision to complete by running `openshift-install wait-for install-complete` command.