install

Documentation

Index

• Variables
• func BuilderServiceAccountRoles(ctx context.Context, c client.Client, namespace string, ...) error
• func ExampleOrCollect(ctx context.Context, c client.Client, namespace string, ...) error
• func IntegrationPlatformViewerRole(ctx context.Context, c client.Client, namespace string) error
• func KameletCatalog(ctx context.Context, c client.Client, namespace string) error
• func KameletViewerRole(ctx context.Context, c client.Client, namespace string) error
• func NewPlatform(ctx context.Context, c client.Client, clusterType string, ...) (*v1.IntegrationPlatform, error)
• func ObjectOrCollect(ctx context.Context, c client.Client, namespace string, ...) error
• func OpenShiftConsoleDownloadLink(ctx context.Context, c client.Client) error
• func OperatorOrCollect(ctx context.Context, cmd *cobra.Command, c client.Client, ...) error
• func OperatorStartupOptionalTools(ctx context.Context, c client.Client, namespace string, ...)
• 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 SetupClusterWideResourcesOrCollect(ctx context.Context, clientProvider client.Provider, ...) error
• func WaitForAllCrdInstallation(ctx context.Context, clientProvider client.Provider, timeout time.Duration) error
• type OperatorConfiguration
• type OperatorDebuggingConfiguration
• type OperatorHealthConfiguration
• type OperatorMonitoringConfiguration
• type OperatorStorageConfiguration
• 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/v2/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 ctrl.Object) ctrl.Object {
	return object
}

IdentityResourceCustomizer is a ResourceCustomizer that does nothing.

var RemoveIngressRoleCustomizer = func(object ctrl.Object) ctrl.Object {
	if role, ok := object.(*rbacv1.Role); ok && role.Name == "camel-k-operator" {
	rules:
		for i, rule := range role.Rules {
			for _, group := range rule.APIGroups {
				if group == networking.GroupName {
					role.Rules = append(role.Rules[:i], role.Rules[i+1:]...)

					break rules
				}
			}
		}
	}
	return object
}

Functions

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

func IntegrationPlatformViewerRole

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

IntegrationPlatformViewerRole installs the role that allows any user to access integrationplatforms and integrationprofiles in the global namespace.

func KameletCatalog

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

KameletCatalog installs the bundled Kamelets into the specified 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 NewPlatform

func NewPlatform(
	ctx context.Context, c client.Client,
	clusterType string, skipRegistrySetup bool, registry v1.RegistrySpec, operatorID string,
) (*v1.IntegrationPlatform, error)

NewPlatform creates a new IntegrationPlatform instance.

func ObjectOrCollect

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

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, cmd *cobra.Command, c client.Client, cfg OperatorConfiguration, collection *kubernetes.Collection, force bool) error

OperatorOrCollect installs the operator resources or adds them to the collector if present. nolint: maintidx // TODO: refactor the code

func OperatorStartupOptionalTools

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

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

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

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

func SetupClusterWideResourcesOrCollect

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

func WaitForAllCrdInstallation

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

Types

type OperatorConfiguration

type OperatorConfiguration struct {
	CustomImage           string
	CustomImagePullPolicy string
	Namespace             string
	Global                bool
	ClusterType           string
	Health                OperatorHealthConfiguration
	Monitoring            OperatorMonitoringConfiguration
	Debugging             OperatorDebuggingConfiguration
	Tolerations           []string
	NodeSelectors         []string
	ResourcesRequirements []string
	EnvVars               []string
}

type OperatorDebuggingConfiguration

type OperatorDebuggingConfiguration struct {
	Enabled bool
	Port    int32
	Path    string
}

type OperatorHealthConfiguration

type OperatorHealthConfiguration struct {
	Port int32
}

type OperatorMonitoringConfiguration

type OperatorMonitoringConfiguration struct {
	Enabled bool
	Port    int32
}

type OperatorStorageConfiguration

type OperatorStorageConfiguration struct {
	Enabled    bool
	ClassName  string
	Capacity   string
	AccessMode string
}

OperatorStorageConfiguration represents the configuration required for Camel K operator storage.

type ResourceCustomizer

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

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