TEST Golangci lint GitHub action integ

.github/workflows/presubmit.yaml

@@ -6,16 +6,36 @@ on:
   pull_request:
   workflow_dispatch:
 jobs:
+  golangci-lint:
+    name: golangci-lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: ${{ env.GO_VERSION }}
+          cache: false
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.54
+          args:  --verbose --timeout 30m
+
   presubmit:
     runs-on: ubuntu-latest
     strategy:
         matrix:
-          k8sVersion: ["1.20.x", "1.21.x", "1.22.x", "1.23.x", "1.24.x"]
+          k8sVersion: ["1.24.x"]
     env:
       K8S_VERSION: ${{ matrix.k8sVersion }}
     steps:
     - uses: actions/checkout@v3
     - run: sed -En 's/^go[[:space:]]+([[:digit:].]+)$/GO_VERSION=\1/p' go.mod >> $GITHUB_ENV
+    - uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+        cache: 'pip'
+    - run: pip install -r requirements.txt
     - uses: actions/setup-go@v3
       with:
         go-version: ${{ env.GO_VERSION }}
@@ -29,7 +49,10 @@ jobs:
           ~/.kubebuilder/bin
         key: ${{ runner.os }}-go-cache-${{ hashFiles('**/go.sum') }}
     - run: make toolchain
-    - run: make presubmit
+    - run: make manifest
+    - run: make vet
+    - run: make test
+    - run: make docs
     - name: Send coverage
       env:
         COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.golangci.yaml

@@ -0,0 +1,4 @@
+# https://golangci-lint.run/usage/configuration
+linters:
+  disable:
+    - errcheck

Makefile

@@ -1,12 +1,16 @@
-export KUBEBUILDER_ASSETS ?= ${HOME}/.kubebuilder/bin
-export CLUSTER_NAME ?= $(shell kubectl config view --minify -o jsonpath='{.clusters[].name}' | rev | cut -d"/" -f1 | rev | cut -d"." -f1)
-export CLUSTER_VPC_ID ?= $(shell aws eks describe-cluster --name $(CLUSTER_NAME) | jq -r ".cluster.resourcesVpcConfig.vpcId")
-export AWS_ACCOUNT_ID ?= $(shell aws sts get-caller-identity --query Account --output text)
-export REGION ?= $(shell aws configure get region)
+# For all targets except `help` and default target (which is also `help`), export environment variables
+ifneq (,$(filter-out help,$(MAKECMDGOALS)))
+	export KUBEBUILDER_ASSETS ?= ${HOME}/.kubebuilder/bin
+	export CLUSTER_NAME ?= $(shell kubectl config view --minify -o jsonpath='{.clusters[].name}' | rev | cut -d"/" -f1 | rev | cut -d"." -f1)
+	export CLUSTER_VPC_ID ?= $(shell aws eks describe-cluster --name $(CLUSTER_NAME) | jq -r ".cluster.resourcesVpcConfig.vpcId")
+	export AWS_ACCOUNT_ID ?= $(shell aws sts get-caller-identity --query Account --output text)
+	export REGION ?= $(shell aws configure get region)
+endif
+
 # Image URL to use all building/pushing image targets
 IMG ?= controller:latest
 VERSION ?= $(shell git tag --sort=v:refname | tail -1)
-ECRIMAGES ?=public.ecr.aws/m7r9p7b3/aws-gateway-controller:${VERSION}
+ECRIMAGES ?=public.ecr.aws/aws-application-networking-k8s/aws-gateway-controller:${VERSION}
 
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.22
@@ -45,11 +49,11 @@ help: ## Display this help.
 
 .PHONY: run
 run: ## Run in development mode
-	go run cmd/aws-application-networking-k8s/main.go --debug
+	DEV_MODE=1 LOG_LEVEL=debug go run cmd/aws-application-networking-k8s/main.go
 
 
 .PHONY: presubmit
