olm

package
v0.0.0-...-f088d00 Latest Latest
Warning

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

 Go to latest Published: Jan 30, 2025 License: Apache-2.0 Imports: 14 Imported by: 10

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CatalogSourceBuilder 

type CatalogSourceBuilder struct {
	// CatalogSource definition. Used to create
	// CatalogSource object with minimum set of required elements.
	Definition *oplmV1alpha1.CatalogSource
	// Created CatalogSource object on the cluster.
	Object *oplmV1alpha1.CatalogSource
	// contains filtered or unexported fields
}

CatalogSourceBuilder provides a struct for catalogsource object from the cluster and a catalogsource definition.

func ListCatalogSources 

func ListCatalogSources(
	apiClient *clients.Settings,
	nsname string,
	options ...client.ListOptions) ([]*CatalogSourceBuilder, error)

ListCatalogSources returns catalogsource inventory in the given namespace.

func NewCatalogSourceBuilder 

func NewCatalogSourceBuilder(apiClient *clients.Settings, name, nsname string) *CatalogSourceBuilder

NewCatalogSourceBuilder creates new instance of CatalogSourceBuilder.

func PullCatalogSource 

func PullCatalogSource(apiClient *clients.Settings, name, nsname string) (*CatalogSourceBuilder,
	error)

PullCatalogSource loads an existing catalogsource into Builder struct.

func (*CatalogSourceBuilder) Create 

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

Create makes an CatalogSourceBuilder in cluster and stores the created object in struct.

func (*CatalogSourceBuilder) Delete 

func (builder *CatalogSourceBuilder) Delete() error

Delete removes a catalogsource.

func (*CatalogSourceBuilder) Exists 

func (builder *CatalogSourceBuilder) Exists() bool

Exists checks whether the given catalogsource exists.

func (*CatalogSourceBuilder) Get 

func (builder *CatalogSourceBuilder) Get() (*oplmV1alpha1.CatalogSource, error)

Get returns CatalogSource object if found.

func (*CatalogSourceBuilder) Update 

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

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

type ClusterServiceVersionBuilder 

type ClusterServiceVersionBuilder struct {
	// ClusterServiceVersionBuilder definition. Used to create
	// ClusterServiceVersionBuilder object with minimum set of required elements.
	Definition *oplmV1alpha1.ClusterServiceVersion
	// Created ClusterServiceVersionBuilder object on the cluster.
	Object *oplmV1alpha1.ClusterServiceVersion
	// contains filtered or unexported fields
}

ClusterServiceVersionBuilder provides a struct for clusterserviceversion object from the cluster and a clusterserviceversion definition.

func ListClusterServiceVersion 

func ListClusterServiceVersion(
	apiClient *clients.Settings,
	nsname string,
	options ...client.ListOptions) ([]*ClusterServiceVersionBuilder, error)

ListClusterServiceVersion returns clusterserviceversion inventory in the given namespace.

func ListClusterServiceVersionInAllNamespaces 

func ListClusterServiceVersionInAllNamespaces(
	apiClient *clients.Settings,
	options ...client.ListOptions) ([]*ClusterServiceVersionBuilder, error)

ListClusterServiceVersionInAllNamespaces returns cluster-wide clusterserviceversion inventory.

func ListClusterServiceVersionWithNamePattern 

func ListClusterServiceVersionWithNamePattern(
	apiClient *clients.Settings,
	namePattern string,
	nsname string,
	options ...client.ListOptions) ([]*ClusterServiceVersionBuilder, error)

ListClusterServiceVersionWithNamePattern returns a cluster-wide clusterserviceversion inventory filtered by the name pattern.

func PullClusterServiceVersion 

func PullClusterServiceVersion(apiClient *clients.Settings, name, namespace string) (*ClusterServiceVersionBuilder,
	error)

PullClusterServiceVersion loads an existing clusterserviceversion into Builder struct.

func (*ClusterServiceVersionBuilder) Delete 

func (builder *ClusterServiceVersionBuilder) Delete() error

Delete removes a clusterserviceversion.

func (*ClusterServiceVersionBuilder) Exists 

func (builder *ClusterServiceVersionBuilder) Exists() bool

Exists checks whether the given ClusterService exists.

func (*ClusterServiceVersionBuilder) Get 

