Update directory structure

Problem: Now that the original provisioner mode has been removed, we don't need the nested `mode/static` directory structure. The naming no longer makes sense.

Solution: Updated `mode/static` directory to `controller`, and moved some of the `framework` packages into `controller`. Other packages in `framework` were left alone since many of them are general enough for "controller building" use.

Author: sjberman

.github/workflows/build.yml

@@ -149,8 +149,8 @@ jobs:
           sbom: true
           provenance: mode=max
           build-args: |
-            NJS_DIR=internal/mode/static/nginx/modules/src
-            NGINX_CONF_DIR=internal/mode/static/nginx/conf
+            NJS_DIR=internal/controller/nginx/modules/src
+            NGINX_CONF_DIR=internal/controller/nginx/conf
             BUILD_AGENT=gha
           secrets: |
             ${{ contains(inputs.image, 'plus') && format('"nginx-repo.crt={0}"', secrets.NGINX_CRT) || '' }}

.github/workflows/ci.yml

@@ -119,7 +119,7 @@ jobs:
           node-version-file: .nvmrc
 
       - name: Run tests
-        run: npm --prefix ${{ github.workspace }}/internal/mode/static/nginx/modules install-ci-test
+        run: npm --prefix ${{ github.workspace }}/internal/controller/nginx/modules install-ci-test
 
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3

.github/workflows/conformance.yml

@@ -106,8 +106,8 @@ jobs:
           cache-from: type=gha,scope=${{ inputs.image }}
           pull: true
           build-args: |
-            NJS_DIR=internal/mode/static/nginx/modules/src
-            NGINX_CONF_DIR=internal/mode/static/nginx/conf
+            NJS_DIR=internal/controller/nginx/modules/src
+            NGINX_CONF_DIR=internal/controller/nginx/conf
             BUILD_AGENT=gha
 
       - name: Update Go Modules

.github/workflows/functional.yml

@@ -100,8 +100,8 @@ jobs:
           cache-from: type=gha,scope=${{ inputs.image }}
           pull: true
           build-args: |
-            NJS_DIR=internal/mode/static/nginx/modules/src
-            NGINX_CONF_DIR=internal/mode/static/nginx/conf
+            NJS_DIR=internal/controller/nginx/modules/src
+            NGINX_CONF_DIR=internal/controller/nginx/conf
             BUILD_AGENT=gha
 
       - name: Setup license file for plus

.github/workflows/helm.yml

@@ -80,8 +80,8 @@ jobs:
           cache-from: type=gha,scope=${{ inputs.image }}
           pull: true
           build-args: |
-            NJS_DIR=internal/mode/static/nginx/modules/src
-            NGINX_CONF_DIR=internal/mode/static/nginx/conf
+            NJS_DIR=internal/controller/nginx/modules/src
+            NGINX_CONF_DIR=internal/controller/nginx/conf
             BUILD_AGENT=gha
 
       - name: Install cloud-provider-kind

.github/workflows/lint.yml

@@ -58,8 +58,8 @@ jobs:
         id: prettier-run
         uses: rutajdash/prettier-cli-action@d42c4325a3b344f3bd4be482bc34de521998d557 # v1.0.2
         with:
-          config_path: ${{ github.workspace }}/internal/mode/static/nginx/modules/.prettierrc
-          file_pattern: ${{ github.workspace }}/internal/mode/static/nginx/modules/**/*.js
+          config_path: ${{ github.workspace }}/internal/controller/nginx/modules/.prettierrc
+          file_pattern: ${{ github.workspace }}/internal/controller/nginx/modules/**/*.js
           prettier_version: 3.3.3 # renovate: datasource=npm depName=prettier
 
       - name: Prettier Output

.gitignore

@@ -37,7 +37,7 @@ tests/**/*.csv
 node_modules/
 
 # JS test coverage
-internal/mode/static/nginx/modules/coverage
+internal/controller/nginx/modules/coverage
 
 # MacOS Finder
 .DS_Store

.gitleaksignore

@@ -3,4 +3,4 @@
 68d1f6eb80d23c8650c11629459dd6a06c986ca1:internal/state/graph/graph_test.go:private-key:44
 890fddb787ff3560b9b743647a36b649d498ae51:internal/state/graph/secret_test.go:private-key:35
 890fddb787ff3560b9b743647a36b649d498ae51:internal/state/change_processor_test.go:private-key:211
-internal/mode/static/state/graph/config_maps_test.go:private-key:35
+internal/controller/state/graph/config_maps_test.go:private-key:35

Makefile

@@ -2,8 +2,8 @@
 VERSION = edge
 SELF_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 CHART_DIR = $(SELF_DIR)charts/nginx-gateway-fabric
