install

Documentation

Index

• Variables
• func AreAllCRDInstalled(ctx context.Context, c client.Client) (bool, error)
• func BuilderServiceAccountRoles(ctx context.Context, c client.Client, namespace string, ...) error
• func ExampleOrCollect(ctx context.Context, c client.Client, namespace string, ...) error
• func IsCRDInstalled(ctx context.Context, c client.Client, kind string, version string) (bool, error)
• func IsClusterRoleInstalled(ctx context.Context, c client.Client) (bool, error)
• func KameletCatalog(ctx context.Context, c client.Client, namespace string) error
• func KameletViewerRole(ctx context.Context, c client.Client, namespace string) error
• func OpenShiftConsoleDownloadLink(ctx context.Context, c client.Client) error
• func OperatorOrCollect(ctx context.Context, c client.Client, cfg OperatorConfiguration, ...) error
• func OperatorStartupOptionalTools(ctx context.Context, c client.Client, namespace string, ...)
• func Platform(ctx context.Context, c client.Client, clusterType string, namespace string, ...) (*v1.IntegrationPlatform, error)
• func PlatformOrCollect(ctx context.Context, c client.Client, clusterType string, namespace string, ...) (*v1.IntegrationPlatform, error)
• func RegistrySecretFromFileOrCollect(ctx context.Context, c client.Client, namespace string, file string, ...) (string, error)
• func RegistrySecretOrCollect(ctx context.Context, c client.Client, namespace string, auth registry.Auth, ...) (string, error)
• func Resource(ctx context.Context, c client.Client, namespace string, force bool, ...) error
• func ResourceOrCollect(ctx context.Context, c client.Client, namespace string, ...) error
• func Resources(ctx context.Context, c client.Client, namespace string, force bool, ...) error
• func ResourcesOrCollect(ctx context.Context, c client.Client, namespace string, ...) error
• func RuntimeObject(ctx context.Context, c client.Client, namespace string, force bool, ...) error
• func RuntimeObjectOrCollect(ctx context.Context, c client.Client, namespace string, ...) error
• func SetupClusterWideResourcesOrCollect(ctx context.Context, clientProvider client.Provider, ...) error
• func WaitForAllCRDInstallation(ctx context.Context, clientProvider client.Provider, timeout time.Duration) error
• type OperatorConfiguration
• type OperatorHealthConfiguration
• type OperatorMonitoringConfiguration
• type ResourceCustomizer

Variables

var (
	// KamelCLIDownloadName --
	KamelCLIDownloadName = "kamel-cli"
	// KamelCLIDownloadDisplayName is the name as seen in the download page
	KamelCLIDownloadDisplayName = "kamel - Apache Camel K Command Line Interface"
	// KamelCLIDownloadDescription is the description as seen in the download page
	KamelCLIDownloadDescription = "Apache Camel K is a lightweight integration platform, born on Kubernetes, with serverless superpowers.\n\n" +
		"The `kamel` binary can be used to both configure the cluster and run integrations. " +
		"Once you've downloaded the `kamel` binary, log into the cluster using the `oc` client tool and start using the `kamel` CLI.\n\n" +
		"You can run `kamel help` to list the available commands or go to the [Camel K Website](https://camel.apache.org/projects/camel-k/) for more information."

	// KamelCLIDownloadURLTemplate is the download template with 3 missing parameters (version, version, os)
	KamelCLIDownloadURLTemplate = "https://github.com/apache/camel-k/releases/download/v%s/camel-k-client-%s-%s-64bit.tar.gz"
)

The following variables may be overridden at build time

var IdentityResourceCustomizer = func(object runtime.Object) runtime.Object {
	return object
}

IdentityResourceCustomizer is a ResourceCustomizer that does nothing

Functions

func AreAllCRDInstalled

func AreAllCRDInstalled(ctx context.Context, c client.Client) (bool, error)

AreAllCRDInstalled check if all the required CRDs are installed

func BuilderServiceAccountRoles

func BuilderServiceAccountRoles(ctx context.Context, c client.Client, namespace string, cluster v1.IntegrationPlatformCluster) error

BuilderServiceAccountRoles installs the builder service account and related roles in the given namespace

func ExampleOrCollect

func ExampleOrCollect(ctx context.Context, c client.Client, namespace string, collection *kubernetes.Collection, force bool) error

ExampleOrCollect --

func IsCRDInstalled

func IsCRDInstalled(ctx context.Context, c client.Client, kind string, version string) (bool, error)

IsCRDInstalled check if the given CRD kind is installed

func IsClusterRoleInstalled

func IsClusterRoleInstalled(ctx context.Context, c client.Client) (bool, error)

IsClusterRoleInstalled check if cluster role camel-k:edit is installed

