api

package
v1.8.6 Latest Latest
Warning

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

Go to latest
Published: Dec 4, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package api contains the API definition for the patch engine. NOTE: We are introducing this API as a decoupling layer between the patch engine and the concrete components responsible for generating patches, because we aim to provide support for external patches in a future iteration. We also assume that this API and all the related types will be moved in a separate (versioned) package thus providing a versioned contract between Cluster API and the components implementing external patch extensions.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Generator

type Generator interface {
	// Generate generates patches for templates.
	// GeneratePatchesRequest contains templates and the corresponding variables.
	// GeneratePatchesResponse contains the patches which should be applied to the templates of the GenerateRequest.
	Generate(context.Context, client.Object, *runtimehooksv1.GeneratePatchesRequest) (*runtimehooksv1.GeneratePatchesResponse, error)
}

Generator defines a component that can generate patches for ClusterClass templates.

type Validator added in v1.2.0

type Validator interface {
	// Validate validates templates..
	// ValidateTopologyRequest contains templates and the corresponding variables.
	// ValidateTopologyResponse contains the validation response.
	Validate(context.Context, client.Object, *runtimehooksv1.ValidateTopologyRequest) (*runtimehooksv1.ValidateTopologyResponse, error)
}

Validator defines a component that can validate ClusterClass templates.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL