kubelego

Documentation

Index

• Constants
• Variables
• type Acme
• type Ingress
• type IngressProvider
• type KubeLego
• type Secret
• type Service
• type Tls

Constants

const AcmeHttpChallengePath = "/.well-known/acme-challenge"

const AcmeHttpSelfTest = "/.well-known/acme-challenge/_selftest"

const AcmePrivateKey = k8sApi.TLSPrivateKeyKey

const AcmeRegistration = "acme-registration.json"

const AcmeRegistrationUrl = "acme-registration-url"

const AnnotationIngressChallengeEndpoints = "kubernetes.io/tls-acme-challenge-endpoints"

const AnnotationIngressChallengeEndpointsHash = "kubernetes.io/tls-acme-challenge-endpoints-hash"

const AnnotationIngressClass = "kubernetes.io/ingress.class"

const AnnotationIngressProvider = "kubernetes.io/ingress.provider"

const AnnotationKubeLegoManaged = "kubernetes.io/kube-lego-managed"

const AnnotationSslRedirect = "ingress.kubernetes.io/ssl-redirect"

const AnnotationWhitelistSourceRange = "ingress.kubernetes.io/whitelist-source-range"

const DefaultRsaKeySize = 2048

const TLSCaKey = "ca.crt"

const TLSCertKey = k8sApi.TLSCertKey

const TLSPrivateKeyKey = k8sApi.TLSPrivateKeyKey

Variables

var AnnotationEnabled = "kubernetes.io/tls-acme"

var LegoServiceSelector = "kube-lego"

var SupportedIngressClasses = []string{"nginx", "gce"}

var SupportedIngressProviders = []string{"nginx", "gce"}

Types

type Acme

type Acme interface {
	ObtainCertificate(domains []string) (map[string][]byte, error)
}

type Ingress

type Ingress interface {
	Object() *k8sExtensions.Ingress
	KubeLego() KubeLego
	Log() *logrus.Entry
	Save() error
	Delete() error
	IngressClass() string
	IngressProvider() string
	Tls() []Tls
	Ignore() bool
}

type IngressProvider

type IngressProvider interface {
	Log() *logrus.Entry
	Process(Ingress) error
	Reset() error
	Finalize() error
}

type KubeLego

type KubeLego interface {
	KubeClient() *kubernetes.Clientset
	Log() *logrus.Entry
	AcmeClient() Acme
	LegoHTTPPort() intstr.IntOrString
	LegoEmail() string
	LegoURL() string
	LegoNamespace() string
	LegoWatchNamespace() string
	LegoIngressNameNginx() string
	LegoServiceNameNginx() string
	LegoServiceNameGce() string
	LegoDefaultIngressClass() string
	LegoDefaultIngressProvider() string
	LegoSupportedIngressClass() []string
	LegoSupportedIngressProvider() []string
	LegoCheckInterval() time.Duration
	LegoMinimumValidity() time.Duration
	ExponentialBackoffMaxElapsedTime() time.Duration
	ExponentialBackoffInitialInterval() time.Duration
	ExponentialBackoffMultiplier() float64
	LegoPodIP() net.IP
	LegoRsaKeySize() int
	IngressProvider(string) (IngressProvider, error)
	Version() string
	AcmeUser() (map[string][]byte, error)
	SaveAcmeUser(map[string][]byte) error
}

type Secret

type Secret interface {
	Object() *k8sApi.Secret
	KubeLego() KubeLego
	Exists() bool
	Save() error
	TlsDomains() ([]string, error)
	TlsDomainsInclude(domains []string) bool
	TlsExpireTime() (time.Time, error)
}

type Service

type Service interface {
	Object() *k8sApi.Service
	SetKubeLegoSpec()
	SetEndpoints([]string) error
	Save() error
	Delete() error
}

type Tls

type Tls interface {
	Hosts() []string
	SecretMetadata() *k8sApi.ObjectMeta
	IngressMetadata() *k8sApi.ObjectMeta
	Process() error
}