-presubmit: manifest vet test ## Run all commands before submitting code
+presubmit: manifest vet lint test ## Run all commands before submitting code
 
 .PHONY: vet
 vet: ## Vet the code and dependencies
@@ -63,14 +67,25 @@ vet: ## Vet the code and dependencies
 			exit 1;\
 		fi;}
 
+
+.PHONY: lint
+lint: ## Run the golangci-lint only in local machine
+	if command -v golangci-lint &> /dev/null; then \
+		echo "Running golangci-lint"; \
+		golangci-lint run; \
+	else \
+		echo "Error: golangci-lint is not installed. Please run the 'make toolchain'"; \
+		exit 1; \
+	fi \
+
+
 .PHONY: test
 test: ## Run tests.
-	go test ./pkg/... ./controllers/... -coverprofile coverage.out
+	go test ./pkg/... -coverprofile coverage.out
 
 .PHONY: toolchain
 toolchain: ## Install developer toolchain
 	./hack/toolchain.sh
-	./scripts/gen_mocks.sh
 
 ##@ Deployment
 
@@ -99,6 +114,7 @@ e2e-test-namespace := "e2e-test"
 .PHONY: e2e-test
 e2e-test: ## Run e2e tests against cluster pointed to by ~/.kube/config
 	@kubectl create namespace $(e2e-test-namespace) > /dev/null 2>&1 || true # ignore already exists error
+	LOG_LEVEL=debug
 	cd test && go test \
 		-p 1 \
 		-count 1 \
@@ -116,3 +132,14 @@ e2e-clean: ## Delete eks resources created in the e2e test namespace
 	@kubectl delete namespace $(e2e-test-namespace) > /dev/null 2>&1
 	@kubectl create namespace $(e2e-test-namespace) > /dev/null 2>&1
 	@echo "Done!"
+
+.PHONY: api-reference
+api-reference: ## Update documentation in docs/api-reference.md
+	@cd docgen && \
+	gen-crd-api-reference-docs -config config.json -api-dir "../pkg/apis/applicationnetworking/v1alpha1/" -out-file docs.html && \
+	cat api-reference-base.md docs.html > ../docs/api-reference.md
+
+.PHONY: docs
+docs:
+	mkdir -p site
+	mkdocs build

README.md

@@ -1,16 +1,59 @@
 # AWS Gateway API Controller for VPC Lattice
 
 <p align="center">
