Skip to content

Commit a7c8a93

Browse files
authored
Merge pull request #751 from bhcleek/doc/tls
📖 docs: document the expected names of the TLS key and certificate
2 parents 9263a5a + 8fae388 commit a7c8a93

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

pkg/manager/manager.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,8 @@ type Options struct {
170170

171171
// CertDir is the directory that contains the server key and certificate.
172172
// if not set, webhook server would look up the server key and certificate in
173-
// {TempDir}/k8s-webhook-server/serving-certs
173+
// {TempDir}/k8s-webhook-server/serving-certs. The server key and certificate
174+
// must be named tls.key and tls.crt, respectively.
174175
CertDir string
175176
// Functions to all for a user to customize the values that will be injected.
176177

pkg/webhook/server.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,9 @@ type Server struct {
5252
// It will be defaulted to 443 if unspecified.
5353
Port int
5454

55-
// CertDir is the directory that contains the server key and certificate.
55+
// CertDir is the directory that contains the server key and certificate. The
56+
// server key and certificate must be named tls.key and tls.crt,
57+
// respectively.
5658
CertDir string
5759

5860
// WebhookMux is the multiplexer that handles different webhooks.

0 commit comments

Comments
 (0)