config

Documentation

Index

• Variables
• type Config
  • func NewConfig(client kubernetes.Interface) (*Config, error)
  • func (gc *Config) AppDefaultSyncPeriod() time.Duration
  • func (gc *Config) AppMinimumSyncPeriod() time.Duration
  • func (gc *Config) CACerts() string
  • func (gc *Config) KappDeployRawOptions() []string
  • func (gc *Config) PackageInstallDefaultSyncPeriod() time.Duration
  • func (gc *Config) ProxyOpts() ProxyOpts
  • func (gc *Config) Reload() error
  • func (gc *Config) ShouldSkipTLSForAuthority(candidateAuthority string) bool
• type OSConfig
• type ProxyOpts
• type Reconciler
  • func NewReconciler(coreClient kubernetes.Interface, config *Config, osConfig OSConfig, ...) *Reconciler
  • func (r *Reconciler) AttachWatches(controller controller.Controller, ns string, mgr manager.Manager) error
  • func (r *Reconciler) Reconcile(_ context.Context, request reconcile.Request) (reconcile.Result, error)

Variables

var (
	Scheme = scheme.Scheme
)

Types

type Config

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

Config is populated from the cluster's Secret or ConfigMap and sets behavior of kapp-controller. NOTE because config may be populated from a Secret use caution if you're tempted to serialize.

func NewConfig

func NewConfig(client kubernetes.Interface) (*Config, error)

NewConfig populates the Config struct from k8s resources. NewConfig prefers a secret named kcConfigName but if that does not exist falls back to a configMap of same name.

func (*Config) AppDefaultSyncPeriod

func (gc *Config) AppDefaultSyncPeriod() time.Duration

AppDefaultSyncPeriod returns duration that is used by Apps that do not explicitly specify sync period.

func (*Config) AppMinimumSyncPeriod

func (gc *Config) AppMinimumSyncPeriod() time.Duration

AppMinimumSyncPeriod returns duration that is used as a lowest sync period App would use for reconciliation. This value takes precedence over any sync period that is lower.

func (*Config) CACerts

func (gc *Config) CACerts() string

CACerts returns configured CA certificates in PEM format.

func (*Config) KappDeployRawOptions

func (gc *Config) KappDeployRawOptions() []string

KappDeployRawOptions returns user configured kapp raw options

func (*Config) PackageInstallDefaultSyncPeriod

func (gc *Config) PackageInstallDefaultSyncPeriod() time.Duration

PackageInstallDefaultSyncPeriod returns duration that is used by Apps that do not explicitly specify sync period.

func (*Config) ProxyOpts

func (gc *Config) ProxyOpts() ProxyOpts

ProxyOpts returns configured proxy configuration.

func (*Config) Reload

func (gc *Config) Reload() error

Reload reloads configuration (proxy, CA certs, etc.) from ConfigMap/Secret. All configuration is cleared if ConfigMap or Secret are not found.

func (*Config) ShouldSkipTLSForAuthority

func (gc *Config) ShouldSkipTLSForAuthority(candidateAuthority string) bool

ShouldSkipTLSForAuthority compares a candidate host or host:port against a stored set of allow-listed authorities. the allow-list is built from the user-facing flag `dangerousSkipTLSVerify`. Note that in some cases the allow-list may contain ports, so the function name could also be ShouldSkipTLSForDomainAndPort Note that "authority" is defined in: https://www.rfc-editor.org/rfc/rfc3986#section-3 to mean "host and port"

type OSConfig

type OSConfig interface {
	ApplyCACerts(string) error
	ApplyProxy(ProxyOpts) error
}

OSConfig configures runtime environment with necessary CA certificates and proxy configuration.

type ProxyOpts

type ProxyOpts struct {
	HTTPProxy  string
	HTTPSProxy string
	NoProxy    string
}

ProxyOpts contains proxy configuration for the system.

type Reconciler

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

Reconciler is responsible for reconciling kapp-controllers config.

func NewReconciler

func NewReconciler(coreClient kubernetes.Interface,
	config *Config, osConfig OSConfig, log logr.Logger) *Reconciler

NewReconciler constructs new Reconciler.

func (*Reconciler) AttachWatches

func (r *Reconciler) AttachWatches(controller controller.Controller, ns string, mgr manager.Manager) error

AttachWatches configures watches needed for reconciler to reconcile the kapp-controller Config.

func (*Reconciler) Reconcile

func (r *Reconciler) Reconcile(_ context.Context, request reconcile.Request) (reconcile.Result, error)

Reconcile gets the current config from the cluster and applies any changes.