feature

Documentation

Index

• Constants
• Variables
• func CreateFeature(name string) *usingFeaturesHandler
• func CreateRawManifestFrom(fsys fs.FS, path string) *rawManifest
• func CreateTemplateManifestFrom(fsys fs.FS, path string) *templateManifest
• func GenerateSelfSignedCertificateAsSecret(addr string, objectMeta metav1.ObjectMeta) (*corev1.Secret, error)
• func OwnedBy(f *Feature) cluster.MetaOptions
• func ReplaceChar(s string, oldChar, newChar string) string
• type Action
  • func CreateNamespaceIfNotExists(namespace string) Action
  • func EnsureOperatorIsInstalled(operatorName string) Action
  • func WaitForPodsToBeReady(namespace string) Action
  • func WaitForResourceToBeCreated(namespace string, gvk schema.GroupVersionKind) Action
• type Feature
  • func (f *Feature) Apply() error
  • func (f *Feature) ApplyManifest(path string) error
  • func (f *Feature) AsOwnerReference() metav1.OwnerReference
  • func (f *Feature) Cleanup() error
  • func (f *Feature) CreateSelfSignedCertificate(secretName string, certificateType infrav1.CertType, domain, namespace string) error
• type FeaturesHandler
  • func ClusterFeaturesHandler(dsci *v1.DSCInitialization, def ...FeaturesProvider) *FeaturesHandler
  • func ComponentFeaturesHandler(componentName string, spec *v1.DSCInitializationSpec, def ...FeaturesProvider) *FeaturesHandler
  • func (fh *FeaturesHandler) Apply() error
  • func (fh *FeaturesHandler) Delete() error
• type FeaturesProvider
• type HandlerWithReporter
  • func NewHandlerWithReporter[T client.Object](handler *FeaturesHandler, reporter *status.Reporter[T]) *HandlerWithReporter[T]
  • func (h HandlerWithReporter[T]) Apply() error
  • func (h HandlerWithReporter[T]) Delete() error
• type Manifest
• type MissingOperatorError
  • func NewMissingOperatorError(operatorName string, err error) *MissingOperatorError
  • func (e *MissingOperatorError) Error() string
  • func (e *MissingOperatorError) Unwrap() error
• type OAuth
• type Spec

Constants

const (
	YamlSeparator = "(?m)^---[ \t]*$"
)

Variables

var EmptyFeaturesHandler = &FeaturesHandler{
	features:          []*Feature{},
	featuresProviders: []FeaturesProvider{},
}

EmptyFeaturesHandler is noop handler so that we can avoid nil checks in the code and safely call Apply/Delete methods.

Functions

func CreateFeature

func CreateFeature(name string) *usingFeaturesHandler

CreateFeature creates a new feature builder with the given name.

func CreateRawManifestFrom

func CreateRawManifestFrom(fsys fs.FS, path string) *rawManifest

func CreateTemplateManifestFrom

func CreateTemplateManifestFrom(fsys fs.FS, path string) *templateManifest

func GenerateSelfSignedCertificateAsSecret

func GenerateSelfSignedCertificateAsSecret(addr string, objectMeta metav1.ObjectMeta) (*corev1.Secret, error)

func OwnedBy

func OwnedBy(f *Feature) cluster.MetaOptions

func ReplaceChar

func ReplaceChar(s string, oldChar, newChar string) string

Types

type Action

type Action func(feature *Feature) error

Action is a func type which can be used for different purposes while having access to Feature struct.

func CreateNamespaceIfNotExists

func CreateNamespaceIfNotExists(namespace string) Action

CreateNamespaceIfNotExists will create a namespace with the given name if it does not exist yet. It does not set ownership nor apply extra metadata to the existing namespace.

func EnsureOperatorIsInstalled

func EnsureOperatorIsInstalled(operatorName string) Action

func WaitForPodsToBeReady

func WaitForPodsToBeReady(namespace string) Action

