coder · ammario · Dec 6, 2022 · Dec 2, 2022 · Dec 2, 2022 · Dec 3, 2022
diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -122,6 +122,7 @@ type data struct {
 	deploymentID    string
 	derpMeshKey     string
 	lastUpdateCheck []byte
+	serviceBanner   []byte
 	lastLicenseID   int32
 }
 
@@ -3331,6 +3332,25 @@ func (q *fakeQuerier) GetLastUpdateCheck(_ context.Context) (string, error) {
 	return string(q.lastUpdateCheck), nil
 }
 
+func (q *fakeQuerier) InsertOrUpdateServiceBanner(_ context.Context, data string) error {
+	q.mutex.RLock()
+	defer q.mutex.RUnlock()
+
+	q.serviceBanner = []byte(data)
+	return nil
+}
+
+func (q *fakeQuerier) GetServiceBanner(_ context.Context) (string, error) {
+	q.mutex.RLock()
+	defer q.mutex.RUnlock()
+
+	if q.serviceBanner == nil {
+		return "", sql.ErrNoRows
+	}
+
+	return string(q.serviceBanner), nil
+}
+
 func (q *fakeQuerier) InsertLicense(
 	_ context.Context, arg database.InsertLicenseParams,
 ) (database.License, error) {

diff --git a/coderd/database/querier.go b/coderd/database/querier.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/siteconfig.sql b/coderd/database/queries/siteconfig.sql
@@ -16,3 +16,10 @@ ON CONFLICT (key) DO UPDATE SET value = $1 WHERE site_configs.key = 'last_update
 
 -- name: GetLastUpdateCheck :one
 SELECT value FROM site_configs WHERE key = 'last_update_check';
+
+-- name: InsertOrUpdateServiceBanner :exec
+INSERT INTO site_configs (key, value) VALUES ('service_banner', $1)
+ON CONFLICT (key) DO UPDATE SET value = $1 WHERE site_configs.key = 'service_banner';
+
+-- name: GetServiceBanner :one
+SELECT value FROM site_configs WHERE key = 'service_banner';
diff --git a/codersdk/features.go b/codersdk/features.go
@@ -23,6 +23,7 @@ const (
 	FeatureHighAvailability           = "high_availability"
 	FeatureMultipleGitAuth            = "multiple_git_auth"
 	FeatureExternalProvisionerDaemons = "external_provisioner_daemons"
+	FeatureServiceBanners             = "service_banners"
 )
 
 var FeatureNames = []string{
@@ -34,6 +35,7 @@ var FeatureNames = []string{
 	FeatureHighAvailability,
 	FeatureMultipleGitAuth,
 	FeatureExternalProvisionerDaemons,
+	FeatureServiceBanners,
 }
 
 type Feature struct {

diff --git a/codersdk/servicebanner.go b/codersdk/servicebanner.go
@@ -0,0 +1,38 @@
+package codersdk
+
+import (
+	"context"
+	"encoding/json"
+	"net/http"
+)
+
+type ServiceBanner struct {
+	Enabled         bool   `json:"enabled"`
+	Message         string `json:"message,omitempty"`
+	BackgroundColor string `json:"background_color,omitempty"`
+}
+
+func (c *Client) ServiceBanner(ctx context.Context) (*ServiceBanner, error) {
+	res, err := c.Request(ctx, http.MethodGet, "/api/v2/service-banner", nil)
+	if err != nil {
+		return nil, err
+	}
+	defer res.Body.Close()
+	if res.StatusCode != http.StatusOK {
+		return nil, readBodyAsError(res)
+	}
+	var b ServiceBanner
+	return &b, json.NewDecoder(res.Body).Decode(&b)
+}
+
+func (c *Client) SetServiceBanner(ctx context.Context, s *ServiceBanner) error {
+	res, err := c.Request(ctx, http.MethodPut, "/api/v2/service-banner", s)
+	if err != nil {
+		return err
+	}
+	defer res.Body.Close()
+	if res.StatusCode != http.StatusOK {
+		return readBodyAsError(res)
+	}
+	return nil
+}
diff --git a/docs/admin/service-banners.md b/docs/admin/service-banners.md
@@ -0,0 +1,12 @@
+# Service Banners
+
+Service Banners let admins post important messages to all site users. Only Site Owners may set the service banner.
+
+![service banners](../images/admin/service-banners.png)
+
+You can access the Service Banner settings by navigating to
+`Deployment > Service Banners`.
+
+## Up next
+
+- [Enterprise](../enterprise.md)
diff --git a/docs/enterprise.md b/docs/enterprise.md
@@ -13,6 +13,7 @@ Contact sales@coder.com to obtain a license.
 
 - [High Availability](./admin/high-availability.md)
 - [Browser Only Connections](./networking.md#browser-only-connections)
+- [Service Banners](./admin/service-banners.md)
 
 ### Other
 

diff --git a/docs/images/admin/service-banners.png b/docs/images/admin/service-banners.png
diff --git a/docs/images/icons/info.svg b/docs/images/icons/info.svg
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -276,6 +276,13 @@
           "icon_path": "./images/icons/speed.svg",
           "path": "./admin/prometheus.md"
         },
+        {
+          "title": "Service Banners",
+          "description": "Learn how to configure Service Banners",
+          "icon_path": "./images/icons/info.svg",
+          "path": "./admin/service-banners.md",
+          "state": "enterprise"
+        },
         {
           "title": "Telemetry",
           "description": "Learn what usage telemetry Coder collects",

diff --git a/enterprise/coderd/coderd.go b/enterprise/coderd/coderd.go
@@ -127,6 +127,13 @@ func New(ctx context.Context, options *Options) (*API, error) {
 				r.Get("/", api.workspaceQuota)
 			})
 		})
+		r.Route("/service-banner", func(r chi.Router) {
+			r.Use(
+				apiKeyMiddleware,
+			)
+			r.Get("/", api.serviceBanner)
+			r.Put("/", api.putServiceBanner)
+		})
 	})
 
 	if len(options.SCIMAPIKey) != 0 {

diff --git a/enterprise/coderd/coderdenttest/coderdenttest.go b/enterprise/coderd/coderdenttest/coderdenttest.go
@@ -113,6 +113,7 @@ type LicenseOptions struct {
 	HighAvailability           bool
 	MultipleGitAuth            bool
 	ExternalProvisionerDaemons bool
+	ServiceBanners             bool
 }
 
 // AddLicense generates a new license with the options provided and inserts it.
@@ -164,6 +165,11 @@ func GenerateLicense(t *testing.T, options LicenseOptions) string {
 		externalProvisionerDaemons = 1
 	}
 
+	serviceBanners := int64(0)
+	if options.ServiceBanners {
+		serviceBanners = 1
+	}
+
 	c := &license.Claims{
 		RegisteredClaims: jwt.RegisteredClaims{
 			Issuer:    "test@testing.test",
@@ -186,6 +192,7 @@ func GenerateLicense(t *testing.T, options LicenseOptions) string {
 			TemplateRBAC:               rbacEnabled,
 			MultipleGitAuth:            multipleGitAuth,
 			ExternalProvisionerDaemons: externalProvisionerDaemons,
+			ServiceBanners:             serviceBanners,
 		},
 	}
 	tok := jwt.NewWithClaims(jwt.SigningMethodEdDSA, c)

diff --git a/enterprise/coderd/coderdenttest/coderdenttest_test.go b/enterprise/coderd/coderdenttest/coderdenttest_test.go
@@ -49,6 +49,7 @@ func TestAuthorizeAllEndpoints(t *testing.T) {
 
 	skipRoutes, assertRoute := coderdtest.AGPLRoutes(a)
 	skipRoutes["GET:/api/v2/organizations/{organization}/provisionerdaemons/serve"] = "This route checks for RBAC dependent on input parameters!"
+	skipRoutes["GET:/api/v2/service-banner/"] = "This route is available to all users"
 
 	assertRoute["GET:/api/v2/entitlements"] = coderdtest.RouteCheck{
 		NoAuthorize: true,

diff --git a/enterprise/coderd/license/license.go b/enterprise/coderd/license/license.go
@@ -123,6 +123,12 @@ func Entitlements(
 				Enabled:     true,
 			}
 		}
+		if claims.Features.ServiceBanners > 0 {
+			entitlements.Features[codersdk.FeatureServiceBanners] = codersdk.Feature{
+				Entitlement: entitlement,
+				Enabled:     true,
+			}
+		}
 		if claims.AllFeatures {
 			allFeatures = true
 		}
@@ -252,6 +258,7 @@ type Features struct {
 	HighAvailability           int64 `json:"high_availability"`
 	MultipleGitAuth            int64 `json:"multiple_git_auth"`
 	ExternalProvisionerDaemons int64 `json:"external_provisioner_daemons"`
+	ServiceBanners             int64 `json:"service_banners"`
 }
 
 type Claims struct {

diff --git a/enterprise/coderd/license/license_test.go b/enterprise/coderd/license/license_test.go
@@ -27,6 +27,7 @@ func TestEntitlements(t *testing.T) {
 		codersdk.FeatureTemplateRBAC:               true,
 		codersdk.FeatureMultipleGitAuth:            true,
 		codersdk.FeatureExternalProvisionerDaemons: true,
+		codersdk.FeatureServiceBanners:             true,
 	}
 
 	t.Run("Defaults", func(t *testing.T) {
@@ -70,6 +71,7 @@ func TestEntitlements(t *testing.T) {
 				TemplateRBAC:               true,
 				MultipleGitAuth:            true,
 				ExternalProvisionerDaemons: true,
+				ServiceBanners:             true,
 			}),
 			Exp: time.Now().Add(time.Hour),
 		})
@@ -78,7 +80,7 @@ func TestEntitlements(t *testing.T) {
 		require.True(t, entitlements.HasLicense)
 		require.False(t, entitlements.Trial)
 		for _, featureName := range codersdk.FeatureNames {
-			require.Equal(t, codersdk.EntitlementEntitled, entitlements.Features[featureName].Entitlement)
+			require.Equal(t, codersdk.EntitlementEntitled, entitlements.Features[featureName].Entitlement, featureName)
 		}
 	})
 	t.Run("SingleLicenseGrace", func(t *testing.T) {
@@ -93,6 +95,7 @@ func TestEntitlements(t *testing.T) {
 				HighAvailability:           true,
 				TemplateRBAC:               true,
 				ExternalProvisionerDaemons: true,
+				ServiceBanners:             true,
 				GraceAt:                    time.Now().Add(-time.Hour),
 				ExpiresAt:                  time.Now().Add(time.Hour),
 			}),

diff --git a/enterprise/coderd/licenses_test.go b/enterprise/coderd/licenses_test.go
@@ -109,6 +109,7 @@ func TestGetLicense(t *testing.T) {
 			codersdk.FeatureTemplateRBAC:               json.Number("1"),
 			codersdk.FeatureMultipleGitAuth:            json.Number("0"),
 			codersdk.FeatureExternalProvisionerDaemons: json.Number("0"),
+			codersdk.FeatureServiceBanners:             json.Number("0"),
 		}, licenses[0].Claims["features"])
 		assert.Equal(t, int32(2), licenses[1].ID)
 		assert.Equal(t, "testing2", licenses[1].Claims["account_id"])
@@ -122,6 +123,7 @@ func TestGetLicense(t *testing.T) {
 			codersdk.FeatureTemplateRBAC:               json.Number("0"),
 			codersdk.FeatureMultipleGitAuth:            json.Number("0"),
 			codersdk.FeatureExternalProvisionerDaemons: json.Number("0"),
+			codersdk.FeatureServiceBanners:             json.Number("0"),
 		}, licenses[1].Claims["features"])
 	})
 }