flux

package

v0.6.0 Latest Latest Go to latest Published: Jan 17, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubernetes-sigs/e2e-framework

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func CreateGitRepo(gitRepoName, gitRepoURL string, opts ...Option) env.Func
func CreateHelmRelease(name, source, chart string, opts ...Option) env.Func
func CreateHelmRepository(name, url string, opts ...Option) env.Func
func CreateKustomization(kustomizationName, sourceRef string, opts ...Option) env.Func
func DeleteGitRepo(gitRepoName string, opts ...Option) env.Func
func DeleteHelmRelease(name string, opts ...Option) env.Func
func DeleteHelmRepo(name string, opts ...Option) env.Func
func DeleteKustomization(kustomizationName string, opts ...Option) env.Func
func InstallFlux(opts ...Option) env.Func
func UninstallFlux(opts ...Option) env.Func
type Manager
- func New(kubeConfig string) *Manager
- func (m *Manager) WithPath(path string) *Manager
type Option
type Opts
type Source

Constants ¶

View Source

const NoFluxInstallationFoundMsg = "flux needs to be installed within a cluster first"

Variables ¶

This section is empty.

Functions ¶

func CreateGitRepo ¶

func CreateGitRepo(gitRepoName, gitRepoURL string, opts ...Option) env.Func

CreateGitRepo creates a reference to a specific repository, it is a source for Kustomization or HelmRelease

func CreateHelmRelease ¶ added in v0.4.0

func CreateHelmRelease(name, source, chart string, opts ...Option) env.Func

CreateHelmRelease is used to point to a specific source (e.g. HelmRepository). The chart parameter is a combination of chart name and path. Chart values could be provided via opts.

func CreateHelmRepository ¶ added in v0.4.0

func CreateHelmRepository(name, url string, opts ...Option) env.Func

CreateHelmRepository is used to create a reference to helm repository with charts, it is a source for HelmRelease

func CreateKustomization ¶

func CreateKustomization(kustomizationName, sourceRef string, opts ...Option) env.Func

CreateKustomization is used to point to a specific source and path for reconciliation

func DeleteGitRepo ¶

func DeleteGitRepo(gitRepoName string, opts ...Option) env.Func

DeleteGitRepo removes a specific GitRepository object from the cluster

func DeleteHelmRelease ¶ added in v0.4.0

func DeleteHelmRelease(name string, opts ...Option) env.Func

DeleteHelmRelease removes a specific HelmRelease object from the cluster

func DeleteHelmRepo ¶ added in v0.4.0

func DeleteHelmRepo(name string, opts ...Option) env.Func

DeleteHelmRepo removes a specific HelmRepository object from the cluster

func DeleteKustomization ¶

func DeleteKustomization(kustomizationName string, opts ...Option) env.Func

DeleteKustomization removes a specific Kustomization object from the cluster

func InstallFlux ¶

func InstallFlux(opts ...Option) env.Func

InstallFlux installs all flux components into the cluster. It is possible to specify a target namespace with flux.WithNamespace(). Default namespace is 'flux-system'

func UninstallFlux ¶

func UninstallFlux(opts ...Option) env.Func

UninstallFlux removes all flux components from a cluster

Types ¶

type Manager ¶

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

func New ¶

func New(kubeConfig string) *Manager

func (*Manager) WithPath ¶

func (m *Manager) WithPath(path string) *Manager

WithPath is used to provide a custom path where the `flux` executable command can be found

type Option ¶

type Option func(*Opts)

func WithArgs ¶

func WithArgs(args ...string) Option

WithArgs is used to pass any additional parameter to Flux command

func WithBranch ¶

func WithBranch(branch string) Option

WithBranch is used to target a source with a specific branch

func WithCommit ¶

func WithCommit(commit string) Option

WithCommit is used to target a source with a specific commit SHA

func WithInterval ¶

func WithInterval(interval string) Option

WithInterval is used to specify how often flux should check for changes in a source

func WithNamespace ¶

func WithNamespace(namespace string) Option

WithNamespace If present, the namespace scope for this request (default "flux-system")

func WithPath ¶

func WithPath(path string) Option

WithPath is used to specify a path for reconciliation

func WithTag ¶

func WithTag(tag string) Option

WithTag is used to target a source with a specific tag

type Opts ¶

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

type Source ¶

type Source string

const (
	Git    Source = "git"
	Bucket Source = "bucket"
	Helm   Source = "helm"
	Oci    Source = "oci"
)

Source Files ¶

View all Source files

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