client

package
v0.67.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2026 License: Apache-2.0 Imports: 34 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ManifestWorkLabels

func ManifestWorkLabels(options ...ManifestWorkListOption) map[string]string

ManifestWorkLabels returns the label filters configured by options.

func NewManagementClusterClient

func NewManagementClusterClient(kubeClient client.Client, restCfg *rest.Config, clientset kubernetes.Interface, opts ...ManagementClusterClientOption) *managementClusterClient

NewManagementClusterClient creates a management-cluster client with optional configuration.

Types

type AWSAccountClientProvider

type AWSAccountClientProvider interface {
	AccountClient(profile, region, accountID string) (awsprovider.Client, error)
}

AWSAccountClientProvider creates AWS clients authenticated to an account.

func NewAWSAccountClientProvider

func NewAWSAccountClientProvider() AWSAccountClientProvider

NewAWSAccountClientProvider creates the default account-scoped AWS client provider.

type ClusterInfo

type ClusterInfo struct {
	HCPClusterID     string
	HCPClusterRegion string
	DomainPrefix     string
	BaseDomain       string
	MgmtClusterID    string
	MgmtClusterName  string
}

ClusterInfo holds cluster details resolved from OCM by a ClusterResolver.

type ClusterResolver

type ClusterResolver interface {
	Resolve(ctx context.Context, clusterIdentifier string) (ClusterInfo, error)
}

ClusterResolver resolves an HCP cluster identifier to its canonical OCM IDs, including the management cluster.

type ManagedClusterAddonClient

type ManagedClusterAddonClient interface {
	ListManagedClusterAddons(ctx context.Context, namespace string) ([]addonv1alpha1.ManagedClusterAddOn, error)
	UpdateManagedClusterAddonHosting(ctx context.Context, namespace, name, uid, currentHostingMC, replacementMC string) error
}

ManagedClusterAddonClient manages ManagedClusterAddon resources on a service cluster.

type ManagedClusterClient

type ManagedClusterClient interface {
	GetManagedCluster(ctx context.Context, name string) (*clusterv1.ManagedCluster, error)
	UpdateManagedClusterHosting(ctx context.Context, name, uid, resourceVersion, replacementMC string, updateAddonHosting bool) error
}

ManagedClusterClient manages ManagedCluster resources on a service cluster.

type ManagementClusterClient

type ManagementClusterClient interface {
	GetVeleroSchedule(ctx context.Context, namespace, name string) (*unstructured.Unstructured, error)
	CreateVeleroBackup(ctx context.Context, request VeleroBackupRequest) (string, error)
	RestoreVeleroBackup(ctx context.Context, request VeleroRestoreRequest) (VeleroRestoreResult, error)
	ListVolumeSnapshotContents(ctx context.Context) (*unstructured.UnstructuredList, error)
	RemapVolumeSnapshotContents(ctx context.Context, request VolumeSnapshotRemapRequest) error
}

ManagementClusterClient manages Velero resources for one management cluster. Schedule checks remain unprivileged; creating a backup requires elevation.

type ManagementClusterClientConfig

type ManagementClusterClientConfig struct {
	VeleroNamespace string
	Logger          *logrus.Logger
}

func (*ManagementClusterClientConfig) Defaults

func (c *ManagementClusterClientConfig) Defaults()

func (*ManagementClusterClientConfig) Options

type ManagementClusterClientOption

type ManagementClusterClientOption interface {
	ConfigureManagementClusterClient(*ManagementClusterClientConfig)
}

type ManifestWorkListConfig

type ManifestWorkListConfig struct {
	// contains filtered or unexported fields
}

func (*ManifestWorkListConfig) Options

func (c *ManifestWorkListConfig) Options(opts ...ManifestWorkListOption)

type ManifestWorkListOption

type ManifestWorkListOption interface {
	ConfigureManifestWorkList(*ManifestWorkListConfig)
}

ManifestWorkListOption configures a ManifestWork list operation.

func WithManifestWorkLabel

func WithManifestWorkLabel(key, value string) ManifestWorkListOption

WithManifestWorkLabel filters ManifestWorks by a label key and value.

type OCMClient

type OCMClient struct {
	// contains filtered or unexported fields
}

OCMClient provides HCP operations backed by a shared OCM connection. The caller owns the connection lifecycle.

func NewOCMClient

func NewOCMClient(conn *ocmsdk.Connection, opts ...OCMClientOption) *OCMClient

func (*OCMClient) BackupConfig

func (c *OCMClient) BackupConfig(ctx context.Context, clusterID, managementCluster string) (*cmv1.AWSBackupConfig, error)

func (*OCMClient) Cluster

