mirror of
https://github.com/wahyd4/cert-manager.git
synced 2026-08-19 01:56:11 +10:00
311 lines
16 KiB
Go
311 lines
16 KiB
Go
/*
|
|
Copyright 2019 The Jetstack cert-manager contributors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package options
|
|
|
|
import (
|
|
"fmt"
|
|
"net"
|
|
"time"
|
|
|
|
"github.com/spf13/pflag"
|
|
|
|
cm "github.com/jetstack/cert-manager/pkg/apis/certmanager"
|
|
cmapi "github.com/jetstack/cert-manager/pkg/apis/certmanager/v1alpha2"
|
|
challengescontroller "github.com/jetstack/cert-manager/pkg/controller/acmechallenges"
|
|
orderscontroller "github.com/jetstack/cert-manager/pkg/controller/acmeorders"
|
|
cracmecontroller "github.com/jetstack/cert-manager/pkg/controller/certificaterequests/acme"
|
|
crcacontroller "github.com/jetstack/cert-manager/pkg/controller/certificaterequests/ca"
|
|
crselfsignedcontroller "github.com/jetstack/cert-manager/pkg/controller/certificaterequests/selfsigned"
|
|
crvaultcontroller "github.com/jetstack/cert-manager/pkg/controller/certificaterequests/vault"
|
|
crvenaficontroller "github.com/jetstack/cert-manager/pkg/controller/certificaterequests/venafi"
|
|
certificatescontroller "github.com/jetstack/cert-manager/pkg/controller/certificates"
|
|
clusterissuerscontroller "github.com/jetstack/cert-manager/pkg/controller/clusterissuers"
|
|
ingressshimcontroller "github.com/jetstack/cert-manager/pkg/controller/ingress-shim"
|
|
issuerscontroller "github.com/jetstack/cert-manager/pkg/controller/issuers"
|
|
"github.com/jetstack/cert-manager/pkg/controller/webhookbootstrap"
|
|
"github.com/jetstack/cert-manager/pkg/util"
|
|
)
|
|
|
|
type ControllerOptions struct {
|
|
APIServerHost string
|
|
Kubeconfig string
|
|
ClusterResourceNamespace string
|
|
Namespace string
|
|
|
|
LeaderElect bool
|
|
LeaderElectionNamespace string
|
|
LeaderElectionLeaseDuration time.Duration
|
|
LeaderElectionRenewDeadline time.Duration
|
|
LeaderElectionRetryPeriod time.Duration
|
|
|
|
EnabledControllers []string
|
|
|
|
ACMEHTTP01SolverImage string
|
|
ACMEHTTP01SolverResourceRequestCPU string
|
|
ACMEHTTP01SolverResourceRequestMemory string
|
|
ACMEHTTP01SolverResourceLimitsCPU string
|
|
ACMEHTTP01SolverResourceLimitsMemory string
|
|
|
|
ClusterIssuerAmbientCredentials bool
|
|
IssuerAmbientCredentials bool
|
|
RenewBeforeExpiryDuration time.Duration
|
|
|
|
// Default issuer/certificates details consumed by ingress-shim
|
|
DefaultIssuerName string
|
|
DefaultIssuerKind string
|
|
DefaultIssuerGroup string
|
|
DefaultAutoCertificateAnnotations []string
|
|
|
|
// Allows specifying a list of custom nameservers to perform DNS checks on.
|
|
DNS01RecursiveNameservers []string
|
|
// Allows controlling if recursive nameservers are only used for all checks.
|
|
// Normally authoritative nameservers are used for checking propagation.
|
|
DNS01RecursiveNameserversOnly bool
|
|
|
|
EnableCertificateOwnerRef bool
|
|
|
|
MaxConcurrentChallenges int
|
|
|
|
// Namespace is the namespace the webhook CA and serving secret will be
|
|
// created in.
|
|
// If not specified, it will default to the same namespace as cert-manager.
|
|
WebhookNamespace string
|
|
|
|
// CASecretName is the name of the secret containing the webhook's root CA
|
|
WebhookCASecretName string
|
|
|
|
// ServingSecretName is the name of the secret containing the webhook's
|
|
// serving certificate
|
|
WebhookServingSecretName string
|
|
|
|
// DNSNames are the dns names that should be set on the serving certificate
|
|
WebhookDNSNames []string
|
|
}
|
|
|
|
const (
|
|
defaultAPIServerHost = ""
|
|
defaultKubeconfig = ""
|
|
defaultClusterResourceNamespace = "kube-system"
|
|
defaultNamespace = ""
|
|
|
|
defaultLeaderElect = true
|
|
defaultLeaderElectionNamespace = "kube-system"
|
|
defaultLeaderElectionLeaseDuration = 60 * time.Second
|
|
defaultLeaderElectionRenewDeadline = 40 * time.Second
|
|
defaultLeaderElectionRetryPeriod = 15 * time.Second
|
|
|
|
defaultClusterIssuerAmbientCredentials = true
|
|
defaultIssuerAmbientCredentials = false
|
|
defaultRenewBeforeExpiryDuration = cmapi.DefaultRenewBefore
|
|
|
|
defaultTLSACMEIssuerName = ""
|
|
defaultTLSACMEIssuerKind = "Issuer"
|
|
defaultTLSACMEIssuerGroup = cm.GroupName
|
|
defaultACMEIssuerChallengeType = "http01"
|
|
defaultACMEIssuerDNS01ProviderName = ""
|
|
defaultEnableCertificateOwnerRef = false
|
|
|
|
defaultDNS01RecursiveNameserversOnly = false
|
|
|
|
defaultMaxConcurrentChallenges = 60
|
|
|
|
defaultWebhookNamespace = "cert-manager"
|
|
defaultWebhookCASecretName = "cert-manager-webhook-ca"
|
|
defaultWebhookServingSecretName = "cert-manager-webhook-tls"
|
|
)
|
|
|
|
var (
|
|
defaultWebhookDNSNames = []string{
|
|
"cert-manager-webhook",
|
|
"cert-manager-webhook.cert-manager",
|
|
"cert-manager-webhook.cert-manager.svc",
|
|
"cert-manager-webhook.cert-manager.svc.cluster",
|
|
"cert-manager-webhook.cert-manager.svc.cluster.local",
|
|
}
|
|
)
|
|
|
|
var (
|
|
defaultACMEHTTP01SolverImage = fmt.Sprintf("quay.io/jetstack/cert-manager-acmesolver:%s", util.AppVersion)
|
|
defaultACMEHTTP01SolverResourceRequestCPU = "10m"
|
|
defaultACMEHTTP01SolverResourceRequestMemory = "64Mi"
|
|
defaultACMEHTTP01SolverResourceLimitsCPU = "100m"
|
|
defaultACMEHTTP01SolverResourceLimitsMemory = "64Mi"
|
|
|
|
defaultAutoCertificateAnnotations = []string{"kubernetes.io/tls-acme"}
|
|
|
|
defaultEnabledControllers = []string{
|
|
issuerscontroller.ControllerName,
|
|
clusterissuerscontroller.ControllerName,
|
|
certificatescontroller.ControllerName,
|
|
ingressshimcontroller.ControllerName,
|
|
orderscontroller.ControllerName,
|
|
challengescontroller.ControllerName,
|
|
webhookbootstrap.ControllerName,
|
|
cracmecontroller.CRControllerName,
|
|
crcacontroller.CRControllerName,
|
|
crselfsignedcontroller.CRControllerName,
|
|
crvaultcontroller.CRControllerName,
|
|
crvenaficontroller.CRControllerName,
|
|
certificatescontroller.ControllerName,
|
|
}
|
|
)
|
|
|
|
func NewControllerOptions() *ControllerOptions {
|
|
return &ControllerOptions{
|
|
APIServerHost: defaultAPIServerHost,
|
|
ClusterResourceNamespace: defaultClusterResourceNamespace,
|
|
Namespace: defaultNamespace,
|
|
LeaderElect: defaultLeaderElect,
|
|
LeaderElectionNamespace: defaultLeaderElectionNamespace,
|
|
LeaderElectionLeaseDuration: defaultLeaderElectionLeaseDuration,
|
|
LeaderElectionRenewDeadline: defaultLeaderElectionRenewDeadline,
|
|
LeaderElectionRetryPeriod: defaultLeaderElectionRetryPeriod,
|
|
EnabledControllers: defaultEnabledControllers,
|
|
ClusterIssuerAmbientCredentials: defaultClusterIssuerAmbientCredentials,
|
|
IssuerAmbientCredentials: defaultIssuerAmbientCredentials,
|
|
RenewBeforeExpiryDuration: defaultRenewBeforeExpiryDuration,
|
|
DefaultIssuerName: defaultTLSACMEIssuerName,
|
|
DefaultIssuerKind: defaultTLSACMEIssuerKind,
|
|
DefaultIssuerGroup: defaultTLSACMEIssuerGroup,
|
|
DefaultAutoCertificateAnnotations: defaultAutoCertificateAnnotations,
|
|
DNS01RecursiveNameservers: []string{},
|
|
DNS01RecursiveNameserversOnly: defaultDNS01RecursiveNameserversOnly,
|
|
EnableCertificateOwnerRef: defaultEnableCertificateOwnerRef,
|
|
}
|
|
}
|
|
|
|
func (s *ControllerOptions) AddFlags(fs *pflag.FlagSet) {
|
|
fs.StringVar(&s.APIServerHost, "master", defaultAPIServerHost, ""+
|
|
"Optional apiserver host address to connect to. If not specified, autoconfiguration "+
|
|
"will be attempted.")
|
|
fs.StringVar(&s.Kubeconfig, "kubeconfig", defaultKubeconfig, ""+
|
|
"Paths to a kubeconfig. Only required if out-of-cluster.")
|
|
fs.StringVar(&s.ClusterResourceNamespace, "cluster-resource-namespace", defaultClusterResourceNamespace, ""+
|
|
"Namespace to store resources owned by cluster scoped resources such as ClusterIssuer in. "+
|
|
"This must be specified if ClusterIssuers are enabled.")
|
|
fs.StringVar(&s.Namespace, "namespace", defaultNamespace, ""+
|
|
"If set, this limits the scope of cert-manager to a single namespace and ClusterIssuers are disabled. "+
|
|
"If not specified, all namespaces will be watched")
|
|
fs.BoolVar(&s.LeaderElect, "leader-elect", true, ""+
|
|
"If true, cert-manager will perform leader election between instances to ensure no more "+
|
|
"than one instance of cert-manager operates at a time")
|
|
fs.StringVar(&s.LeaderElectionNamespace, "leader-election-namespace", defaultLeaderElectionNamespace, ""+
|
|
"Namespace used to perform leader election. Only used if leader election is enabled")
|
|
fs.DurationVar(&s.LeaderElectionLeaseDuration, "leader-election-lease-duration", defaultLeaderElectionLeaseDuration, ""+
|
|
"The duration that non-leader candidates will wait after observing a leadership "+
|
|
"renewal until attempting to acquire leadership of a led but unrenewed leader "+
|
|
"slot. This is effectively the maximum duration that a leader can be stopped "+
|
|
"before it is replaced by another candidate. This is only applicable if leader "+
|
|
"election is enabled.")
|
|
fs.DurationVar(&s.LeaderElectionRenewDeadline, "leader-election-renew-deadline", defaultLeaderElectionRenewDeadline, ""+
|
|
"The interval between attempts by the acting master to renew a leadership slot "+
|
|
"before it stops leading. This must be less than or equal to the lease duration. "+
|
|
"This is only applicable if leader election is enabled.")
|
|
fs.DurationVar(&s.LeaderElectionRetryPeriod, "leader-election-retry-period", defaultLeaderElectionRetryPeriod, ""+
|
|
"The duration the clients should wait between attempting acquisition and renewal "+
|
|
"of a leadership. This is only applicable if leader election is enabled.")
|
|
|
|
fs.StringSliceVar(&s.EnabledControllers, "controllers", defaultEnabledControllers, ""+
|
|
"The set of controllers to enable.")
|
|
|
|
fs.StringVar(&s.ACMEHTTP01SolverImage, "acme-http01-solver-image", defaultACMEHTTP01SolverImage, ""+
|
|
"The docker image to use to solve ACME HTTP01 challenges. You most likely will not "+
|
|
"need to change this parameter unless you are testing a new feature or developing cert-manager.")
|
|
|
|
fs.StringVar(&s.ACMEHTTP01SolverResourceRequestCPU, "acme-http01-solver-resource-request-cpu", defaultACMEHTTP01SolverResourceRequestCPU, ""+
|
|
"Defines the resource request CPU size when spawning new ACME HTTP01 challenge solver pods.")
|
|
|
|
fs.StringVar(&s.ACMEHTTP01SolverResourceRequestMemory, "acme-http01-solver-resource-request-memory", defaultACMEHTTP01SolverResourceRequestMemory, ""+
|
|
"Defines the resource request Memory size when spawning new ACME HTTP01 challenge solver pods.")
|
|
|
|
fs.StringVar(&s.ACMEHTTP01SolverResourceLimitsCPU, "acme-http01-solver-resource-limits-cpu", defaultACMEHTTP01SolverResourceLimitsCPU, ""+
|
|
"Defines the resource limits CPU size when spawning new ACME HTTP01 challenge solver pods.")
|
|
|
|
fs.StringVar(&s.ACMEHTTP01SolverResourceLimitsMemory, "acme-http01-solver-resource-limits-memory", defaultACMEHTTP01SolverResourceLimitsMemory, ""+
|
|
"Defines the resource limits Memory size when spawning new ACME HTTP01 challenge solver pods.")
|
|
|
|
fs.BoolVar(&s.ClusterIssuerAmbientCredentials, "cluster-issuer-ambient-credentials", defaultClusterIssuerAmbientCredentials, ""+
|
|
"Whether a cluster-issuer may make use of ambient credentials for issuers. 'Ambient Credentials' are credentials drawn from the environment, metadata services, or local files which are not explicitly configured in the ClusterIssuer API object. "+
|
|
"When this flag is enabled, the following sources for credentials are also used: "+
|
|
"AWS - All sources the Go SDK defaults to, notably including any EC2 IAM roles available via instance metadata.")
|
|
fs.BoolVar(&s.IssuerAmbientCredentials, "issuer-ambient-credentials", defaultIssuerAmbientCredentials, ""+
|
|
"Whether an issuer may make use of ambient credentials. 'Ambient Credentials' are credentials drawn from the environment, metadata services, or local files which are not explicitly configured in the Issuer API object. "+
|
|
"When this flag is enabled, the following sources for credentials are also used: "+
|
|
"AWS - All sources the Go SDK defaults to, notably including any EC2 IAM roles available via instance metadata.")
|
|
fs.DurationVar(&s.RenewBeforeExpiryDuration, "renew-before-expiry-duration", defaultRenewBeforeExpiryDuration, ""+
|
|
"The default 'renew before expiry' time for Certificates. "+
|
|
"Once a certificate is within this duration until expiry, a new Certificate "+
|
|
"will be attempted to be issued.")
|
|
fs.StringSliceVar(&s.DefaultAutoCertificateAnnotations, "auto-certificate-annotations", defaultAutoCertificateAnnotations, ""+
|
|
"The annotation consumed by the ingress-shim controller to indicate a ingress is requesting a certificate")
|
|
|
|
fs.StringVar(&s.DefaultIssuerName, "default-issuer-name", defaultTLSACMEIssuerName, ""+
|
|
"Name of the Issuer to use when the tls is requested but issuer name is not specified on the ingress resource.")
|
|
fs.StringVar(&s.DefaultIssuerKind, "default-issuer-kind", defaultTLSACMEIssuerKind, ""+
|
|
"Kind of the Issuer to use when the tls is requested but issuer kind is not specified on the ingress resource.")
|
|
fs.StringVar(&s.DefaultIssuerGroup, "default-issuer-group", defaultTLSACMEIssuerGroup, ""+
|
|
"Group of the Issuer to use when the tls is requested but issuer group is not specified on the ingress resource.")
|
|
fs.StringSliceVar(&s.DNS01RecursiveNameservers, "dns01-recursive-nameservers",
|
|
[]string{}, "A list of comma seperated dns server endpoints used for "+
|
|
"DNS01 check requests. This should be a list containing host and "+
|
|
"port, for example 8.8.8.8:53,8.8.4.4:53")
|
|
fs.BoolVar(&s.DNS01RecursiveNameserversOnly, "dns01-recursive-nameservers-only",
|
|
defaultDNS01RecursiveNameserversOnly,
|
|
"When true, cert-manager will only ever query the configured DNS resolvers "+
|
|
"to perform the ACME DNS01 self check. This is useful in DNS constrained "+
|
|
"environments, where access to authoritative nameservers is restricted. "+
|
|
"Enabling this option could cause the DNS01 self check to take longer "+
|
|
"due to caching performed by the recursive nameservers.")
|
|
fs.StringSliceVar(&s.DNS01RecursiveNameservers, "dns01-self-check-nameservers",
|
|
[]string{}, "A list of comma seperated dns server endpoints used for "+
|
|
"DNS01 check requests. This should be a list containing host and port, "+
|
|
"for example 8.8.8.8:53,8.8.4.4:53")
|
|
fs.MarkDeprecated("dns01-self-check-nameservers", "Deprecated in favour of dns01-recursive-nameservers")
|
|
fs.BoolVar(&s.EnableCertificateOwnerRef, "enable-certificate-owner-ref", defaultEnableCertificateOwnerRef, ""+
|
|
"Whether to set the certificate resource as an owner of secret where the tls certificate is stored. "+
|
|
"When this flag is enabled, the secret will be automatically removed when the certificate resource is deleted.")
|
|
fs.IntVar(&s.MaxConcurrentChallenges, "max-concurrent-challenges", defaultMaxConcurrentChallenges, ""+
|
|
"The maximum number of challenges that can be scheduled as 'processing' at once.")
|
|
|
|
fs.StringVar(&s.WebhookNamespace, "webhook-namespace", defaultWebhookNamespace, "The namespace the webhook component is running in, "+
|
|
"used for provisioning TLS certificates for the conversion webhook.")
|
|
fs.StringVar(&s.WebhookCASecretName, "webhook-ca-secret", defaultWebhookCASecretName, "The name of the Secret used to store the webhook's "+
|
|
"CA data.")
|
|
fs.StringVar(&s.WebhookServingSecretName, "webhook-serving-secret", defaultWebhookServingSecretName, "The name of the Secret used to store the webhook's "+
|
|
"serving certificate.")
|
|
fs.StringSliceVar(&s.WebhookDNSNames, "webhook-dns-names", defaultWebhookDNSNames, "Comma-separated list of DNS names that should be present on "+
|
|
"the webhook's serving certificate.")
|
|
}
|
|
|
|
func (o *ControllerOptions) Validate() error {
|
|
switch o.DefaultIssuerKind {
|
|
case "Issuer":
|
|
case "ClusterIssuer":
|
|
default:
|
|
return fmt.Errorf("invalid default issuer kind: %v", o.DefaultIssuerKind)
|
|
}
|
|
|
|
for _, server := range o.DNS01RecursiveNameservers {
|
|
// ensure all servers have a port number
|
|
_, _, err := net.SplitHostPort(server)
|
|
if err != nil {
|
|
return fmt.Errorf("invalid DNS server (%v): %v", err, server)
|
|
}
|
|
}
|
|
return nil
|
|
}
|