ocm

package
v0.0.0-...-a4a0e90 Latest Latest
Warning

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

 Go to latest Published: Feb 25, 2025 License: Apache-2.0 Imports: 17 Imported by: 4

Documentation

Index

Constants

View Source 
const KlusterletName = "klusterlet"

KlusterletName is the name of the klusterlet created by importing a ManagedCluster.

Variables

This section is empty.

Functions

func WaitForAllPoliciesComplianceState 

func WaitForAllPoliciesComplianceState(
	apiClient *clients.Settings,
	complianceState policiesv1.ComplianceState,
	timeout time.Duration,
	options ...runtimeclient.ListOptions) error

WaitForAllPoliciesComplianceState wait up to timeout until all policies have complianceState. Policies are listed with options on every poll and then these policies have their compliance state checked.

Types

type KACBuilder 

type KACBuilder struct {
	// Definition of the KlusterletAddonConfig used to create the object.
	Definition *kacv1.KlusterletAddonConfig
	// Object of the KlusterletAddonConfig as it is on the cluster.
	Object *kacv1.KlusterletAddonConfig
	// contains filtered or unexported fields
}

KACBuilder provides a struct for the KlusterletAddonConfig resource containing a connection to the cluster and the KlusterletAddonConfig definition.

func NewKACBuilder 

func NewKACBuilder(apiClient *clients.Settings, name, nsname string) *KACBuilder

NewKACBuilder creates a new instance of a KlusterletAddonConfig builder.

func PullKAC 

func PullKAC(apiClient *clients.Settings, name, nsname string) (*KACBuilder, error)

PullKAC pulls an existing KlusterletAddonConfig into a Builder struct.

func (*KACBuilder) Create 

func (builder *KACBuilder) Create() (*KACBuilder, error)

Create makes a KlusterletAddonConfig on the cluster if it does not already exist.

func (*KACBuilder) Delete 

func (builder *KACBuilder) Delete() error

Delete removes a KlusterletAddonConfig from the cluster if it exists.

func (*KACBuilder) Exists 

func (builder *KACBuilder) Exists() bool

Exists checks whether the given KlusterletAddonConfig exists on the cluster.

func (*KACBuilder) Get 

func (builder *KACBuilder) Get() (*kacv1.KlusterletAddonConfig, error)

Get returns the KlusterletAddonConfig object if found.

func (*KACBuilder) Update 

func (builder *KACBuilder) Update(force bool) (*KACBuilder, error)

Update changes the existing KlusterletAddonConfig resource on the cluster, falling back to deleting and recreating if the update fails when force is set.

func (*KACBuilder) WaitUntilSearchCollectorEnabled 

func (builder *KACBuilder) WaitUntilSearchCollectorEnabled(timeout time.Duration) (*KACBuilder, error)

WaitUntilSearchCollectorEnabled waits up to the specified timeout until the search collector config has been enabled.

type KlusterletBuilder 

type KlusterletBuilder struct {
	// Definition of the Klusterlet used to create the resource.
	Definition *operatorv1.Klusterlet
	// Object of the Klusterlet as it is on the cluster.
	Object *operatorv1.Klusterlet
	// contains filtered or unexported fields
}

KlusterletBuilder provides a struct to interface with Klusterlet resources on a specific cluster.

func NewKlusterletBuilder 

func NewKlusterletBuilder(apiClient *clients.Settings, name string) *KlusterletBuilder

NewKlusterletBuilder creates a new instance of a Klusterlet builder.

func PullKlusterlet 

func PullKlusterlet(apiClient *clients.Settings, name string) (*KlusterletBuilder, error)

PullKlusterlet pulls an existing Klusterlet into a Builder struct.

func (*KlusterletBuilder) Create 

func (builder *KlusterletBuilder) Create() (*KlusterletBuilder, error)

Create makes a Klusterlet on the cluster if it does not already exist.

func (*KlusterletBuilder) Delete 

func (builder *KlusterletBuilder) Delete() error

Delete removes a Klusterlet from the cluster if it exists.

func (*KlusterletBuilder) Exists 

func (builder *KlusterletBuilder) Exists() bool

Exists checks whether this Klusterlet exists on the cluster.

func (*KlusterletBuilder) Get 

func (builder *KlusterletBuilder) Get() (*operatorv1.Klusterlet, error)

Get returns the Klusterlet object if found.

func (*KlusterletBuilder) Update 

func (builder *KlusterletBuilder) Update() (*KlusterletBuilder, error)

Update changes the existing Klusterlet resource on the cluster to match the builder Definition. Deleting a Klusterlet is nontrivial and affects the connection to the hub cluster, so there is no force option to allow deleting and recreating the Klusterlet if the update fails.

type ManagedClusterAdditionalOptions 

type ManagedClusterAdditionalOptions func(builder *ManagedClusterBuilder) (*ManagedClusterBuilder, error)

ManagedClusterAdditionalOptions additional options for ManagedCluster object.

type ManagedClusterBuilder 

type ManagedClusterBuilder struct {
	Definition *clusterv1.ManagedCluster
	Object     *clusterv1.ManagedCluster
	// contains filtered or unexported fields
}

ManagedClusterBuilder provides a struct for the ManagedCluster object containing connection to the cluster and the ManagedCluster definitions.

func NewManagedClusterBuilder 

func NewManagedClusterBuilder(apiClient *clients.Settings, name string) *ManagedClusterBuilder

NewManagedClusterBuilder creates a new instance of ManagedClusterBuilder.

func PullManagedCluster 

func PullManagedCluster(apiClient *clients.Settings, name string) (*ManagedClusterBuilder, error)

PullManagedCluster loads an existing ManagedCluster into ManagedClusterBuilder struct.

func (*ManagedClusterBuilder) Create 

func (builder *ManagedClusterBuilder) Create() (*ManagedClusterBuilder, error)

Create makes a managedcluster in the cluster and stores the created object in struct.

func (*ManagedClusterBuilder) Delete 

func (builder *ManagedClusterBuilder) Delete() error

Delete removes a ManagedCluster from the cluster.

func (*ManagedClusterBuilder) Exists 

func (builder *ManagedClusterBuilder) Exists() bool

Exists checks if the defined ManagedCluster has already been created.

func (*ManagedClusterBuilder) Get 

func (builder *ManagedClusterBuilder) Get() (*clusterv1.ManagedCluster, error)

Get returns the ManagedCluster object if found.

func (*ManagedClusterBuilder) Update 

func (builder *ManagedClusterBuilder) Update() (*ManagedClusterBuilder, error)

Update modifies an existing ManagedCluster on the cluster.

func (*ManagedClusterBuilder) WaitForLabel 

func (builder *ManagedClusterBuilder) WaitForLabel(
	label string, timeout time.Duration) (*ManagedClusterBuilder, error)

WaitForLabel waits up to timeout until label exists on the ManagedCluster.

func (*ManagedClusterBuilder) WithHubAcceptsClient 

func (builder *ManagedClusterBuilder) WithHubAcceptsClient(accept bool) *ManagedClusterBuilder

WithHubAcceptsClient sets the hubAcceptsClient field in the managedcluster resource.

func (*ManagedClusterBuilder) WithOptions 

func (builder *ManagedClusterBuilder) WithOptions(options ...ManagedClusterAdditionalOptions) *ManagedClusterBuilder

WithOptions creates ManagedCluster with generic mutation options.

type PlacementBindingBuilder 

type PlacementBindingBuilder struct {
	// placementBinding Definition, used to create the placementBinding object.
	Definition *policiesv1.PlacementBinding
	// created placementBinding object.
	Object *policiesv1.PlacementBinding
	// contains filtered or unexported fields
}

PlacementBindingBuilder type definition.

func ListPlacementBindingsInAllNamespaces 

func ListPlacementBindingsInAllNamespaces(apiClient *clients.Settings,
	options ...runtimeclient.ListOptions) (
	[]*PlacementBindingBuilder, error)

ListPlacementBindingsInAllNamespaces returns a cluster-wide placementBinding inventory.

func NewPlacementBindingBuilder 

func NewPlacementBindingBuilder(
	apiClient *clients.Settings,
	name,
	nsname string,
	placementRef policiesv1.PlacementSubject,
	subject policiesv1.Subject) *PlacementBindingBuilder

NewPlacementBindingBuilder creates a new instance of PlacementBindingBuilder.

func PullPlacementBinding 

func PullPlacementBinding(apiClient *clients.Settings, name, nsname string) (*PlacementBindingBuilder, error)

PullPlacementBinding pulls existing placementBinding into Builder struct.

func (*PlacementBindingBuilder) Create 

func (builder *PlacementBindingBuilder) Create() (*PlacementBindingBuilder, error)

Create makes a placementBinding in the cluster and stores the created object in struct.

func (*PlacementBindingBuilder) Delete 

func (builder *PlacementBindingBuilder) Delete() (*PlacementBindingBuilder, error)

Delete removes a placementBinding from a cluster.

func (*PlacementBindingBuilder) Exists 

func (builder *PlacementBindingBuilder) Exists() bool

Exists checks whether the given placementBinding exists.

func (*PlacementBindingBuilder) Get 

func (builder *PlacementBindingBuilder) Get() (*policiesv1.PlacementBinding, error)

Get returns a placementBinding object if found.

func (*PlacementBindingBuilder) Update 

func (builder *PlacementBindingBuilder) Update(force bool) (*PlacementBindingBuilder, error)

Update renovates the existing placementBinding object with the placementBinding definition in builder.

func (*PlacementBindingBuilder) WithAdditionalSubject 

func (builder *PlacementBindingBuilder) WithAdditionalSubject(subject policiesv1.Subject) *PlacementBindingBuilder

WithAdditionalSubject appends a subject to the subjects list in the PlacementBinding definition.

type PlacementRuleBuilder 

type PlacementRuleBuilder struct {
	// PlacementRule Definition, used to create the PlacementRule object.
	Definition *placementrulev1.PlacementRule
	// created PlacementRule object.
	Object *placementrulev1.PlacementRule
	// contains filtered or unexported fields
}

PlacementRuleBuilder provides struct for the PlacementRule object containing connection to the cluster and the PlacementRule definitions.

func ListPlacementrulesInAllNamespaces 

func ListPlacementrulesInAllNamespaces(apiClient *clients.Settings,
	options ...runtimeclient.ListOptions) (
	[]*PlacementRuleBuilder, error)

ListPlacementrulesInAllNamespaces returns a cluster-wide placementrule inventory.

func NewPlacementRuleBuilder 

func NewPlacementRuleBuilder(apiClient *clients.Settings, name, nsname string) *PlacementRuleBuilder

NewPlacementRuleBuilder creates a new instance of PlacementRuleBuilder.

func PullPlacementRule 

func PullPlacementRule(apiClient *clients.Settings, name, nsname string) (*PlacementRuleBuilder, error)

PullPlacementRule pulls existing placementrule into Builder struct.

func (*PlacementRuleBuilder) Create 

func (builder *PlacementRuleBuilder) Create() (*PlacementRuleBuilder, error)

Create makes a placementrule in the cluster and stores the created object in struct.

func (*PlacementRuleBuilder) Delete 

func (builder *PlacementRuleBuilder) Delete() (*PlacementRuleBuilder, error)

Delete removes a placementrule from a cluster.

func (*PlacementRuleBuilder) Exists 

func (builder *PlacementRuleBuilder) Exists() bool

Exists checks whether the given placementrule exists.

func (*PlacementRuleBuilder) Get 

func (builder *PlacementRuleBuilder) Get() (*placementrulev1.PlacementRule, error)

Get returns a placementrule object if found.

func (*PlacementRuleBuilder) Update 

func (builder *PlacementRuleBuilder) Update(force bool) (*PlacementRuleBuilder, error)

Update renovates the existing placementrule object with the placementrule definition in builder.

type PolicyBuilder 

type PolicyBuilder struct {
	// policy Definition, used to create the policy object.
	Definition *policiesv1.Policy
	// created policy object.
	Object *policiesv1.Policy
	// contains filtered or unexported fields
}

PolicyBuilder provides struct for the policy object containing connection to the cluster and the policy definitions.

func ListPoliciesInAllNamespaces 

func ListPoliciesInAllNamespaces(apiClient *clients.Settings,
	options ...runtimeclient.ListOptions) (
	[]*PolicyBuilder, error)

ListPoliciesInAllNamespaces returns a cluster-wide policy inventory.

func NewPolicyBuilder 

func NewPolicyBuilder(
	apiClient *clients.Settings, name, nsname string, template *policiesv1.PolicyTemplate) *PolicyBuilder

NewPolicyBuilder creates a new instance of PolicyBuilder.

func PullPolicy 

func PullPolicy(apiClient *clients.Settings, name, nsname string) (*PolicyBuilder, error)

PullPolicy pulls existing policy into Builder struct.

func (*PolicyBuilder) Create 

func (builder *PolicyBuilder) Create() (*PolicyBuilder, error)

Create makes a policy in the cluster and stores the created object in struct.

func (*PolicyBuilder) Delete 

func (builder *PolicyBuilder) Delete() (*PolicyBuilder, error)

Delete removes a policy from a cluster.

func (*PolicyBuilder) Exists 

func (builder *PolicyBuilder) Exists() bool

Exists checks whether the given policy exists.

func (*PolicyBuilder) Get 

func (builder *PolicyBuilder) Get() (*policiesv1.Policy, error)

Get returns a policy object if found.

func (*PolicyBuilder) Update 

func (builder *PolicyBuilder) Update(force bool) (*PolicyBuilder, error)

Update renovates the existing policy object with the policy definition in builder.

func (*PolicyBuilder) WaitForStatusMessageToContain 

func (builder *PolicyBuilder) WaitForStatusMessageToContain(
	expectedMessage string, timeout time.Duration) (*PolicyBuilder, error)

WaitForStatusMessageToContain waits up to the specified timeout for the policy message to contain the expectedMessage.

func (*PolicyBuilder) WaitUntilComplianceState 

func (builder *PolicyBuilder) WaitUntilComplianceState(state policiesv1.ComplianceState, timeout time.Duration) error

WaitUntilComplianceState waits for the duration of the defined timeout or until the policy is in the provided compliance state.

func (*PolicyBuilder) WaitUntilDeleted 

func (builder *PolicyBuilder) WaitUntilDeleted(timeout time.Duration) error

WaitUntilDeleted waits for the duration of the defined timeout or until the policy is deleted.

func (*PolicyBuilder) WithAdditionalPolicyTemplate 

func (builder *PolicyBuilder) WithAdditionalPolicyTemplate(template *policiesv1.PolicyTemplate) *PolicyBuilder

WithAdditionalPolicyTemplate appends a PolicyTemplate to the PolicyTemplates in the policy definition.

func (*PolicyBuilder) WithRemediationAction 

func (builder *PolicyBuilder) WithRemediationAction(action policiesv1.RemediationAction) *PolicyBuilder

WithRemediationAction sets a RemediationAction in the policy definition.

type PolicySetBuilder 

type PolicySetBuilder struct {
	// policySet Definition, used to create the policySet object.
	Definition *policiesv1beta1.PolicySet
	// created policySet object.
	Object *policiesv1beta1.PolicySet
	// contains filtered or unexported fields
}

PolicySetBuilder provides struct for the policySet object containing connection to the cluster and the policySet definitions.

func ListPolicieSetsInAllNamespaces 

func ListPolicieSetsInAllNamespaces(apiClient *clients.Settings,
	options ...runtimeclient.ListOptions) (
	[]*PolicySetBuilder, error)

ListPolicieSetsInAllNamespaces returns a cluster-wide policySets inventory.

func NewPolicySetBuilder 

func NewPolicySetBuilder(
	apiClient *clients.Settings, name, nsname string, policy policiesv1beta1.NonEmptyString) *PolicySetBuilder

NewPolicySetBuilder creates a new instance of PolicySetBuilder.

func PullPolicySet 

func PullPolicySet(apiClient *clients.Settings, name, nsname string) (*PolicySetBuilder, error)

PullPolicySet pulls existing policySet into Builder struct.

func (*PolicySetBuilder) Create 

func (builder *PolicySetBuilder) Create() (*PolicySetBuilder, error)

Create makes a policySet in the cluster and stores the created object in struct.

func (*PolicySetBuilder) Delete 

func (builder *PolicySetBuilder) Delete() (*PolicySetBuilder, error)

Delete removes a policySet from a cluster.

func (*PolicySetBuilder) Exists 

func (builder *PolicySetBuilder) Exists() bool

Exists checks whether the given policySet exists.

func (*PolicySetBuilder) Get 

func (builder *PolicySetBuilder) Get() (*policiesv1beta1.PolicySet, error)

Get returns a policySet object if found.

func (*PolicySetBuilder) Update 

func (builder *PolicySetBuilder) Update(force bool) (*PolicySetBuilder, error)

Update renovates the existing policySet object with the policySet's definition in builder.

func (*PolicySetBuilder) WithAdditionalPolicy 

func (builder *PolicySetBuilder) WithAdditionalPolicy(policy policiesv1beta1.NonEmptyString) *PolicySetBuilder

WithAdditionalPolicy appends a policy to the policies list in the PolicySet definition.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.