func (c *OCMClient) Cluster(identifier string) (*cmv1.Cluster, error)

func (*OCMClient) ElevatedManagementCluster

func (c *OCMClient) ElevatedManagementCluster(clusterID, reason string, opts ...ManagementClusterClientOption) (ManagementClusterClient, error)

func (*OCMClient) Environment

func (c *OCMClient) Environment() string

func (*OCMClient) HCPNamespace

func (c *OCMClient) HCPNamespace(ctx context.Context, clusterID string) (string, error)

HCPNamespace returns the namespace where the HCP control plane is hosted.

func (*OCMClient) ManagementCluster

func (c *OCMClient) ManagementCluster(clusterID string, options ...ManagementClusterClientOption) (ManagementClusterClient, error)

func (*OCMClient) ManagementClusterAssignment

func (c *OCMClient) ManagementClusterAssignment(ctx context.Context, clusterID string) (string, error)

ManagementClusterAssignment returns the management cluster currently assigned to the HCP in OCM.

func (*OCMClient) Resolve

func (c *OCMClient) Resolve(ctx context.Context, clusterIdentifier string) (ClusterInfo, error)

func (*OCMClient) ResolveCluster

func (c *OCMClient) ResolveCluster(ctx context.Context, clusterIdentifier string) (ClusterInfo, error)

func (*OCMClient) ResolveServiceCluster

func (c *OCMClient) ResolveServiceCluster(ctx context.Context, clusterID string) (ServiceClusterInfo, error)

func (*OCMClient) ServiceCluster

func (c *OCMClient) ServiceCluster(clusterID, reason string) (ServiceClusterClient, error)

func (*OCMClient) UpdateManagementClusterAssignment

func (c *OCMClient) UpdateManagementClusterAssignment(ctx context.Context, clusterID, managementCluster string) error

UpdateManagementClusterAssignment patches only the HCP management cluster.

type OCMClientConfig

type OCMClientConfig struct {
	// Logger is the logger to use for OCM operations.
	Logger *logrus.Logger
}

func (*OCMClientConfig) Defaults

func (c *OCMClientConfig) Defaults()

func (*OCMClientConfig) Options

func (c *OCMClientConfig) Options(opts ...OCMClientOption)

type OCMClientOption

type OCMClientOption interface {
	ConfigureOCMClient(*OCMClientConfig)
}

type ServiceClusterClient

type ServiceClusterClient interface {
	GetManifestWork(ctx context.Context, namespace, name string) (*workv1.ManifestWork, error)
	ListManifestWorks(ctx context.Context, namespace string, options ...ManifestWorkListOption) ([]workv1.ManifestWork, error)
	CreateManifestWork(ctx context.Context, work *workv1.ManifestWork) error
	UpdateManifestWork(ctx context.Context, work *workv1.ManifestWork) error
}

ServiceClusterClient manages ManifestWorks for one service cluster.

type ServiceClusterInfo

type ServiceClusterInfo struct {
	ID   string
	Name string
}

ServiceClusterInfo identifies the Service Cluster that hosts an HCP's ManifestWorks.

type VeleroBackupRequest

type VeleroBackupRequest struct {
	Namespace   string
	Schedule    string
	Container   string
	LabelKey    string
	LabelValue  string
	Labels      map[string]string
	Annotations map[string]string
}

VeleroBackupRequest identifies the schedule and metadata for a Velero backup.

type VeleroRestoreRequest

type VeleroRestoreRequest struct {
	ClusterID    string
	BackupName   string
	VerifyBackup bool
}

VeleroRestoreRequest identifies a backup to restore on a management cluster.

type VeleroRestoreResult

type VeleroRestoreResult struct {
	Name    string
	Created bool
}

VeleroRestoreResult reports the managed restore selected or created.

type VolumeSnapshotRemapRequest

type VolumeSnapshotRemapRequest struct {
	HCPNamespace string
	DomainPrefix string
	Mappings     map[string]string // VSC name to destination EBS snapshot ID.
}

VolumeSnapshotRemapRequest describes the target-cluster VSC replacement performed after snapshots have been copied into the target AWS account.

type WithLogger

type WithLogger struct {
	Logger *logrus.Logger
}

func (WithLogger) ConfigureManagementClusterClient

func (w WithLogger) ConfigureManagementClusterClient(c *ManagementClusterClientConfig)

func (WithLogger) ConfigureOCMClient

func (w WithLogger) ConfigureOCMClient(c *OCMClientConfig)

type WithVeleroNamespace

type WithVeleroNamespace string

func (WithVeleroNamespace) ConfigureManagementClusterClient

func (w WithVeleroNamespace) ConfigureManagementClusterClient(c *ManagementClusterClientConfig)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL