transip

Documentation

Index

• func NewSolver() webhook.Solver
• type Client
• type ClientConfiguration
• type Config
  • func (c Config) String() string
• type Solver
  • func (s *Solver) CleanUp(ch *acme.ChallengeRequest) error
  • func (s *Solver) Initialize(kubeClientConfig *rest.Config, stopCh <-chan struct{}) error
  • func (c *Solver) Name() string
  • func (s *Solver) Present(ch *acme.ChallengeRequest) error

Functions

func NewSolver

func NewSolver() webhook.Solver

Types

type Client

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

type ClientConfiguration

type ClientConfiguration struct {
	AccountName string
	PrivateKey  []byte
	DryRun      bool
}

type Config

type Config struct {
	SecretRef           core.SecretReference   `json:"secretRef"`
	AccountName         string                 `json:"accountName"`
	PrivateKey          []byte                 `json:"privateKey"`
	PrivateKeySecretRef core.SecretKeySelector `json:"privateKeySecretRef"`
	TTL                 int                    `json:"ttl"`
	DryRun              bool                   `json:"dryRun"`
}

Config is a structure that is used to decode into when solving a DNS01 challenge. This information is provided by cert-manager, and may be a reference to additional configuration that's needed to solve the challenge for this particular certificate or issuer.

func (Config) String

func (c Config) String() string

type Solver

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

Solver implements the provider-specific logic needed to 'present' an ACME challenge TXT record for your own DNS provider. To do so, it must implement the `github.com/cert-manager/cert-manager/pkg/acme/webhook.Solver` interface.

func (*Solver) CleanUp

func (s *Solver) CleanUp(ch *acme.ChallengeRequest) error

CleanUp should delete the relevant TXT record from the DNS provider console. If multiple TXT records exist with the same record name (e.g. _acme-challenge.example.com) then **only** the record with the same `key` value provided on the ChallengeRequest should be cleaned up. This is in order to facilitate multiple DNS validations for the same domain concurrently.

func (*Solver) Initialize

func (s *Solver) Initialize(kubeClientConfig *rest.Config, stopCh <-chan struct{}) error

Initialize will be called when the webhook first starts. This method can be used to instantiate the webhook, i.e. initializing connections or warming up caches. Typically, the kubeClientConfig parameter is used to build a Kubernetes client that can be used to fetch resources from the Kubernetes API, e.g. Secret resources containing credentials used to authenticate with DNS provider accounts. The stopCh can be used to handle early termination of the webhook, in cases where a SIGTERM or similar signal is sent to the webhook process.

func (*Solver) Name

func (c *Solver) Name() string

Name is used as the name for this DNS solver when referencing it on the ACME Issuer resource. This should be unique **within the group name**, i.e. you can have two solvers configured with the same Name() **so long as they do not co-exist within a single webhook deployment**. For example, `cloudflare` may be used as the name of a solver.

func (*Solver) Present

func (s *Solver) Present(ch *acme.ChallengeRequest) error

Present is responsible for actually presenting the DNS record with the DNS provider. This method should tolerate being called multiple times with the same value. cert-manager itself will later perform a self check to ensure that the solver has correctly configured the DNS provider.