func WaitForResourceToBeCreated

func WaitForResourceToBeCreated(namespace string, gvk schema.GroupVersionKind) Action

type Feature

type Feature struct {
	Name    string
	Spec    *Spec
	Enabled bool
	Managed bool
	Tracker *featurev1.FeatureTracker

	Client client.Client

	Log logr.Logger
	// contains filtered or unexported fields
}

func (*Feature) Apply

func (f *Feature) Apply() error

func (*Feature) ApplyManifest

func (f *Feature) ApplyManifest(path string) error

func (*Feature) AsOwnerReference

func (f *Feature) AsOwnerReference() metav1.OwnerReference

func (*Feature) Cleanup

func (f *Feature) Cleanup() error

func (*Feature) CreateSelfSignedCertificate

func (f *Feature) CreateSelfSignedCertificate(secretName string, certificateType infrav1.CertType, domain, namespace string) error

type FeaturesHandler

type FeaturesHandler struct {
	*v1.DSCInitializationSpec
	// contains filtered or unexported fields
}

FeaturesHandler coordinates feature creations and removal from within controllers.

func ClusterFeaturesHandler

func ClusterFeaturesHandler(dsci *v1.DSCInitialization, def ...FeaturesProvider) *FeaturesHandler

func ComponentFeaturesHandler

func ComponentFeaturesHandler(componentName string, spec *v1.DSCInitializationSpec, def ...FeaturesProvider) *FeaturesHandler

func (*FeaturesHandler) Apply

func (fh *FeaturesHandler) Apply() error

func (*FeaturesHandler) Delete

func (fh *FeaturesHandler) Delete() error

Delete executes registered clean-up tasks in the opposite order they were initiated (following a stack structure). For instance, this allows for the undoing patches before its deletion. This approach assumes that Features are either instantiated in the correct sequence or are self-contained.

type FeaturesProvider

type FeaturesProvider func(handler *FeaturesHandler) error

FeaturesProvider is a function which allow to define list of features and couple them with the given initializer.

type HandlerWithReporter

type HandlerWithReporter[T client.Object] struct {
	// contains filtered or unexported fields
}

HandlerWithReporter is a wrapper around FeaturesHandler and status.Reporter It is intended apply features related to a given resource capabilities and report its status using custom reporter.

func NewHandlerWithReporter

func NewHandlerWithReporter[T client.Object](handler *FeaturesHandler, reporter *status.Reporter[T]) *HandlerWithReporter[T]

func (HandlerWithReporter[T]) Apply

func (h HandlerWithReporter[T]) Apply() error

func (HandlerWithReporter[T]) Delete

func (h HandlerWithReporter[T]) Delete() error

type Manifest

type Manifest interface {
	// Process allows any arbitrary struct to be passed and used while processing the content of the manifest.
	Process(data any) ([]*unstructured.Unstructured, error)
	// MarkAsManaged sets all non-patch objects to be managed/reconciled by setting the annotation.
	MarkAsManaged(objects []*unstructured.Unstructured)
}

type MissingOperatorError

type MissingOperatorError struct {
	// contains filtered or unexported fields
}

func NewMissingOperatorError

func NewMissingOperatorError(operatorName string, err error) *MissingOperatorError

func (*MissingOperatorError) Error

func (e *MissingOperatorError) Error() string

func (*MissingOperatorError) Unwrap

func (e *MissingOperatorError) Unwrap() error

type OAuth

type OAuth struct {
	AuthzEndpoint,
	TokenEndpoint,
	Route,
	Port,
	ClientSecret,
	Hmac string
}

type Spec

type Spec struct {
	*infrav1.ServiceMeshSpec
	Serving                  *infrav1.ServingSpec
	AuthProviderName         string
	OAuth                    OAuth
	AppNamespace             string
	TargetNamespace          string
	Domain                   string
	KnativeCertificateSecret string
	KnativeIngressDomain     string
	Source                   *featurev1.Source
}