func (builder *ClusterServiceVersionBuilder) Get() (*oplmV1alpha1.ClusterServiceVersion, error)

Get returns ClusterServiceVersion object if found.

func (*ClusterServiceVersionBuilder) GetAlmExamples 

func (builder *ClusterServiceVersionBuilder) GetAlmExamples() (string, error)

GetAlmExamples extracts and returns the alm-examples block from the clusterserviceversion.

func (*ClusterServiceVersionBuilder) GetPhase 

func (builder *ClusterServiceVersionBuilder) GetPhase() (oplmV1alpha1.ClusterServiceVersionPhase, error)

GetPhase gets current clusterserviceversion phase.

func (*ClusterServiceVersionBuilder) IsSuccessful 

func (builder *ClusterServiceVersionBuilder) IsSuccessful() (bool, error)

IsSuccessful checks if the clusterserviceversion is Successful.

type InstallPlanBuilder 

type InstallPlanBuilder struct {
	// Installplan definition, used to create the installplan object.
	Definition *operatorsV1alpha1.InstallPlan
	// Created installplan object.
	Object *operatorsV1alpha1.InstallPlan
	// contains filtered or unexported fields
}

InstallPlanBuilder provides a struct for installplan object from the cluster and an installplan definition.

func ListInstallPlan 

func ListInstallPlan(
	apiClient *clients.Settings, nsname string, options ...client.ListOptions) ([]*InstallPlanBuilder, error)

ListInstallPlan returns a list of installplans found for specific namespace.

func NewInstallPlanBuilder 

func NewInstallPlanBuilder(apiClient *clients.Settings, name, nsname string) *InstallPlanBuilder

NewInstallPlanBuilder creates new instance of InstallPlanBuilder.

func PullInstallPlan 

func PullInstallPlan(apiClient *clients.Settings, name, nsName string) (*InstallPlanBuilder, error)

PullInstallPlan loads existing InstallPlan from cluster into the InstallPlanBuilder struct.

func (*InstallPlanBuilder) Create 

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

Create makes an InstallPlanBuilder in cluster and stores the created object in struct.

func (*InstallPlanBuilder) Delete 

func (builder *InstallPlanBuilder) Delete() error

Delete removes an installplan.

func (*InstallPlanBuilder) Exists 

func (builder *InstallPlanBuilder) Exists() bool

Exists checks whether the given installplan exists.

func (*InstallPlanBuilder) Get 

func (builder *InstallPlanBuilder) Get() (*operatorsV1alpha1.InstallPlan, error)

Get returns InstallPlan object if found.

func (*InstallPlanBuilder) Update 

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

Update modifies the existing InstallPlanBuilder with the InstallPlan definition in InstallPlanBuilder.

type OperatorGroupBuilder 

type OperatorGroupBuilder struct {
	// OperatorGroup definition. Used to create OperatorGroup object with minimum set of required elements.
	Definition *operatorsv1.OperatorGroup
	// Created OperatorGroup object on the cluster.
	Object *operatorsv1.OperatorGroup
	// contains filtered or unexported fields
}

OperatorGroupBuilder provides a struct for OperatorGroup object containing connection to the cluster and the OperatorGroup definition.

func NewOperatorGroupBuilder 

func NewOperatorGroupBuilder(apiClient *clients.Settings, groupName, nsName string) *OperatorGroupBuilder

NewOperatorGroupBuilder returns an OperatorGroupBuilder struct.

func PullOperatorGroup 

func PullOperatorGroup(apiClient *clients.Settings, groupName, nsName string) (*OperatorGroupBuilder, error)

PullOperatorGroup loads existing OperatorGroup from cluster into the OperatorGroupBuilder struct.

func (*OperatorGroupBuilder) Create 

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

Create makes an OperatorGroup in cluster and stores the created object in struct.

func (*OperatorGroupBuilder) Delete 

func (builder *OperatorGroupBuilder) Delete() error

Delete removes an OperatorGroup.

func (*OperatorGroupBuilder) Exists 

func (builder *OperatorGroupBuilder) Exists() bool

Exists checks whether the given OperatorGroup exists.

func (*OperatorGroupBuilder) Get 

func (builder *OperatorGroupBuilder) Get() (*operatorsv1.OperatorGroup, error)

Get returns OperatorGroup object if found.

func (*OperatorGroupBuilder) Update 

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

Update modifies the existing OperatorGroup with the OperatorGroup definition in OperatorGroupBuilder.

type PackageManifestBuilder 

type PackageManifestBuilder struct {
	// PackageManifest definition. Used to create
	// PackageManifest object with minimum set of required elements.
	Definition *operatorv1.PackageManifest
	// Created PackageManifest object on the cluster.
	Object *operatorv1.PackageManifest
	// contains filtered or unexported fields
}

PackageManifestBuilder provides a struct for PackageManifest object from the cluster and a PackageManifest definition.

func ListPackageManifest 

func ListPackageManifest(
	apiClient *clients.Settings,
	nsname string,
	options ...client.ListOptions) ([]*PackageManifestBuilder, error)

ListPackageManifest returns PackageManifest inventory in the given namespace.

func PullPackageManifest 

func PullPackageManifest(apiClient *clients.Settings, name, nsname string) (*PackageManifestBuilder, error)

PullPackageManifest loads an existing PackageManifest into Builder struct.

func PullPackageManifestByCatalog 

func PullPackageManifestByCatalog(apiClient *clients.Settings, name, nsname,
	catalog string) (*PackageManifestBuilder, error)

PullPackageManifestByCatalog loads an existing PackageManifest from specified catalog into Builder struct.

func (*PackageManifestBuilder) Delete 

func (builder *PackageManifestBuilder) Delete() error

Delete removes a PackageManifest.

func (*PackageManifestBuilder) Exists 

func (builder *PackageManifestBuilder) Exists() bool

Exists checks whether the given PackageManifest exists.

func (*PackageManifestBuilder) Get 

func (builder *PackageManifestBuilder) Get() (*operatorv1.PackageManifest, error)

Get returns PackageManifest object if found.

type SubscriptionBuilder 

type SubscriptionBuilder struct {
	// Subscription definition. Used to create Subscription object with minimum set of required elements.
	Definition *operatorsV1alpha1.Subscription
	// Created Subscription object on the cluster.
	Object *operatorsV1alpha1.Subscription
	// contains filtered or unexported fields
}

SubscriptionBuilder provides a struct for Subscription object containing connection to the cluster and the Subscription definition.

func NewSubscriptionBuilder 

func NewSubscriptionBuilder(apiClient *clients.Settings, subName, subNamespace, catalogSource, catalogSourceNamespace,
	packageName string) *SubscriptionBuilder

NewSubscriptionBuilder returns a SubscriptionBuilder.

func PullSubscription 

func PullSubscription(apiClient *clients.Settings, subName, subNamespace string) (*SubscriptionBuilder, error)

PullSubscription loads existing Subscription from cluster into the SubscriptionBuilder struct.

func (*SubscriptionBuilder) Create 

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

Create makes an Subscription in cluster and stores the created object in struct.

func (*SubscriptionBuilder) Delete 

func (builder *SubscriptionBuilder) Delete() error

Delete removes a Subscription.

func (*SubscriptionBuilder) Exists 

func (builder *SubscriptionBuilder) Exists() bool

Exists checks whether the given Subscription exists.

func (*SubscriptionBuilder) Get 

func (builder *SubscriptionBuilder) Get() (*operatorsV1alpha1.Subscription, error)

Get returns Subscription object if found.

func (*SubscriptionBuilder) Update 

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

Update modifies the existing Subscription with the Subscription definition in SubscriptionBuilder.

func (*SubscriptionBuilder) WithChannel 

func (builder *SubscriptionBuilder) WithChannel(channel string) *SubscriptionBuilder

WithChannel adds the specific channel to the Subscription.

func (*SubscriptionBuilder) WithInstallPlanApproval 

func (builder *SubscriptionBuilder) WithInstallPlanApproval(
	installPlanApproval operatorsV1alpha1.Approval) *SubscriptionBuilder

WithInstallPlanApproval adds the specific installPlanApproval to the Subscription.

func (*SubscriptionBuilder) WithStartingCSV 

func (builder *SubscriptionBuilder) WithStartingCSV(startingCSV string) *SubscriptionBuilder

WithStartingCSV adds the specific startingCSV to the Subscription.

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.