Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 add manager.Options.WebhookServer so webhook server can be set #1500

Merged
merged 2 commits into from
Apr 30, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 23 additions & 5 deletions pkg/manager/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -209,17 +209,24 @@ type Options struct {
LivenessEndpointName string

// Port is the port that the webhook server serves at.
// It is used to set webhook.Server.Port.
// It is used to set webhook.Server.Port if WebhookServer is not set.
Port int
// Host is the hostname that the webhook server binds to.
// It is used to set webhook.Server.Host.
// It is used to set webhook.Server.Host if WebhookServer is not set.
Host string

// CertDir is the directory that contains the server key and certificate.
// if not set, webhook server would look up the server key and certificate in
// If not set, webhook server would look up the server key and certificate in
// {TempDir}/k8s-webhook-server/serving-certs. The server key and certificate
// must be named tls.key and tls.crt, respectively.
// It is used to set webhook.Server.CertDir if WebhookServer is not set.
CertDir string

// WebhookServer is an externally configured webhook.Server. By default,
// a Manager will create a default server using Port, Host, and CertDir;
// if this is set, the Manager will use this server instead.
WebhookServer *webhook.Server

// Functions to all for a user to customize the values that will be injected.

// NewCache is the function that will create the cache to be used
Expand Down Expand Up @@ -358,7 +365,7 @@ func New(config *rest.Config, options Options) (Manager, error) {
return nil, err
}

return &controllerManager{
cm := &controllerManager{
cluster: cluster,
recorderProvider: recorderProvider,
resourceLock: resourceLock,
Expand All @@ -370,6 +377,7 @@ func New(config *rest.Config, options Options) (Manager, error) {
port: options.Port,
host: options.Host,
certDir: options.CertDir,
webhookServer: options.WebhookServer,
leaseDuration: *options.LeaseDuration,
renewDeadline: *options.RenewDeadline,
retryPeriod: *options.RetryPeriod,
Expand All @@ -379,7 +387,17 @@ func New(config *rest.Config, options Options) (Manager, error) {
gracefulShutdownTimeout: *options.GracefulShutdownTimeout,
internalProceduresStop: make(chan struct{}),
leaderElectionStopped: make(chan struct{}),
}, nil
}

// A webhook server set by New's caller should be added now
// so GetWebhookServer can construct a new one if unset and add it only once.
if cm.webhookServer != nil {
if err := cm.Add(cm.webhookServer); err != nil {
estroz marked this conversation as resolved.
Show resolved Hide resolved
return nil, err
}
}

return cm, nil
}

// AndFrom will use a supplied type and convert to Options
Expand Down
21 changes: 21 additions & 0 deletions pkg/manager/manager_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/recorder"
"sigs.k8s.io/controller-runtime/pkg/runtime/inject"
"sigs.k8s.io/controller-runtime/pkg/webhook"
)

var _ = Describe("manger.Manager", func() {
Expand Down Expand Up @@ -273,6 +274,26 @@ var _ = Describe("manger.Manager", func() {
close(done)
})

It("should not initialize a webhook server if Options.WebhookServer is set", func(done Done) {
By("creating a manager with options")
m, err := New(cfg, Options{Port: 9441, WebhookServer: &webhook.Server{Port: 9440}})
Expect(err).NotTo(HaveOccurred())
Expect(m).NotTo(BeNil())

By("checking the webhook server was added to non-leader-election runnables")
Expect(m).To(BeAssignableToTypeOf(&controllerManager{}))
nonLERunnables := m.(*controllerManager).nonLeaderElectionRunnables
Expect(nonLERunnables).To(HaveLen(1))
Expect(nonLERunnables[0]).To(BeAssignableToTypeOf(&webhook.Server{}))

By("checking the server contains the Port set on the webhook server and not passed to Options")
svr := m.GetWebhookServer()
Expect(svr).NotTo(BeNil())
Expect(svr.Port).To(Equal(9440))

close(done)
})

Context("with leader election enabled", func() {
It("should only cancel the leader election after all runnables are done", func() {
m, err := New(cfg, Options{
Expand Down