option

Documentation

Index

• Constants
• Variables
• type CertGenConfig
  • func (c *CertGenConfig) PopulateFrom(vp *viper.Viper)
• type CertificateConfig
• type CertificateConfigs

Constants

const (
	// Debug enables debug messages.
	Debug = "debug"

	// K8sKubeConfigPath is the path to the kubeconfig If empty, the in-cluster
	// configuration is used.
	K8sKubeConfigPath = "k8s-kubeconfig-path"
	// K8sRequestTimeout specifies the timeout for K8s API requests.
	K8sRequestTimeout = "k8s-request-timeout"

	// CACertFile is the path to the CA cert PEM (if CAGenerate is false).
	CACertFile = "ca-cert-file"
	// CAKeyFile is the path to the CA key PEM (if CAGenerate is false).
	CAKeyFile = "ca-key-file"

	// CAGenerate can be set to true to generate a new CA secret.
	// If CAReuseSecret is true, then a new CA secret is only created if an
	// existing one is not found.
	CAGenerate = "ca-generate"
	// CAReuseSecret can be set to true to store and load the CA from
	// the secret if it exists. Setting to false will delete the old Secret and
	// force regeneration.
	CAReuseSecret = "ca-reuse-secret" //#nosec
	// CACommonName is the CA x509 certificate CN value.
	CACommonName = "ca-common-name"
	// CAValidityDuration represent how much time the CA certificate
	// generated by certgen is valid.
	CAValidityDuration = "ca-validity-duration"
	// CASecretName is the Kubernetes Secret in which the CA certificate
	// is read from and/or written to.
	CASecretName = "ca-secret-name"
	// CASecretNamespace is the Kubernetes Namespace in which the CA
	// Secret will be stored.
	CASecretNamespace = "ca-secret-namespace"

	// CertsConfig is the configuration describing the certificates to generate.
	// It takes precedence over config-file if both are specified.
	CertsConfig = "config"

	// CertsConfigFile is the file containing the configuration describing the
	// certificates to generate.
	CertsConfigFile = "config-file"
)

Variables

var Config = &CertGenConfig{}

Config is the main configuration as obtained from command-line arguments, environment variables and config files.

Types

type CertGenConfig

type CertGenConfig struct {
	// Debug enables debug messages.
	Debug bool

	// K8sKubeConfigPath is the path to the kubeconfig If empty, the in-cluster
	// configuration is used.
	K8sKubeConfigPath string
	// K8sRequestTimeout specifies the timeout for K8s API requests
	K8sRequestTimeout time.Duration

	// CACertFile is the path to the CA cert PEM (if CAGenerate is false).
	CACertFile string
	// CAKeyFile is the path to the CA key PEM (if CAGenerate is false).
	CAKeyFile string

	// CAGenerate can be set to true to generate a new CA secret.  If
	// CAReuseSecret is true, then a new CA secret only is created if existing
	// one is not found.
	CAGenerate bool
	// CAReuseSecret can be set to true to store and load the CA from
	// the secret if it exists. Setting to false will delete the old Secret and
	// force regeneration.
	CAReuseSecret bool
	// CACommonName is the CA x509 certificate CN value.
	CACommonName string
	// CAValidityDuration represent how much time the CA certificate
	// generated by certgen is valid.
	CAValidityDuration time.Duration
	// CASecretName is the Kubernetes Secret in which the CA certificate
	// is read from and/or written to.
	CASecretName string
	// CASecretNamespace is the Kubernetes Namespace in which the CA
	// Secret will be stored.
	CASecretNamespace string

	// CertsConfig is the yaml configuration describing the certificates to
	// generate. It takes precedence over config-file if both are specified.
	CertsConfig string
	// CertsConfigFile is the file containing the yaml configuration describing
	// the certificates to generate.
	CertsConfigFile string
}

CertGenConfig contains the main configuration options

func (*CertGenConfig) PopulateFrom

func (c *CertGenConfig) PopulateFrom(vp *viper.Viper)

PopulateFrom populates the config struct with the values provided by vp

type CertificateConfig

type CertificateConfig struct {
	Name       string        `yaml:"name"`
	Namespace  string        `yaml:"namespace"`
	CommonName string        `yaml:"commonName"`
	Hosts      []string      `yaml:"hosts"`
	Usage      []string      `yaml:"usage"`
	Validity   time.Duration `yaml:"validity"`
}

type CertificateConfigs

type CertificateConfigs struct {
	Certs []CertificateConfig `yaml:"certs"`
}