utils

Documentation

Index

• Constants
• func CopySecretToRemoteCluster(ctx context.Context, cl ctrlclient.Client, srcSecretName string, ...) error
• func EnsureCRSForClusterFromObjects(ctx context.Context, crsName string, c ctrlclient.Client, ...) error
• func EnsureClusterOwnerReferenceForObject(ctx context.Context, cl ctrlclient.Client, ...) error
• func EnsureNamespace(ctx context.Context, c ctrlclient.Client, ns *corev1.Namespace) error
• func EnsureNamespaceWithMetadata(ctx context.Context, c ctrlclient.Client, name string, ...) error
• func EnsureNamespaceWithName(ctx context.Context, c ctrlclient.Client, name string) error
• func EnsureSecretForLocalCluster(ctx context.Context, cl ctrlclient.Client, secret *corev1.Secret, ...) error
• func EnsureSecretOnRemoteCluster(ctx context.Context, cl ctrlclient.Client, secret *corev1.Secret, ...) error
• func GetDeploymentNamespace() string
• func RetrieveValuesTemplate(ctx context.Context, c ctrlclient.Client, configMapName, namespace string) (string, error)
• func RetrieveValuesTemplateConfigMap(ctx context.Context, c ctrlclient.Client, configMapName, namespace string) (*corev1.ConfigMap, error)
• func SecretForClusterRegistryAddonCA(ctx context.Context, c ctrlclient.Reader, cluster *clusterv1.Cluster) (*corev1.Secret, error)
• func SecretForImageRegistryCredentials(ctx context.Context, c ctrlclient.Reader, ...) (*corev1.Secret, error)
• func SecretForRegistryAddonRootCA(ctx context.Context, c ctrlclient.Reader) (*corev1.Secret, error)
• func SecretNameForImageRegistryCredentials(credentials *v1alpha1.RegistryCredentials) string
• func SecretNameForRegistryAddonCA(cluster *clusterv1.Cluster) string
• func SetTLSConfigForHelmChartProxyIfNeeded(hcp *caaphv1.HelmChartProxy)
• type EnsureCRSForClusterFromObjectsOptions
  • func DefaultEnsureCRSForClusterFromObjectsOptions() EnsureCRSForClusterFromObjectsOptions
  • func (o EnsureCRSForClusterFromObjectsOptions) WithOwnerCluster(cluster *clusterv1.Cluster) EnsureCRSForClusterFromObjectsOptions

Constants

const (
	RegistryAddonRootCASecretName = "registry-addon-root-ca"
)

Functions

func CopySecretToRemoteCluster

func CopySecretToRemoteCluster(
	ctx context.Context,
	cl ctrlclient.Client,
	srcSecretName string,
	dstSecretKey ctrlclient.ObjectKey,
	cluster *clusterv1.Cluster,
) error

CopySecretToRemoteCluster will get the Secret from srcSecretName and create it on the remote cluster, copying Data and StringData to dstSecretKey Secret.

func EnsureCRSForClusterFromObjects

func EnsureCRSForClusterFromObjects(
	ctx context.Context,
	crsName string,
	c ctrlclient.Client,
	cluster *clusterv1.Cluster,
	opts EnsureCRSForClusterFromObjectsOptions,
	objects ...runtime.Object,
) error

func EnsureClusterOwnerReferenceForObject

func EnsureClusterOwnerReferenceForObject(
	ctx context.Context,
	cl ctrlclient.Client,
	objectRef corev1.TypedLocalObjectReference,
	cluster *clusterv1.Cluster,
) error

EnsureClusterOwnerReferenceForObject ensures that OwnerReference of the cluster is added on provided object.

func EnsureNamespace

func EnsureNamespace(ctx context.Context, c ctrlclient.Client, ns *corev1.Namespace) error

EnsureNamespace will create the namespace if it does not exist.

func EnsureNamespaceWithMetadata

