additionalclusterenvs

package
v1.0.0-rc.2 Latest Latest
Warning

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

Go to latest
Published: Feb 17, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	FeatureFlagName = "no-additional-cluster-envs"
	FlagHelpMessage = "Disables additional cluster environment variables functionality"
)

Define any defaults here as constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Feature

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

func (*Feature) Configure

func (f *Feature) Configure() error

We want to self-contain the configuration functionality separate from the initialization so that we can read in the enabled config

func (*Feature) Enabled

func (f *Feature) Enabled() bool

Enabled is where we determine whether or not the feature is explicitly enabled if opt-in or disabled if opt-out.

func (*Feature) ExitOnError

func (f *Feature) ExitOnError() bool

If this feature is required for the functionality of ocm-container OR if a configuration error will be catastrophic to our user's experience, set this to true. Otherwise, if we lose a convenience function but we should still allow the user to use the container, then set false. In almost all cases, this should be set to false.

func (*Feature) HandleError

func (f *Feature) HandleError(err error)

If initialize fails, how should we handle the error? This allows you to customize what log level to use or how to clean up anything you need to.

func (*Feature) Initialize

func (f *Feature) Initialize() (features.OptionSet, error)

Initialize is the feature that we use to create the OptionSet for a given feature. An OptionSet is how the ocm-container program knows what options to pass into the container create command in order for the individual feature to work properly

Jump to

Keyboard shortcuts

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