client

Documentation

Index

• Variables
• type ActionClientGetter
  • func NewActionClientGetter(acg ActionConfigGetter, opts ...ActionClientGetterOption) (ActionClientGetter, error)
• type ActionClientGetterFunc
  • func (acgf ActionClientGetterFunc) ActionClientFor(ctx context.Context, obj client.Object) (ActionInterface, error)
• type ActionClientGetterOption
  • func AppendGetOptions(opts ...GetOption) ActionClientGetterOption
  • func AppendInstallFailureUninstallOptions(opts ...UninstallOption) ActionClientGetterOption
  • func AppendInstallOptions(opts ...InstallOption) ActionClientGetterOption
  • func AppendPostRenderers(postRendererFns ...PostRendererProvider) ActionClientGetterOption
  • func AppendUninstallOptions(opts ...UninstallOption) ActionClientGetterOption
  • func AppendUpgradeFailureRollbackOptions(opts ...RollbackOption) ActionClientGetterOption
  • func AppendUpgradeOptions(opts ...UpgradeOption) ActionClientGetterOption
• type ActionConfigGetter
  • func NewActionConfigGetter(baseRestConfig *rest.Config, rm meta.RESTMapper, ...) (ActionConfigGetter, error)
• type ActionConfigGetterOption
  • func ClientNamespaceMapper(m ObjectToStringMapper) ActionConfigGetterOption
  • func DisableStorageOwnerRefInjection(v bool) ActionConfigGetterOption
  • func RestConfigMapper(f func(context.Context, client.Object, *rest.Config) (*rest.Config, error)) ActionConfigGetterOption
  • func StorageNamespaceMapper(m ObjectToStringMapper) ActionConfigGetterOption
• type ActionInterface
• type GetOption
• type InstallOption
  • func AppendInstallPostRenderer(pr postrender.PostRenderer) InstallOption
  • func WithInstallPostRenderer(pr postrender.PostRenderer) InstallOption
• type ObjectToStringMapper
• type PostRendererFunc
  • func (f PostRendererFunc) Run(buffer *bytes.Buffer) (*bytes.Buffer, error)
• type PostRendererProvider
• type RollbackOption
• type UninstallOption
• type UpgradeOption
  • func AppendUpgradePostRenderer(pr postrender.PostRenderer) UpgradeOption
  • func WithUpgradePostRenderer(pr postrender.PostRenderer) UpgradeOption

Variables

var DefaultPostRendererFunc = func(rm meta.RESTMapper, kubeClient kube.Interface, owner client.Object) postrender.PostRenderer {
	return &ownerPostRenderer{rm, kubeClient, owner}
}

DefaultPostRendererFunc returns a post-renderer that applies owner references to compatible objects in a helm release manifest. This is the default post-renderer used by ActionClients created with NewActionClientGetter.

Types

type ActionClientGetter

type ActionClientGetter interface {
	ActionClientFor(ctx context.Context, obj client.Object) (ActionInterface, error)
}

func NewActionClientGetter

func NewActionClientGetter(acg ActionConfigGetter, opts ...ActionClientGetterOption) (ActionClientGetter, error)

type ActionClientGetterFunc

type ActionClientGetterFunc func(ctx context.Context, obj client.Object) (ActionInterface, error)

func (ActionClientGetterFunc) ActionClientFor

func (acgf ActionClientGetterFunc) ActionClientFor(ctx context.Context, obj client.Object) (ActionInterface, error)

type ActionClientGetterOption

type ActionClientGetterOption func(*actionClientGetter) error

func AppendGetOptions

func AppendGetOptions(opts ...GetOption) ActionClientGetterOption

func AppendInstallFailureUninstallOptions

func AppendInstallFailureUninstallOptions(opts ...UninstallOption) ActionClientGetterOption

func AppendInstallOptions

func AppendInstallOptions(opts ...InstallOption) ActionClientGetterOption

func AppendPostRenderers

func AppendPostRenderers(postRendererFns ...PostRendererProvider) ActionClientGetterOption

func AppendUninstallOptions

func AppendUninstallOptions(opts ...UninstallOption) ActionClientGetterOption

