From 432b94239d6096e75b413de5a79c6707ab808bc9 Mon Sep 17 00:00:00 2001
From: Andreas Schneider <aksdb@gmx.de>
Date: Wed, 30 Oct 2019 22:12:42 +0100
Subject: admin listener as opt-in for initial config (#2834)

* Always cleanup admin endpoint first

* Error out if no config has been set (#2833)

* Ignore explicitly missing admin config (#2833)

* Separate config loading from admin initialization (#2833)

* Add admin option to specify admin listener address (#2833)

* Use zap for reporting admin endpoint status
---
 admin.go | 40 ++++++++++++++++++++++------------------
 1 file changed, 22 insertions(+), 18 deletions(-)

(limited to 'admin.go')

diff --git a/admin.go b/admin.go
index 0b4affd..e48a4ca 100644
--- a/admin.go
+++ b/admin.go
@@ -18,6 +18,7 @@ import (
 	"bytes"
 	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io"
 	"io/ioutil"
@@ -42,6 +43,8 @@ var (
 	cfgEndptSrvMu sync.Mutex
 )
 
+var ErrAdminInterfaceNotConfigured = errors.New("no admin configuration has been set")
+
 // AdminConfig configures the admin endpoint.
 type AdminConfig struct {
 	Listen string `json:"listen,omitempty"`
@@ -60,10 +63,24 @@ var DefaultAdminConfig = &AdminConfig{
 // in the format of JSON bytes. It opens a listener
 // resource. When no longer needed, StopAdmin should
 // be called.
+// If no configuration is given, a default listener is
+// started. If a configuration is given that does NOT
+// specifically configure the admin interface,
+// `ErrAdminInterfaceNotConfigured` is returned and no
+// listener is initialized.
 func StartAdmin(initialConfigJSON []byte) error {
 	cfgEndptSrvMu.Lock()
 	defer cfgEndptSrvMu.Unlock()
 
+	if cfgEndptSrv != nil {
+		ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+		defer cancel()
+		err := cfgEndptSrv.Shutdown(ctx)
+		if err != nil {
+			return fmt.Errorf("shutting down old admin endpoint: %v", err)
+		}
+	}
+
 	adminConfig := DefaultAdminConfig
 	if len(initialConfigJSON) > 0 {
 		var config *Config
@@ -71,16 +88,11 @@ func StartAdmin(initialConfigJSON []byte) error {
 		if err != nil {
 			return fmt.Errorf("unmarshaling bootstrap config: %v", err)
 		}
-		if config != nil && config.Admin != nil {
-			adminConfig = config.Admin
-		}
-		if cfgEndptSrv != nil {
-			ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
-			defer cancel()
-			err := cfgEndptSrv.Shutdown(ctx)
-			if err != nil {
-				return fmt.Errorf("shutting down old admin endpoint: %v", err)
+		if config != nil {
+			if config.Admin == nil {
+				return ErrAdminInterfaceNotConfigured
 			}
+			adminConfig = config.Admin
 		}
 	}
 
@@ -136,15 +148,7 @@ func StartAdmin(initialConfigJSON []byte) error {
 
 	go cfgEndptSrv.Serve(ln)
 
-	fmt.Println("Caddy 2 admin endpoint listening on", adminConfig.Listen)
-
-	if len(initialConfigJSON) > 0 {
-		err := Load(bytes.NewReader(initialConfigJSON))
-		if err != nil {
-			return fmt.Errorf("loading initial config: %v", err)
-		}
-		fmt.Println("Caddy 2 serving initial configuration")
-	}
+	Log().Named("admin").Info("Caddy 2 admin endpoint started.", zap.String("listenAddress", adminConfig.Listen))
 
 	return nil
 }
-- 
cgit v1.2.3