-NGINX_CONF_DIR = internal/mode/static/nginx/conf
-NJS_DIR = internal/mode/static/nginx/modules/src
+NGINX_CONF_DIR = internal/controller/nginx/conf
+NJS_DIR = internal/controller/nginx/modules/src
 KIND_CONFIG_FILE = $(SELF_DIR)config/cluster/kind-cluster.yaml
 NGINX_DOCKER_BUILD_PLUS_ARGS = --secret id=nginx-repo.crt,src=$(SELF_DIR)nginx-repo.crt --secret id=nginx-repo.key,src=$(SELF_DIR)nginx-repo.key
 BUILD_AGENT = local
@@ -202,7 +202,7 @@ unit-test: ## Run unit tests for the go code
 .PHONY: njs-unit-test
 njs-unit-test: ## Run unit tests for the njs httpmatches module
 	docker run --rm -w /modules \
-		-v $(CURDIR)/internal/mode/static/nginx/modules:/modules/ \
+		-v $(CURDIR)/internal/controller/nginx/modules:/modules/ \
 		node:${NODE_VERSION} \
 		/bin/bash -c "npm ci && npm test && npm run clean"
 

cmd/gateway/commands.go

@@ -20,11 +20,11 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/log"
 	ctlrZap "sigs.k8s.io/controller-runtime/pkg/log/zap"
 
+	"github.com/nginx/nginx-gateway-fabric/internal/controller"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/config"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/licensing"
+	ngxConfig "github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/file"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/config"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/licensing"
-	ngxConfig "github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/config"
 )
 
 // These flags are shared by multiple commands.
@@ -259,7 +259,7 @@ func createControllerCommand() *cobra.Command {
 				NGINXSCCName:           nginxSCCName.value,
 			}
 
