webhook

Documentation

Overview

Package webhook provides a library that can be used to build external ACME solver webhooks.

Index

• type Solver

Types

type Solver

type Solver interface {
	// Name is the name of this ACME solver as part of the API group.
	// This must match what you configure in the ACME Issuer's DNS01 config.
	Name() string

	// Present should 'present' the ACME challenge solving parameters as
	// defined in the given challenge resource.
	// TODO: add notes about duplicate records with DNS01
	Present(ch *whapi.ChallengeRequest) error

	// CleanUp should remove any presented challenge records for the given
	// challenge resource
	// TODO: add notes about duplicate records with DNS01
	CleanUp(ch *whapi.ChallengeRequest) error

	// Initialize is called as a post-start hook when the apiserver starts.
	// https://github.com/kubernetes/apiserver/blob/release-1.26/pkg/server/hooks.go#L32-L42
	Initialize(kubeClientConfig *restclient.Config, stopCh <-chan struct{}) error
}

Solver has the functionality to solve ACME challenges. This interface is implemented internally by RFC2136 DNS provider and by external webhook solver implementations see https://github.com/cert-manager/webhook-example