install

Documentation

Index

• Variables
• func AreAllCRDInstalled(ctx context.Context, c client.Client) (bool, error)
• func CamelKResources(ctx context.Context, c client.Client, namespace string, ...) error
• func InstanceViewerRole(ctx context.Context, c client.Client, namespace string, ...) error
• func IsCRDInstalled(ctx context.Context, c client.Client, kind string, version string) (bool, error)
• func KnativeResources(ctx context.Context, c client.Client, namespace string, ...) error
• func OpenShiftConsoleDownloadLink(ctx context.Context, c client.Client) error
• func Operator(ctx context.Context, cmd *cobra.Command, c client.Client, ...) error
• func OperatorOrCollect(ctx context.Context, cmd *cobra.Command, c client.Client, ...) error
• func OperatorStartupOptionalTools(ctx context.Context, c client.Client, log logutil.Logger)
• 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 StrimziResources(ctx context.Context, c client.Client, namespace string, ...) error
• func ViewerServiceAccountRoles(ctx context.Context, c client.Client, namespace string) error
• func ViewerServiceAccountRolesCamelK(ctx context.Context, c client.Client, namespace string) error
• func ViewerServiceAccountRolesKnative(ctx context.Context, c client.Client, namespace string) error
• func ViewerServiceAccountRolesKubernetes(ctx context.Context, c client.Client, namespace string) error
• func ViewerServiceAccountRolesOpenShift(ctx context.Context, c client.Client, namespace string) error
• func ViewerServiceAccountRolesStrimzi(ctx context.Context, c client.Client, namespace string) error
• func WaitForAllCRDInstallation(ctx context.Context, clientProvider client.Provider, timeout time.Duration) error
• type OperatorConfiguration
• type ResourceCustomizer

Variables

var (
	// YaksCLIDownloadName --.
	YaksCLIDownloadName = "yaks-cli"
	// YaksCLIDownloadDisplayName is the name as seen in the download page.
	YaksCLIDownloadDisplayName = "yaks - YAKS Command Line Interface"
	// YaksCLIDownloadDescription is the description as seen in the download page.
	YaksCLIDownloadDescription = "YAKS is a integration testing tool to enable Cloud Native BDD testing.\n\n" +
		"The `yaks` binary can be used to both configure the cluster and run tests. " +
		"Once you've downloaded the `yaks` binary, log into the cluster using the `oc` client tool and start using the `yaks` CLI.\n\n" +
		"You can run `yaks help` to list the available commands for more information."

	// YaksCLIDownloadURLTemplate is the download template with 3 missing parameters (version, version, os).
	YaksCLIDownloadURLTemplate = "https://github.com/citrusframework/yaks/releases/download/v%s/yaks-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.

Functions

func AreAllCRDInstalled

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

AreAllCRDInstalled check if all the required CRDs are installed.

func CamelKResources

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

func InstanceViewerRole

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

InstanceViewerRole installs the role that allows any user ro access to instances in all namespaces.

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 KnativeResources

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

func OpenShiftConsoleDownloadLink

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

OpenShiftConsoleDownloadLink installs the download link for the OpenShift console.

func Operator

func Operator(ctx context.Context, cmd *cobra.Command, c client.Client, cfg OperatorConfiguration, force bool) error

Operator installs the operator resources in the given namespace.

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.

func OperatorStartupOptionalTools

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

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

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 ctrl.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 ctrl.Object) error

RuntimeObjectOrCollect --.

func SetupClusterWideResourcesOrCollect

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

SetupClusterWideResourcesOrCollect --.

func StrimziResources

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

func ViewerServiceAccountRoles

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

ViewerServiceAccountRoles installs the viewer service account and related roles in the given namespace.

func ViewerServiceAccountRolesCamelK

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

func ViewerServiceAccountRolesKnative

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

func ViewerServiceAccountRolesKubernetes

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

func ViewerServiceAccountRolesOpenShift

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

func ViewerServiceAccountRolesStrimzi

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

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
	EnvVars               []string
}

OperatorConfiguration --.

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.