-    <img src="docs/images/kubernetes_icon.svg" alt="Kubernetes logo" width="200" />
-    <img src="docs/images/controller.png" alt="AWS Load Balancer logo" width="200" />
+    <img src="docs/images/kubernetes_icon.svg" alt="Kubernetes logo" width="100" /> 
+    <img src="docs/images/controller.png" alt="AWS Load Balancer logo" width="100" />
 </p>
 
 AWS Application Networking is an implementation of the Kubernetes [Gateway API](https://gateway-api.sigs.k8s.io/). This project is designed to run in a Kubernetes cluster and orchestrates AWS VPC Lattice resources using Kubernetes Custom Resource Definitions like Gateway and HTTPRoute.
 
+## Documentation
+
+### Website
+
+The API specification and detailed documentation is available on the project
+website: [https://www.gateway-api-controller.eks.aws.dev/][ghp].
+
+### Concepts
+
+To get started, please read through [API concepts][concepts]. These documents give the necessary background to understand the API and the use-cases it targets.
+
+### Getting started
+
+Once you have a good understanding of the API at a higher-level, check out
+[getting started][getting-started] to install your first Gateway controller and try out
+one of the guides.
+
+### References
+
+A complete API reference, please refer to:
+
+- [API reference][spec]
+- [Go docs for the package][godoc]
+
+## Contributing
+
+Developer guide can be found on the [developer guide page][dev].
+Our Kubernetes Slack channel is [#aws-gateway-api-controller][slack].
+
+### Code of conduct
+
+Participation in the Kubernetes community is governed by the
+[Kubernetes Code of Conduct](code-of-conduct.md).
+
 ## Security
 
 See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
 
 ## License
 
 This project is licensed under the Apache-2.0 License.
+
+[ghp]: https://www.gateway-api-controller.eks.aws.dev/
+[dev]: https://www.gateway-api-controller.eks.aws.dev/contributing/developer/
+[slack]: https://kubernetes.slack.com/messages/aws-gateway-api-controller
+[getting-started]: https://www.gateway-api-controller.eks.aws.dev/guides/getstarted/
+[spec]: https://www.gateway-api-controller.eks.aws.dev/api-reference/
+[concepts]: https://www.gateway-api-controller.eks.aws.dev/concepts/
+[gh_release]: https://github.com/aws/aws-application-networking-k8s/releases/tag/v1.0.1
+[godoc]: https://www.gateway-api-controller.eks.aws.dev/

cmd/aws-application-networking-k8s/main.go

@@ -21,6 +21,7 @@ import (
 	"os"
 
 	"github.com/go-logr/zapr"
+	"go.uber.org/zap/zapcore"
 
 	"github.com/aws/aws-application-networking-k8s/pkg/aws"
 	"github.com/aws/aws-application-networking-k8s/pkg/utils/gwlog"
@@ -38,15 +39,17 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime/schema"
 	"sigs.k8s.io/external-dns/endpoint"
-	gateway_api_v1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
-	gateway_api_v1beta1 "sigs.k8s.io/gateway-api/apis/v1beta1"
+	gwv1alpha2 "sigs.k8s.io/gateway-api/apis/v1alpha2"
+	gwv1beta1 "sigs.k8s.io/gateway-api/apis/v1beta1"
 
-	"github.com/aws/aws-application-networking-k8s/controllers"
+	"github.com/aws/aws-application-networking-k8s/pkg/controllers"
 
 	//+kubebuilder:scaffold:imports
 	anv1alpha1 "github.com/aws/aws-application-networking-k8s/pkg/apis/applicationnetworking/v1alpha1"
 	"github.com/aws/aws-application-networking-k8s/pkg/config"
 	"github.com/aws/aws-application-networking-k8s/pkg/k8s"
+	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
+	"sigs.k8s.io/controller-runtime/pkg/webhook"
 )
 
 var (
@@ -57,8 +60,8 @@ func init() {
 	utilruntime.Must(clientgoscheme.AddToScheme(scheme))
 
 	//+kubebuilder:scaffold:scheme
-	utilruntime.Must(gateway_api_v1alpha2.AddToScheme(scheme))
-	utilruntime.Must(gateway_api_v1beta1.AddToScheme(scheme))
+	utilruntime.Must(gwv1alpha2.AddToScheme(scheme))
+	utilruntime.Must(gwv1beta1.AddToScheme(scheme))
 	utilruntime.Must(anv1alpha1.AddToScheme(scheme))
 	addOptionalCRDs(scheme)
 }
@@ -89,17 +92,16 @@ func main() {
 	var metricsAddr string
 	var enableLeaderElection bool
 	var probeAddr string
-	var debug bool
 
 	flag.StringVar(&metricsAddr, "metrics-bind-address", ":8080", "The address the metric endpoint binds to.")
 	flag.StringVar(&probeAddr, "health-probe-bind-address", ":8081", "The address the probe endpoint binds to.")
-	flag.BoolVar(&debug, "debug", false, "enable debug mode")
 	flag.BoolVar(&enableLeaderElection, "leader-elect", false,
 		"Enable leader election for controller manager. "+
 			"Enabling this will ensure there is only one active controller manager.")
 	flag.Parse()
 
-	log := gwlog.NewLogger(debug)
+	logLevel := logLevel()
+	log := gwlog.NewLogger(logLevel)
 	ctrl.SetLogger(zapr.NewLogger(log.Desugar()).WithName("runtime"))
 
 	setupLog := log.Named("setup")
@@ -113,6 +115,7 @@ func main() {
 		"AccountId", config.AccountID,
 		"DefaultServiceNetwork", config.DefaultServiceNetwork,
 		"ClusterName", config.ClusterName,
+		"LogLevel", logLevel,
 	)
 
 	cloud, err := aws.NewCloud(log.Named("cloud"), aws.CloudConfig{
@@ -126,9 +129,13 @@ func main() {
 	}
 
 	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
-		Scheme:                 scheme,
-		MetricsBindAddress:     metricsAddr,
-		Port:                   9443,
+		Scheme: scheme,
+		Metrics: metricsserver.Options{
+			BindAddress: metricsAddr,
+		},
+		WebhookServer: webhook.NewServer(webhook.Options{
+			Port: 9443,
+		}),
 		HealthProbeBindAddress: probeAddr,
 		LeaderElection:         enableLeaderElection,
 		LeaderElectionID:       "amazon-vpc-lattice.io",
@@ -187,7 +194,12 @@ func main() {
 		setupLog.Fatalf("iam auth policy controller setup failed: %s", err)
 	}
 
-	err = controllers.RegisterVpcAssociationPolicyController(ctrlLog.Named("vpc-association-policy"), mgr, cloud)
+	err = controllers.RegisterTargetGroupPolicyController(ctrlLog.Named("target-group-policy"), mgr)
+	if err != nil {
+		setupLog.Fatalf("target group policy controller setup failed: %s", err)
+	}
+
+	err = controllers.RegisterVpcAssociationPolicyController(ctrlLog.Named("vpc-association-policy"), cloud, finalizerManager, mgr)
 	if err != nil {
 		setupLog.Fatalf("vpc association policy controller setup failed: %s", err)
 	}
@@ -209,3 +221,17 @@ func main() {
 	}
 
 }
+
+func logLevel() zapcore.Level {
+	level := os.Getenv("LOG_LEVEL")
+	switch level {
+	case "debug":
+		return zapcore.DebugLevel
+	case "error":
+		return zapcore.ErrorLevel
+	case "panic":
+		return zapcore.PanicLevel
+	default:
+		return zapcore.InfoLevel
+	}
+}

code-of-conduct.md

@@ -0,0 +1,2 @@
+# Code of Conduct
+The AWS Gateway API Controller project follows the [CNCF Community Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

config/crds/bases/application-networking.k8s.aws_targetgrouppolicies.yaml

@@ -157,7 +157,14 @@ spec:
             - targetRef
             type: object
           status:
-            description: TargetGroupPolicyStatus defines the observed state of AccessLogPolicy.
+            default:
+              conditions:
+              - lastTransitionTime: "1970-01-01T00:00:00Z"
+                message: Waiting for controller
+                reason: NotReconciled
+                status: Unknown
+                type: Accepted
+            description: Status defines the current state of TargetGroupPolicy.
             properties:
               conditions:
                 default:
@@ -171,12 +178,12 @@ spec:
                   reason: Pending
                   status: Unknown
                   type: Programmed
-                description: "Conditions describe the current conditions of the AccessLogPolicy.
+                description: "Conditions describe the current conditions of the TargetGroup.
                   \n Implementations should prefer to express Policy conditions using
                   the `PolicyConditionType` and `PolicyConditionReason` constants
                   so that operators and tools can converge on a common vocabulary
-                  to describe AccessLogPolicy state. \n Known condition types are:
-                  \n * \"Accepted\" * \"Ready\""
+                  to describe TargetGroup state. \n Known condition types are: \n
+                  * \"Accepted\" * \"Ready\""
                 items:
                   description: "Condition contains details for one aspect of the current
                     state of this API Resource. --- This struct is intended for direct
@@ -254,4 +261,5 @@ spec:
         type: object
     served: true
     storage: true
-    subresources: {}
+    subresources:
+      status: {}