func KameletCatalog

func KameletCatalog(ctx context.Context, c client.Client, namespace string) error

KameletCatalog installs the bundlet KameletCatalog into one namespace

func KameletViewerRole

func KameletViewerRole(ctx context.Context, c client.Client, namespace string) error

KameletViewerRole installs the role that allows any user ro access kamelets in the global namespace

func OpenShiftConsoleDownloadLink

func OpenShiftConsoleDownloadLink(ctx context.Context, c client.Client) error

OpenShiftConsoleDownloadLink installs the download link for the OpenShift console

func OperatorOrCollect

func OperatorOrCollect(ctx context.Context, c client.Client, cfg OperatorConfiguration, collection *kubernetes.Collection, force bool) error

OperatorOrCollect installs the operator resources or adds them to the collector if present

func OperatorStartupOptionalTools

func OperatorStartupOptionalTools(ctx context.Context, c client.Client, namespace string, operatorNamespace string, log logr.Logger)

OperatorStartupOptionalTools tries to install optional tools at operator startup and warns if something goes wrong

func Platform

func Platform(ctx context.Context, c client.Client, clusterType string, namespace string, registry v1.IntegrationPlatformRegistrySpec) (*v1.IntegrationPlatform, error)

Platform installs the platform custom resource nolint: lll

func PlatformOrCollect

func PlatformOrCollect(ctx context.Context, c client.Client, clusterType string, namespace string, registry v1.IntegrationPlatformRegistrySpec, collection *kubernetes.Collection) (*v1.IntegrationPlatform, error)

PlatformOrCollect -- nolint: lll

func RegistrySecretFromFileOrCollect

func RegistrySecretFromFileOrCollect(ctx context.Context, c client.Client, namespace string, file string, collection *kubernetes.Collection, force bool) (string, error)

RegistrySecretFromFileOrCollect generates a secret from a docker-config.json file and creates it on the cluster (or appends it to the collection)

func RegistrySecretOrCollect

func RegistrySecretOrCollect(ctx context.Context, c client.Client, namespace string, auth registry.Auth, collection *kubernetes.Collection, force bool) (string, error)

RegistrySecretOrCollect generates a secret from auth settings and creates it on the cluster (or appends it to the collection)

func Resource

func Resource(ctx context.Context, c client.Client, namespace string, force bool, customizer ResourceCustomizer, name string) error

Resource installs a single named resource from the project resource directory

func ResourceOrCollect

func ResourceOrCollect(ctx context.Context, c client.Client, namespace string, collection *kubernetes.Collection,
	force bool, customizer ResourceCustomizer, name string) error

ResourceOrCollect --

func Resources

func Resources(ctx context.Context, c client.Client, namespace string, force bool, customizer ResourceCustomizer, names ...string) error

Resources installs named resources from the project resource directory

func ResourcesOrCollect

func ResourcesOrCollect(ctx context.Context, c client.Client, namespace string, collection *kubernetes.Collection,
	force bool, customizer ResourceCustomizer, names ...string) error

ResourcesOrCollect --

func RuntimeObject

func RuntimeObject(ctx context.Context, c client.Client, namespace string, force bool, obj runtime.Object) error

RuntimeObject installs a single runtime object

func RuntimeObjectOrCollect

func RuntimeObjectOrCollect(ctx context.Context, c client.Client, namespace string, collection *kubernetes.Collection, force bool, obj runtime.Object) error

RuntimeObjectOrCollect --

func SetupClusterWideResourcesOrCollect

func SetupClusterWideResourcesOrCollect(ctx context.Context, clientProvider client.Provider, collection *kubernetes.Collection) error

SetupClusterWideResourcesOrCollect --

func WaitForAllCRDInstallation

func WaitForAllCRDInstallation(ctx context.Context, clientProvider client.Provider, timeout time.Duration) error

WaitForAllCRDInstallation waits until all CRDs are installed

Types

type OperatorConfiguration

type OperatorConfiguration struct {
	CustomImage           string
	CustomImagePullPolicy string
	Namespace             string
	Global                bool
	ClusterType           string
	Health                OperatorHealthConfiguration
	Monitoring            OperatorMonitoringConfiguration
}

OperatorConfiguration --

type OperatorHealthConfiguration

type OperatorHealthConfiguration struct {
	Port int32
}

OperatorHealthConfiguration --

type OperatorMonitoringConfiguration

type OperatorMonitoringConfiguration struct {
	Enabled bool
	Port    int32
}

OperatorMonitoringConfiguration --

type ResourceCustomizer

type ResourceCustomizer func(object runtime.Object) runtime.Object

ResourceCustomizer can be used to inject code that changes the objects before they are created