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 AnnotationEnabled = "kubernetes.io/tls-acme"

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

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

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

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

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

const RsaKeySize = 2048

const TLSCaKey = "ca.crt"

const TLSCertKey = k8sApi.TLSCertKey

const TLSPrivateKeyKey = k8sApi.TLSPrivateKeyKey

Variables

var SupportedIngressClasses = []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
	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() *k8sClient.Client
	Log() *logrus.Entry
	AcmeClient() Acme
	LegoHTTPPort() intstr.IntOrString
	LegoEmail() string
	LegoURL() string
	LegoNamespace() string
	LegoIngressNameNginx() string
	LegoServiceNameNginx() string
	LegoServiceNameGce() string
	LegoDefaultIngressClass() string
	LegoCheckInterval() time.Duration
	LegoMinimumValidity() time.Duration
	LegoPodIP() net.IP
	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
}