Skip to content

Commit 47fed3d

Browse files
Add EAS api implementation
1. add a new eas service in nsx-operator 2. register eas service to k8s api server 3. start a http service on 9553 port 4. add eas service implentations for ip usages api yamls
1 parent ff79596 commit 47fed3d

46 files changed

Lines changed: 8968 additions & 399 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.golangci.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,13 @@ linters:
6060
- staticcheck
6161
# v1.EndpointSubset is deprecated in k8s v1.33+; same migration scope as above.
6262
text: "SA1019: v1.EndpointSubset is deprecated"
63+
- linters:
64+
- staticcheck
65+
# kubefake.NewSimpleClientset is deprecated in favour of NewClientset, which
66+
# requires generated apply configurations (--with-applyconfig). Until apply
67+
# configs are generated for this project the existing test helpers cannot be
68+
# migrated, so suppress the warning project-wide.
69+
text: "SA1019: kubefake.NewSimpleClientset is deprecated"
6370

6471
formatters:
6572
enable:

Makefile

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ changecrd: manifests generate generate-api-docs
4646
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
4747
$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="github.com/vmware-tanzu/nsx-operator/pkg/apis/legacy/v1alpha1" output:crd:artifacts:config=build/yaml/crd/legacy/
4848
$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="github.com/vmware-tanzu/nsx-operator/pkg/apis/vpc/v1alpha1" output:crd:artifacts:config=build/yaml/crd/vpc/
49-
$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="github.com/vmware-tanzu/nsx-operator/pkg/apis/eas/v1alpha1" output:crd:artifacts:config=build/yaml/crd/eas/
49+
# NOTE: EAS types are served by the generic API server (via APIService), NOT as CRDs.
50+
# Do NOT run controller-gen crd for pkg/apis/eas/v1alpha1 — installing EAS CRDs alongside
51+
# the APIService causes duplicate-resource conflicts in kube-apiserver.
5052

5153
.PHONY: generate
5254
generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
@@ -97,6 +99,11 @@ build-clean: generate fmt vet ## Build clean binary.
9799
@mkdir -p $(BINDIR)
98100
GOOS=linux go build -o $(BINDIR)/clean $(GOFLAGS) -ldflags '$(LDFLAGS)' cmd_clean/main.go
99101

102+
.PHONY: build-eas
103+
build-eas: generate fmt vet ## Build EAS (Extension API Server) binary.
104+
@mkdir -p $(BINDIR)
105+
GOOS=linux go build -o $(BINDIR)/eas $(GOFLAGS) -ldflags '$(LDFLAGS)' cmd_eas/main.go
106+
100107
.PHONY: run
101108
run: manifests generate fmt vet ## Run a controller from your host.
102109
go run ./cmd/main.go
@@ -113,6 +120,10 @@ docker-push: ## Push docker image with the manager.
113120
photon:
114121
docker build -t github.com/vmware-tanzu/nsx-operator -f build/image/photon/Dockerfile .
115122

123+
.PHONY: eas
124+
eas:
125+
docker build -t github.com/vmware-tanzu/nsx-eas -f build/image/eas/Dockerfile .
126+
116127
.PHONY: clean
117128
clean:
118129
@rm -rf $(BINDIR)
@@ -164,6 +175,28 @@ code-generator: ## Download code-generator locally if necessary.
164175
generated: code-generator
165176
./hack/update-codegen.sh
166177

178+
OPENAPI_GEN = $(shell pwd)/bin/openapi-gen
179+
# openapi-gen moved from k8s.io/code-generator to k8s.io/kube-openapi (since ~v0.27).
180+
# We install it directly via "go install" in the project root so it uses the
181+
# version already pinned in go.mod without needing to create a throw-away module.
182+
.PHONY: openapi-gen
183+
openapi-gen: ## Build openapi-gen binary into bin/ (uses k8s.io/kube-openapi version from go.mod).
184+
@[ -f $(OPENAPI_GEN) ] || GOBIN=$(CURDIR)/bin go install k8s.io/kube-openapi/cmd/openapi-gen
185+
186+
.PHONY: generate-eas-openapi
187+
generate-eas-openapi: openapi-gen ## Generate OpenAPI definitions for EAS types plus the apimachinery meta/v1 and version types they reference.
188+
$(OPENAPI_GEN) \
189+
--output-dir pkg/apis/eas/v1alpha1 \
190+
--output-pkg github.com/vmware-tanzu/nsx-operator/pkg/apis/eas/v1alpha1 \
191+
--output-file zz_generated.openapi.go \
192+
--go-header-file hack/boilerplate.go.txt \
193+
--report-filename - \
194+
github.com/vmware-tanzu/nsx-operator/pkg/apis/eas/v1alpha1 \
195+
k8s.io/apimachinery/pkg/apis/meta/v1 \
196+
k8s.io/apimachinery/pkg/version
197+
@echo ""
198+
@echo "Generated pkg/apis/eas/v1alpha1/zz_generated.openapi.go"
199+
167200
CRD_REF_DOCS = $(shell pwd)/bin/crd-ref-docs
168201
.PHONY: crd-ref-docs
169202
crd-ref-docs: ## Install crd-ref-docs