-			if err := static.StartManager(conf); err != nil {
+			if err := controller.StartManager(conf); err != nil {
 				return fmt.Errorf("failed to start control loop: %w", err)
 			}
 

cmd/gateway/commands_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/config"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/config"
 )
 
 type flagTestCase struct {

cmd/gateway/initialize.go

@@ -9,9 +9,9 @@ import (
 
 	"github.com/go-logr/logr"
 
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/licensing"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/file"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/licensing"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/config"
 )
 
 const (

cmd/gateway/initialize_test.go

@@ -11,12 +11,12 @@ import (
 	"github.com/go-logr/logr"
 	. "github.com/onsi/gomega"
 
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/licensing/licensingfakes"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/configfakes"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/dataplane"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/file"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/file/filefakes"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/helpers"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/licensing/licensingfakes"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/config/configfakes"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/dataplane"
 )
 
 func TestInitialize_OSS(t *testing.T) {

internal/mode/static/config/config.go renamed to internal/controller/config/config.go

@@ -1,4 +1,4 @@
-package static
+package controller
 
 import (
 	"encoding/json"

internal/mode/static/config_updater.go renamed to internal/controller/config_updater.go

@@ -1,4 +1,4 @@
-package static
+package controller
 
 import (
 	"errors"
@@ -11,8 +11,8 @@ import (
 	"k8s.io/client-go/tools/record"
 
 	ngfAPI "github.com/nginx/nginx-gateway-fabric/apis/v1alpha1"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/controllerfakes"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/helpers"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/staticfakes"
 )
 
 func TestUpdateControlPlane(t *testing.T) {
@@ -75,7 +75,7 @@ func TestUpdateControlPlane(t *testing.T) {
 			t.Parallel()
 			g := NewWithT(t)
 
-			fakeLogSetter := &staticfakes.FakeLogLevelSetter{
+			fakeLogSetter := &controllerfakes.FakeLogLevelSetter{
 				SetLevelStub: func(_ string) error {
 					return test.setLevelErr
 				},

internal/mode/static/config_updater_test.go renamed to internal/controller/config_updater_test.go

@@ -1,4 +1,4 @@
-package static_test
+package controller_test
 
 import (
 	"testing"
@@ -7,8 +7,8 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-func TestStatic(t *testing.T) {
+func TestController(t *testing.T) {
 	t.Parallel()
 	RegisterFailHandler(Fail)
-	RunSpecs(t, "Static Suite")
+	RunSpecs(t, "Controller Suite")
 }

internal/mode/static/static_suite_test.go renamed to internal/controller/controller_suite_test.go

@@ -0,0 +1,4 @@
+/*
+Package controller contains all the packages that relate to the controller implementation of NGF.
+*/
+package controller

internal/mode/static/staticfakes/fake_log_level_setter.go renamed to internal/controller/controllerfakes/fake_log_level_setter.go

@@ -1,4 +1,4 @@
-package static
+package controller
 
 import (
 	"context"
@@ -18,20 +18,19 @@ import (
 	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
 
 	ngfAPI "github.com/nginx/nginx-gateway-fabric/apis/v1alpha1"
+	ngfConfig "github.com/nginx/nginx-gateway-fabric/internal/controller/config"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/licensing"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/agent"
+	ngxConfig "github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/provisioner"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/dataplane"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/graph"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/resolver"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/status"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/controller"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/events"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/helpers"
-	frameworkStatus "github.com/nginx/nginx-gateway-fabric/internal/framework/status"
-	ngfConfig "github.com/nginx/nginx-gateway-fabric/internal/mode/static/config"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/licensing"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/agent"
-	ngxConfig "github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/config"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/provisioner"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/dataplane"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/graph"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/resolver"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/status"
 )
 
 type handlerMetricsCollector interface {
@@ -48,7 +47,7 @@ type eventHandlerConfig struct {
 	// metricsCollector collects metrics for this controller.
 	metricsCollector handlerMetricsCollector
 	// statusUpdater updates statuses on Kubernetes resources.
-	statusUpdater frameworkStatus.GroupUpdater
+	statusUpdater status.GroupUpdater
 	// processor is the state ChangeProcessor.
 	processor state.ChangeProcessor
 	// serviceResolver resolves Services to Endpoints.
@@ -351,7 +350,7 @@ func (h *eventHandlerImpl) updateStatuses(ctx context.Context, gr *graph.Graph,
 	)
 
 	reqs := make(
-		[]frameworkStatus.UpdateRequest,
+		[]status.UpdateRequest,
 		0,
 		len(gcReqs)+len(routeReqs)+len(polReqs)+len(ngfPolReqs)+len(snippetsFilterReqs),
 	)
@@ -445,7 +444,7 @@ func (h *eventHandlerImpl) updateControlPlaneAndSetStatus(
 		cpUpdateRes.Error = err
 	}
 
-	var reqs []frameworkStatus.UpdateRequest
+	var reqs []status.UpdateRequest
 
 	req := status.PrepareNginxGatewayStatus(cfg, metav1.Now(), cpUpdateRes)
 	if req != nil {

internal/controller/doc.go

@@ -1,4 +1,4 @@
-package static
+package controller
 
 import (
 	"context"
@@ -20,22 +20,22 @@ import (
 	gatewayv1 "sigs.k8s.io/gateway-api/apis/v1"
 
 	ngfAPI "github.com/nginx/nginx-gateway-fabric/apis/v1alpha1"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/config"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/licensing/licensingfakes"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/metrics/collectors"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/agent"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/agent/agentfakes"
+	agentgrpcfakes "github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/agent/grpc/grpcfakes"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/nginx/config/configfakes"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/provisioner/provisionerfakes"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/dataplane"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/graph"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/statefakes"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/status"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/status/statusfakes"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/controller"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/events"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/helpers"
-	"github.com/nginx/nginx-gateway-fabric/internal/framework/status/statusfakes"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/config"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/licensing/licensingfakes"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/metrics/collectors"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/agent"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/agent/agentfakes"
-	agentgrpcfakes "github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/agent/grpc/grpcfakes"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/nginx/config/configfakes"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/provisioner/provisionerfakes"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/dataplane"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/graph"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/statefakes"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/status"
 )
 
 var _ = Describe("eventHandler", func() {

internal/mode/static/handler.go renamed to internal/controller/handler.go

@@ -1,4 +1,4 @@
-package static
+package controller
 
 import (
 	"errors"

internal/mode/static/handler_test.go renamed to internal/controller/handler_test.go

@@ -1,4 +1,4 @@
-package static
+package controller
 
 import (
 	"testing"

internal/mode/static/health.go renamed to internal/controller/health.go

@@ -7,8 +7,8 @@ import (
 	"github.com/go-logr/logr"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/dataplane"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/telemetry"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/dataplane"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/telemetry"
 )
 
 //go:generate go tool counterfeiter -generate

internal/mode/static/health_test.go renamed to internal/controller/health_test.go

@@ -9,9 +9,9 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
 
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/licensing"
+	"github.com/nginx/nginx-gateway-fabric/internal/controller/state/dataplane"
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/helpers"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/licensing"
-	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/dataplane"
 )
 
 var _ = Describe("DeploymentContextCollector", func() {

internal/mode/static/licensing/collector.go renamed to internal/controller/licensing/collector.go

@@ -1,4 +1,4 @@
-package static
+package controller
 
 import (
 	"errors"
@@ -7,6 +7,8 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
+//go:generate go tool counterfeiter -generate
+
 //counterfeiter:generate . logLevelSetter
 
 // logLevelSetter defines an interface for setting the logging level of a logger.