flux

package
v5.5.1 Latest Latest
Warning

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

Go to latest
Published: Dec 21, 2025 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Package flux provides a Flux client implementation using Flux Kubernetes APIs.

This package wraps Flux CD controller APIs (HelmRelease, Kustomization, Sources) and provides client functionality for creating and managing Flux resources on Kubernetes clusters.

Index

Constants

View Source
const (
	// DefaultNamespace is the default namespace for Flux resources.
	DefaultNamespace = "flux-system"
	// SplitParts is the number of parts when splitting strings like "namespace/name" or "name.namespace".
	SplitParts = 2
)

Variables

View Source
var (
	// ErrTypeMismatch is returned when type assertion fails in copySpec.
	ErrTypeMismatch = errors.New("type mismatch in copySpec")
	// ErrUnsupportedResourceType is returned when an unsupported resource type is passed to copySpec.
	ErrUnsupportedResourceType = errors.New("unsupported resource type")
)
View Source
var ErrOCIRefRequired = errors.New("one of --tag, --tag-semver or --digest is required")

ErrOCIRefRequired is returned when none of tag, semver, or digest is specified for OCI repository.

Functions

This section is empty.

Types

type Client

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

Client wraps flux API functionality.

func NewClient

func NewClient(ioStreams genericiooptions.IOStreams, kubeconfigPath string) *Client

NewClient creates a new flux client instance.

func (*Client) CreateCreateCommand

func (c *Client) CreateCreateCommand(kubeconfigPath string) *cobra.Command

CreateCreateCommand returns the flux create command tree.

Jump to

Keyboard shortcuts

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