build/image/eas/Dockerfile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
FROM golang:1.25.7 as golang-build
2+
3+
WORKDIR /source
4+
5+
COPY . /source
6+
RUN CGO_ENABLED=0 go build -o eas cmd_eas/main.go
7+
8+
FROM photon
9+
10+
RUN tdnf -y install shadow && \
11+
useradd -s /bin/bash eas
12+
13+
COPY --from=golang-build /source/eas /usr/local/bin/
14+
15+
USER eas
16+
17+
ENTRYPOINT ["/usr/local/bin/eas"]

build/yaml/crd/eas/eas.nsx.vmware.com_vpcipaddressusages.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ spec:
107107
- start
108108
type: object
109109
type: array
110-
name:
110+
ipBlockName:
111+
description: IPBlockName is the NSX resource ID of the IP block
112+
(the leaf segment of the policy path).
111113
type: string
112114
percentageUsed:
113115
description: Percentage of used IP address space.

build/yaml/eas/apiservice.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ spec:
1010
service:
1111
name: nsx-eas
1212
namespace: vmware-system-nsx
13-
insecureSkipTLSVerify: true
13+
insecureSkipTLSVerify: true

build/yaml/eas/clusterrole.yaml

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# nsx-eas-reader: read access to EAS API resources for authenticated cluster users.
12
apiVersion: rbac.authorization.k8s.io/v1
23
kind: ClusterRole
34
metadata:
@@ -22,4 +23,29 @@ roleRef:
2223
subjects:
2324
- apiGroup: rbac.authorization.k8s.io
2425
kind: Group
25-
name: system:authenticated
26+
name: system:authenticated
27+
---
28+
# nsx-eas-server: permissions needed by the nsx-eas server process itself to
29+
# self-register its APIService with kube-apiserver at startup
30+
# (registerExtensionAPIService in pkg/eas/server/apiservice_register.go).
31+
apiVersion: rbac.authorization.k8s.io/v1
32+
kind: ClusterRole
33+
metadata:
34+
name: nsx-eas-server
35+
rules:
36+
- apiGroups: ["apiregistration.k8s.io"]
37+
resources: ["apiservices"]
38+
verbs: ["get", "create", "update", "patch"]
39+
---
40+
apiVersion: rbac.authorization.k8s.io/v1
41+
kind: ClusterRoleBinding
42+
metadata:
43+
name: nsx-eas-server-binding
44+
roleRef:
45+
apiGroup: rbac.authorization.k8s.io
46+
kind: ClusterRole
47+
name: nsx-eas-server
48+
subjects:
49+
- kind: ServiceAccount
50+
name: nsx-ncp
51+
namespace: vmware-system-nsx

build/yaml/eas/eas-service.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
apiVersion: v1
2+
kind: Service
3+
metadata:
4+
name: nsx-eas
5+
namespace: vmware-system-nsx
6+
labels:
7+
app.kubernetes.io/name: service
8+
app.kubernetes.io/instance: eas-service
9+
app.kubernetes.io/component: eas
10+
app.kubernetes.io/created-by: nsx-operator
11+
app.kubernetes.io/part-of: nsx-operator
12+
app.kubernetes.io/managed-by: kustomize
13+
spec:
14+
ports:
15+
- port: 443
16+
targetPort: 9553
17+
protocol: TCP
18+
selector:
19+
component: nsx-ncp

build/yaml/eas/service.yaml

Lines changed: 0 additions & 12 deletions
This file was deleted.

cmd_eas/main.go

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
/* Copyright © 2026 Broadcom, Inc. All Rights Reserved.
2+
SPDX-License-Identifier: Apache-2.0 */
3+
4+
package main
5+
6+
import (
7+
"context"
8+
"fmt"
9+
"os"
10+
"os/signal"
11+
"syscall"
12+
"time"
13+
14+
"k8s.io/apimachinery/pkg/runtime"
15+
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
16+
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
17+
k8sclient "sigs.k8s.io/controller-runtime/pkg/client"
18+
logf "sigs.k8s.io/controller-runtime/pkg/log"
19+
20+
vpcv1alpha1 "github.com/vmware-tanzu/nsx-operator/pkg/apis/vpc/v1alpha1"
21+
"github.com/vmware-tanzu/nsx-operator/pkg/config"
22+
"github.com/vmware-tanzu/nsx-operator/pkg/eas"
23+
"github.com/vmware-tanzu/nsx-operator/pkg/eas/server"
24+
"github.com/vmware-tanzu/nsx-operator/pkg/logger"
25+
"github.com/vmware-tanzu/nsx-operator/pkg/nsx"
26+
pkgutil "github.com/vmware-tanzu/nsx-operator/pkg/util"
27+
)
28+
29+
// scheme holds only the types that the VPC info provider and EAS storage layer
30+
// read from kube-apiserver (VPCNetworkConfiguration, Subnet, core types …).
31+
// EAS API types (VPCIPAddressUsage etc.) are served entirely from NSX data
32+
// and live in the generic API server's own scheme (pkg/eas/server/scheme.go).
33+
var scheme = runtime.NewScheme()
34+
35+
func init() {
36+
utilruntime.Must(clientgoscheme.AddToScheme(scheme))
37+
utilruntime.Must(vpcv1alpha1.AddToScheme(scheme))
38+
}
39+
40+
func main() {
41+
// config.AddFlags registers all flags (including -nsxconfig and -log-level)
42+
// and calls flag.Parse() internally.
43+
config.AddFlags()
44+
45+
cf, err := config.NewNSXOperatorConfigFromFile()
46+
if err != nil {
47+
fmt.Fprintf(os.Stderr, "Failed to read config: %v\n", err)
48+
os.Exit(1)
49+
}
50+
51+
log := logger.ZapCustomLogger(cf.DefaultConfig.Debug, config.LogLevel)
52+
logger.Log = log
53+
// Register the logger with controller-runtime so that internal packages
54+
// (NSX client keepalive, etc.) that use logr / controller-runtime logging
55+
// emit through the same zap logger rather than printing the
56+
// "log.SetLogger was never called" warning.
57+
logf.SetLogger(log.Logger)
58+
59+
log.Info("Starting NSX Extension API Server")
60+
61+
// Generate TLS certificates for the EAS HTTPS server.
62+
// The generic API server (k8s.io/apiserver) uses dynamic certificate loading
63+
// via dynamiccertificates.NewDynamicServingContentFromFiles, so it
64+
// automatically picks up renewed cert files without a pod restart.
65+
// The returned CA PEM is injected into the APIService caBundle so that
66+
// kube-apiserver can verify the EAS TLS connection.
67+
caCert, err := pkgutil.GenerateEASCerts()
68+
if err != nil {
69+
log.Error(err, "Failed to generate EAS certificates")
70+
os.Exit(1)
71+
}
72+
log.Info("EAS certificates generated successfully")
73+
go refreshEASCertPeriodically()
74+
75+
// Initialize NSX client.
76+
nsxClient := nsx.GetClient(cf)
77+
if nsxClient == nil {
78+
log.Error(nil, "Failed to get NSX client")
79+
os.Exit(1)
80+
}
81+
log.Info("NSX client initialized")
82+
83+
// Build the k8s REST config.
84+
cfg, err := pkgutil.GetConfig()
85+
if err != nil {
86+
log.Error(err, "Failed to get k8s REST config")
87+
os.Exit(1)
88+
}
89+
90+
// Build a direct (non-cached) k8s client.
91+
// EAS reads Namespaces, VPCNetworkConfiguration CRs, and Subnet CRs on
92+
// each request; the network round-trip to NSX dominates latency, so the
93+
// cost of uncached k8s reads is negligible.
94+
client, err := k8sclient.New(cfg, k8sclient.Options{Scheme: scheme})
95+
if err != nil {
96+
log.Error(err, "Failed to create k8s client")
97+
os.Exit(1)
98+
}
99+
100+
vpcProvider := eas.NewK8sVPCInfoProvider(client)
101+
// Pass the kubeconfig file from ncp.ini [k8s].kubeconfig so the EAS server
102+
// uses it for delegated auth/authz calls instead of reading the
103+
// extension-apiserver-authentication ConfigMap from kube-system.
104+
srv := server.NewEASServer(nsxClient, vpcProvider, client, cfg, cf.K8sConfig.KubeConfigFile, caCert)
105+
106+
// Run until SIGTERM or SIGINT.
107+
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
108+
defer stop()
109+
110+
log.Info("Starting EAS server")
111+
if err := srv.Start(ctx); err != nil {
112+
log.Error(err, "EAS server exited with error")
113+
os.Exit(1)
114+
}
115+
}
116+
117+
// refreshEASCertPeriodically regenerates the EAS TLS certificate every 30 days.
118+
// The generic API server loads certs via dynamiccertificates.NewDynamicServingContentFromFiles,
119+
// which watches the cert files for changes and reloads them automatically — so new
120+
// certs are picked up without a pod restart.
121+
func refreshEASCertPeriodically() {
122+
ticker := time.NewTicker(30 * 24 * time.Hour)
123+
defer ticker.Stop()
124+
for range ticker.C {
125+
logger.Log.Info("Refreshing EAS certificates...")
126+
if _, err := pkgutil.GenerateEASCerts(); err != nil {
127+
logger.Log.Error(err, "Failed to refresh EAS certificates")
128+
} else {
129+
logger.Log.Info("EAS certificates refreshed successfully")
130+
}
131+
}
132+
}

0 commit comments

Comments
 (0)