func AppendUpgradeFailureRollbackOptions

func AppendUpgradeFailureRollbackOptions(opts ...RollbackOption) ActionClientGetterOption

func AppendUpgradeOptions

func AppendUpgradeOptions(opts ...UpgradeOption) ActionClientGetterOption

type ActionConfigGetter

type ActionConfigGetter interface {
	ActionConfigFor(ctx context.Context, obj client.Object) (*action.Configuration, error)
}

func NewActionConfigGetter

func NewActionConfigGetter(baseRestConfig *rest.Config, rm meta.RESTMapper, opts ...ActionConfigGetterOption) (ActionConfigGetter, error)

type ActionConfigGetterOption

type ActionConfigGetterOption func(getter *actionConfigGetter)

func ClientNamespaceMapper

func ClientNamespaceMapper(m ObjectToStringMapper) ActionConfigGetterOption

func DisableStorageOwnerRefInjection

func DisableStorageOwnerRefInjection(v bool) ActionConfigGetterOption

func RestConfigMapper

func RestConfigMapper(f func(context.Context, client.Object, *rest.Config) (*rest.Config, error)) ActionConfigGetterOption

func StorageNamespaceMapper

func StorageNamespaceMapper(m ObjectToStringMapper) ActionConfigGetterOption

type ActionInterface

type ActionInterface interface {
	Get(name string, opts ...GetOption) (*release.Release, error)
	Install(name, namespace string, chrt *chart.Chart, vals map[string]interface{}, opts ...InstallOption) (*release.Release, error)
	Upgrade(name, namespace string, chrt *chart.Chart, vals map[string]interface{}, opts ...UpgradeOption) (*release.Release, error)
	Uninstall(name string, opts ...UninstallOption) (*release.UninstallReleaseResponse, error)
	Reconcile(rel *release.Release) error
}

type GetOption

type GetOption func(*action.Get) error

type InstallOption

type InstallOption func(*action.Install) error

func AppendInstallPostRenderer

func AppendInstallPostRenderer(pr postrender.PostRenderer) InstallOption

AppendInstallPostRenderer appends a post-renderer to the existing chain of post-renderers configured for the install. This function should be used instead of WithInstallPostRenderer if you want to inherit the default set of post-renderers configured by an ActionClientGetter.

func WithInstallPostRenderer

func WithInstallPostRenderer(pr postrender.PostRenderer) InstallOption

WithInstallPostRenderer sets the post-renderer to use for the install. It overrides any post-renderer that may already be configured or set as a default.

type ObjectToStringMapper

type ObjectToStringMapper func(client.Object) (string, error)

type PostRendererFunc

type PostRendererFunc func(buffer *bytes.Buffer) (*bytes.Buffer, error)

PostRendererFunc defines a function signature that implements helm's PostRenderer interface.

func (PostRendererFunc) Run

func (f PostRendererFunc) Run(buffer *bytes.Buffer) (*bytes.Buffer, error)

Run runs the post-renderer function.

type PostRendererProvider

type PostRendererProvider func(rm meta.RESTMapper, kubeClient kube.Interface, obj client.Object) postrender.PostRenderer

PostRendererProvider is a function that returns a post-renderer for a given object. obj represents the custom resource that is being reconciled.

type RollbackOption

type RollbackOption func(*action.Rollback) error

type UninstallOption

type UninstallOption func(*action.Uninstall) error

type UpgradeOption

type UpgradeOption func(*action.Upgrade) error

func AppendUpgradePostRenderer

func AppendUpgradePostRenderer(pr postrender.PostRenderer) UpgradeOption

AppendUpgradePostRenderer appends a post-renderer to the existing chain of post-renderers configured for the upgrade. This function should be used instead of WithUpgradePostRenderer if you want to inherit the default set of post-renderers configured by an ActionClientGetter.

func WithUpgradePostRenderer

func WithUpgradePostRenderer(pr postrender.PostRenderer) UpgradeOption

WithUpgradePostRenderer sets the post-renderer to use for the upgrade. It overrides any post-renderer that may already be configured or set as a default.