Add GatewayParameters CRD for dynamic proxy configuration

changelog/v1.17.0-beta17/gatewayparameters.yaml

@@ -0,0 +1,7 @@
+changelog:
+  - type: NEW_FEATURE
+    issueLink: https://github.com/solo-io/solo-projects/issues/5909
+    resolvesIssue: false
+    description: >-
+      Add new GatewayParameters CRD to allow configuration of dynamically provisioned proxies
+      in Gloo Gateway.

generate.go

@@ -11,10 +11,18 @@ import (
 //go:generate go run generate.go
 
 func main() {
-	log.Printf("starting generate")
+	log.Printf("starting generate for gloo")
 
+	// explicitly specify the directories to be built (i.e. do not build gateway2 since
+	// it causes compilation errors in solo-kit, and also because gateway2 protos are not
+	// needed for gloo edge classic)
 	protoImports := sk_anyvendor.CreateDefaultMatchOptions(
-		[]string{"projects/**/*.proto", sk_anyvendor.SoloKitMatchPattern},
+		[]string{
+			"projects/gloo/**/*.proto",
+			"projects/gateway/**/*.proto",
+			"projects/ingress/**/*.proto",
+			sk_anyvendor.SoloKitMatchPattern,
+		},
 	)
 	protoImports.External["github.com/solo-io/solo-apis"] = []string{
 		"api/rate-limiter/**/*.proto", // Import rate limit API
@@ -72,5 +80,5 @@ func main() {
 	if err := cmd.Generate(generateOptions); err != nil {
 		log.Fatalf("generate failed!: %v", err)
 	}
-	log.Printf("finished generating code")
+	log.Printf("finished generating code for gloo")
 }

go.mod

@@ -170,6 +170,9 @@ require (
 	github.com/go-stack/stack v1.8.0 // indirect
 	github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572 // indirect
 	github.com/go-test/deep v1.0.7 // indirect
+	github.com/gobuffalo/envy v1.8.1 // indirect
+	github.com/gobuffalo/packd v1.0.1 // indirect
+	github.com/gobuffalo/packr v1.30.1 // indirect
 	github.com/gobwas/glob v0.2.3 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/snappy v0.0.4 // indirect
@@ -202,12 +205,15 @@ require (
 	github.com/hashicorp/vault/sdk v0.6.0 // indirect
 	github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d // indirect
 	github.com/huandu/xstrings v1.4.0 // indirect
+	github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0 // indirect
 	github.com/iancoleman/strcase v0.2.0 // indirect
 	github.com/imroc/req v0.3.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/invopop/jsonschema v0.7.0 // indirect
 	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 	github.com/jmespath/go-jmespath v0.3.0 // indirect
 	github.com/jmoiron/sqlx v1.3.5 // indirect
+	github.com/joho/godotenv v1.3.0 // indirect
 	github.com/jonboulle/clockwork v0.2.2 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
@@ -268,6 +274,7 @@ require (
 	github.com/shopspring/decimal v1.3.1 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/solo-io/anyvendor v0.0.4 // indirect
+	github.com/solo-io/cue v0.4.7 // indirect
 	github.com/spf13/cast v1.5.0 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/stretchr/testify v1.8.4 // indirect

install/helm/gloo/templates/44-rbac.yaml

@@ -66,6 +66,11 @@ metadata:
     {{- include "gloo-gateway.gateway.constLabels" . | nindent 4 }}
     {{- include "gloo-gateway.controlPlane.labels" . | nindent 4 }}
 rules:
+- apiGroups:
+  - "gateway.gloo.solo.io"
+  resources:
+  - gatewayparameters
+  verbs: ["get", "list", "watch"]
 - apiGroups:
   - ""
   resources:

projects/gateway2/api/README.md

@@ -0,0 +1,19 @@
+## APIs for Gloo Gateway - Kubernetes Gateway API Integration
+
+This directory contains protobuf files used by the Gloo Gateway integration with the Kubernetes Gateway API.
+
+### Codegen
+The protos in this directory are compiled by the k8s gateway integration codegen in [generate.go](../generate.go) which can be invoked via `make install-go-tools generated-code -B`. 
+
+The output of codegen includes:
+- Go types generated in [projects/gateway2/pkg/api/](../pkg/api/) which can be used in Go code
+- CRDs generated in [install/helm/gloo/crds](../../../install/helm/gloo/crds)
+
+### Adding a new CRD
+
+Note that the codegen for k8s gateway integration uses the skv2 library instead of solo-kit (which Gloo Edge classic uses), and thus there are some differences in how CRDs are defined. The k8s gateway integration only runs on Kubernetes and follows the convention of having a `spec` and `status` defined for each CRD.
+
+To add a new CRD:
+1. Create its .proto definition in this directory
+2. Add the `model.Resource` to the codegen command in [generate.go](../generate.go). Include a kind, spec type name, status type name, and (optionally) short names for the CRD.
+3. Run codegen as described [above](#codegen)

projects/gateway2/api/external/kubernetes/README.md

@@ -0,0 +1,42 @@
+## Kubernetes Protos in Gloo Gateway
+
+Some of our Gloo Gateway protos depend on messages from the Kubernetes Core and Apimachinery APIs. This is because our user-facing APIs (e.g GatewayParameters) allow users to configure some parts of Kubernetes resources (e.g. pod/container security context, affinity, tolerations) directly.
+
+Instead of mirroring/redefining these messages in our own protos, we import copies of the protos from the Kubernetes repo(s). Note, the files in those repos are named `generated.proto` since the protos were generated from Go structs.
+
+### Usage
+
+#### Go
+The protos in this directory are compiled by the k8s gateway integration codegen in [generate.go](../../../generate.go), which produces Go types under [projects/gateway2/pkg/api/external/kubernetes/](../../../pkg/api/external/kubernetes/) which can be used in Go code.
+
+#### Protobuf
+To use these proto messages in other protos, add the appropriate import to your proto definition, e.g.
+```
+import "github.com/solo-io/gloo/projects/gateway2/api/external/kubernetes/api/core/v1/generated.proto";
+```
+and reference the messages with their package name, e.g. `k8s.io.api.core.v1.<message>`
+
+### Updating the protos
+
+Generally we should try to keep the protos in sync with the `k8s.io/api` version we depend on in `go.mod`. Near the top of each `generated.proto` is a comment like this which shows the source of the file, where `<version>` should correspond to the `k8s.io/api` version we are using.
+```
+// This is a copy of https://github.com/kubernetes/api/blob/<version>/core/v1/generated.proto
+// with the imports and go_package changed to gloo paths.
+// Ideally we should update this proto every time we upgrade our k8s.io/api dependency.
+```
+
+Whenever we upgrade our `k8s.io/api` version (to let's say, `<new-version>`) in gloo, we should:
+1. Update each `generated.proto` in this directory with the `<new-version>` copy of the file, copied from the Kubernetes api or apimachinery repo.
+2. Update the comment `This is a copy of...` in each file to have the new source file path.
+3. Re-run codegen via `make install-go-tools generated-code -B`
+
+### Adding new protos
+
+If new Kubernetes protos need to be added:
+
+1. Find the source file (usually look for `generated.proto` in https://github.com/kubernetes/api or https://github.com/kubernetes/apimachinery), on the branch/tag corresponding to the `k8s.io/api` version we are using.
+2. Copy it here, keeping similar directory structure (e.g. if copying a file from `https://github.com/kubernetes/api/blob/<version>/batch/v1/generated.proto`, it should be copied to directory `projects/gateway2/api/external/kubernetes/api/batch/v1/generated.proto` in gloo)
+3. Add a comment near the top of the file, similar to the one shown above in [Updating the protos](#updating-the-protos), which indicates the source of the copied file.
+4. Change the import paths to use gloo repo paths (note, if the file is importing other dependencies that we don't have in this repo yet, those proto files need to be copied over as well).
+5. Update the `go_package` to have the appropriate gloo path, e.g. `option go_package = "github.com/solo-io/gloo/projects/gateway2/pkg/api/external/kubernetes/api/core/v1";`
+6. Re-run codegen via `make install-go-tools generated-code -B`