func EnsureNamespaceWithMetadata(ctx context.Context,
	c ctrlclient.Client,
	name string,
	labels, annotations map[string]string,
) error

EnsureNamespaceWithMetadata will create the namespace with the specified name, labels, and/or annotations, if it does not exist.

func EnsureNamespaceWithName

func EnsureNamespaceWithName(ctx context.Context, c ctrlclient.Client, name string) error

EnsureNamespaceWithName will create the namespace with the specified name if it does not exist.

func EnsureSecretForLocalCluster

func EnsureSecretForLocalCluster(
	ctx context.Context,
	cl ctrlclient.Client,
	secret *corev1.Secret,
	cluster *clusterv1.Cluster,
) error

func EnsureSecretOnRemoteCluster

func EnsureSecretOnRemoteCluster(
	ctx context.Context,
	cl ctrlclient.Client,
	secret *corev1.Secret,
	cluster *clusterv1.Cluster,
) error

EnsureSecretOnRemoteCluster ensures that the given Secret exists on the remote cluster.

func GetDeploymentNamespace

func GetDeploymentNamespace() string

func RetrieveValuesTemplate

func RetrieveValuesTemplate(
	ctx context.Context,
	c ctrlclient.Client,
	configMapName,
	namespace string,
) (string, error)

func RetrieveValuesTemplateConfigMap

func RetrieveValuesTemplateConfigMap(
	ctx context.Context,
	c ctrlclient.Client,
	configMapName,
	namespace string,
) (*corev1.ConfigMap, error)

func SecretForClusterRegistryAddonCA

func SecretForClusterRegistryAddonCA(
	ctx context.Context,
	c ctrlclient.Reader,
	cluster *clusterv1.Cluster,
) (*corev1.Secret, error)

func SecretForImageRegistryCredentials

func SecretForImageRegistryCredentials(
	ctx context.Context,
	c ctrlclient.Reader,
	credentials *v1alpha1.RegistryCredentials,
	objectNamespace string,
) (*corev1.Secret, error)

SecretForImageRegistryCredentials returns the Secret for the given ImageRegistryCredentials. Returns nil if the secret field is empty.

func SecretForRegistryAddonRootCA

func SecretForRegistryAddonRootCA(
	ctx context.Context,
	c ctrlclient.Reader,
) (*corev1.Secret, error)

func SecretNameForImageRegistryCredentials

func SecretNameForImageRegistryCredentials(credentials *v1alpha1.RegistryCredentials) string

SecretNameForImageRegistryCredentials returns the name of the Secret for the given RegistryCredentials. Returns an empty string if the credentials or secret field is empty.

func SecretNameForRegistryAddonCA

func SecretNameForRegistryAddonCA(cluster *clusterv1.Cluster) string

SecretNameForRegistryAddonCA returns the name of the registry addon CA Secret.

func SetTLSConfigForHelmChartProxyIfNeeded

func SetTLSConfigForHelmChartProxyIfNeeded(hcp *caaphv1.HelmChartProxy)

Types

type EnsureCRSForClusterFromObjectsOptions

type EnsureCRSForClusterFromObjectsOptions struct {
	// OwnerCluster holds the owning cluster for the ClusterResourceSet.
	// This allows setting the owner to something other than the workload cluster, which is
	// needed specifically for the ClusterAutoscaler addon which can be deployed in a different
	// namespace to the target cluster as it must exist in the management cluster.
	OwnerCluster *clusterv1.Cluster
}

func DefaultEnsureCRSForClusterFromObjectsOptions

func DefaultEnsureCRSForClusterFromObjectsOptions() EnsureCRSForClusterFromObjectsOptions

func (EnsureCRSForClusterFromObjectsOptions) WithOwnerCluster

func (o EnsureCRSForClusterFromObjectsOptions) WithOwnerCluster(
	cluster *clusterv1.Cluster,
) EnsureCRSForClusterFromObjectsOptions