options

Documentation

Overview

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Index

• Constants
• type AuditOptions
  • func NewAuditOptions(nfs *cliflag.NamedFlagSets) *AuditOptions
  • func (a *AuditOptions) AddFlags(fs *pflag.FlagSet) *AuditOptions
• type ClientOptions
  • func NewClientOptions(nfs *cliflag.NamedFlagSets) *ClientOptions
  • func (c *ClientOptions) AddFlags(fs *pflag.FlagSet) *ClientOptions
  • func (c *ClientOptions) ClientFlagsChanged(cmd *cobra.Command) bool
• type ExtraHeaderOptions
  • func (e *ExtraHeaderOptions) AddFlags(fs *pflag.FlagSet)
• type KubeOIDCProxyOptions
  • func NewKubeOIDCProxyOptions(nfs *cliflag.NamedFlagSets) *KubeOIDCProxyOptions
  • func (k *KubeOIDCProxyOptions) AddFlags(fs *pflag.FlagSet) *KubeOIDCProxyOptions
• type MiscOptions
  • func NewMiscOptions(nfs *cliflag.NamedFlagSets) *MiscOptions
  • func (m *MiscOptions) AddFlags(fs *pflag.FlagSet) *MiscOptions
  • func (m *MiscOptions) PrintVersionAndExit()
• type OIDCAuthenticationOptions
  • func NewOIDCAuthenticationOptions(nfs *cliflag.NamedFlagSets) *OIDCAuthenticationOptions
  • func (o *OIDCAuthenticationOptions) AddFlags(fs *pflag.FlagSet) *OIDCAuthenticationOptions
  • func (o *OIDCAuthenticationOptions) Validate() error
• type Options
  • func New() *Options
  • func (o *Options) AddFlags(cmd *cobra.Command)
  • func (o *Options) Validate(cmd *cobra.Command) error
• type SecureServingOptions
  • func NewSecureServingOptions(nfs *cliflag.NamedFlagSets) *SecureServingOptions
  • func (s *SecureServingOptions) AddFlags(fs *pflag.FlagSet) *SecureServingOptions
• type TokenPassthroughOptions
  • func (t *TokenPassthroughOptions) AddFlags(fs *pflag.FlagSet)

Constants

const (
	AppName = "kube-oidc-proxy"
)

Types

type AuditOptions

type AuditOptions struct {
	*apiserveroptions.AuditOptions
}

func NewAuditOptions

func NewAuditOptions(nfs *cliflag.NamedFlagSets) *AuditOptions

func (*AuditOptions) AddFlags

func (a *AuditOptions) AddFlags(fs *pflag.FlagSet) *AuditOptions

type ClientOptions

type ClientOptions struct {
	*genericclioptions.ConfigFlags
}

func NewClientOptions

func NewClientOptions(nfs *cliflag.NamedFlagSets) *ClientOptions

func (*ClientOptions) AddFlags

func (c *ClientOptions) AddFlags(fs *pflag.FlagSet) *ClientOptions

func (*ClientOptions) ClientFlagsChanged

func (c *ClientOptions) ClientFlagsChanged(cmd *cobra.Command) bool

type ExtraHeaderOptions

type ExtraHeaderOptions struct {
	EnableClientIPExtraUserHeader bool

	ExtraUserHeaders map[string][]string
}

func (*ExtraHeaderOptions) AddFlags

func (e *ExtraHeaderOptions) AddFlags(fs *pflag.FlagSet)

type KubeOIDCProxyOptions

type KubeOIDCProxyOptions struct {
	DisableImpersonation bool
	ReadinessProbePort   int

	FlushInterval time.Duration

	ExtraHeaderOptions ExtraHeaderOptions
	TokenPassthrough   TokenPassthroughOptions
}

func NewKubeOIDCProxyOptions

func NewKubeOIDCProxyOptions(nfs *cliflag.NamedFlagSets) *KubeOIDCProxyOptions

func (*KubeOIDCProxyOptions) AddFlags

func (k *KubeOIDCProxyOptions) AddFlags(fs *pflag.FlagSet) *KubeOIDCProxyOptions

type MiscOptions

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

func NewMiscOptions

func NewMiscOptions(nfs *cliflag.NamedFlagSets) *MiscOptions

func (*MiscOptions) AddFlags

func (m *MiscOptions) AddFlags(fs *pflag.FlagSet) *MiscOptions

func (*MiscOptions) PrintVersionAndExit

func (m *MiscOptions) PrintVersionAndExit()

type OIDCAuthenticationOptions

type OIDCAuthenticationOptions struct {
	CAFile         string
	ClientID       string
	IssuerURL      string
	UsernameClaim  string
	UsernamePrefix string
	GroupsClaim    string
	GroupsPrefix   string
	SigningAlgs    []string
	RequiredClaims map[string]string
}

func NewOIDCAuthenticationOptions

func NewOIDCAuthenticationOptions(nfs *cliflag.NamedFlagSets) *OIDCAuthenticationOptions

func (*OIDCAuthenticationOptions) AddFlags

func (o *OIDCAuthenticationOptions) AddFlags(fs *pflag.FlagSet) *OIDCAuthenticationOptions

func (*OIDCAuthenticationOptions) Validate

func (o *OIDCAuthenticationOptions) Validate() error

type Options

type Options struct {
	App                *KubeOIDCProxyOptions
	OIDCAuthentication *OIDCAuthenticationOptions
	SecureServing      *SecureServingOptions
	Audit              *AuditOptions
	Client             *ClientOptions
	Misc               *MiscOptions
	// contains filtered or unexported fields
}

func New

func New() *Options

func (*Options) AddFlags

func (o *Options) AddFlags(cmd *cobra.Command)

func (*Options) Validate

func (o *Options) Validate(cmd *cobra.Command) error

type SecureServingOptions

type SecureServingOptions struct {
	*apiserveroptions.SecureServingOptions
}

func NewSecureServingOptions

func NewSecureServingOptions(nfs *cliflag.NamedFlagSets) *SecureServingOptions

func (*SecureServingOptions) AddFlags

func (s *SecureServingOptions) AddFlags(fs *pflag.FlagSet) *SecureServingOptions

type TokenPassthroughOptions

type TokenPassthroughOptions struct {
	Audiences []string
	Enabled   bool
}

func (*TokenPassthroughOptions) AddFlags

func (t *TokenPassthroughOptions) AddFlags(fs *pflag.FlagSet)