Skip to content

Commit b0ea4ff

Browse files
eoinfennessyeoinfennessy
authored
feat(build): introduces controller-gen scaffolding (#121)
* scaffold MeshFederation API and add codegen tools * fix license headers * add PROJECT_DIR to path of license file * use -mod=readonly when installing controller-gen * add manifests target to generate CRDs * change project domain to openshift-service-mesh.io * Run make manifests * Generate CRDs and DeepCopy methods on src file changes * Combine targets to generate CRDs and DeepCopy methods
1 parent bcd9c81 commit b0ea4ff

7 files changed

+314
-19
lines changed

‎Makefile

+18-19
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ PROJECT_DIR:=$(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
22
OUT_DIR:=out
33

44
export ISTIO_VERSION ?= 1.23.0
5+
CONTROLLER_TOOLS_VERSION ?= v0.16.4
56

67
## Required tooling.
78
## Needs to be defined early so that any target depending on given binary can resolve it when not present.
@@ -13,12 +14,18 @@ PROTOC := $(LOCALBIN)/protoc
1314
PROTOC_GEN_GO := $(LOCALBIN)/protoc-gen-go
1415
PROTOC_GEN_GRPC := $(LOCALBIN)/protoc-gen-go-grpc
1516
PROTOC_GEN_DEEPCOPY := $(LOCALBIN)/protoc-gen-golang-deepcopy
17+
CONTROLLER_GEN := $(LOCALBIN)/controller-gen
1618

1719
PROTOBUF_API_DIR := $(PROJECT_DIR)/api/proto/federation
1820
PROTOBUF_API_SRC := $(shell find $(PROTOBUF_API_DIR) -type f -name "*.proto")
1921
API_GEN_DIR=$(PROJECT_DIR)/internal/api
2022
PROTOBUF_GEN := $(shell find $(API_GEN_DIR) -type f -name "*.go")
2123

24+
CRD_SRC_DIR := $(PROJECT_DIR)/api/v1alpha1
25+
CRD_SRC := $(shell find $(CRD_SRC_DIR) -type f -name "*.go")
26+
CRD_GEN_DIR := $(PROJECT_DIR)/chart/crds
27+
CRD_GEN := $(shell find $(CRD_GEN_DIR) -type f -name "*.yaml")
28+
2229
.PHONY: default
2330
default: build add-license fix-imports test
2431

@@ -36,7 +43,7 @@ deps: ## Downloads required dependencies
3643

3744
EXTRA_BUILD_ARGS?=
3845
.PHONY: build
39-
build: deps $(PROTOBUF_GEN) ## Builds the project
46+
build: deps $(PROTOBUF_GEN) $(DEEP_COPY_GEN) $(CRD_GEN) ## Builds the project
4047
go build -C $(PROJECT_DIR)/cmd/federation-controller -o $(PROJECT_DIR)/$(OUT_DIR)/federation-controller $(EXTRA_BUILD_ARGS)
4148

4249
.PHONY: test
@@ -123,43 +130,35 @@ $(PROTOC_GEN_DEEPCOPY):
123130
$(KIND):
124131
@GOBIN=$(LOCALBIN) go install -mod=readonly sigs.k8s.io/[email protected]
125132

133+
$(CONTROLLER_GEN):
134+
GOBIN=$(LOCALBIN) go install -mod=readonly sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
135+
126136
.PHONY: clean
127-
clean:
137+
clean:
128138
@rm -rf $(LOCALBIN) $(PROJECT_DIR)/$(OUT_DIR)
129139

130140
##@ Code Gen
131141

132142
$(PROTOBUF_GEN): $(PROTOBUF_API_SRC) $(PROTOC) $(PROTOC_GEN_GO) $(PROTOC_GEN_GRPC) $(PROTOC_GEN_DEEPCOPY) ## Generates Go files from protobuf-based API files
133143
@PATH=$(LOCALBIN):$$PATH $(PROTOC) --proto_path=$(PROTOBUF_API_DIR) --go_out=$(API_GEN_DIR) --go-grpc_out=$(API_GEN_DIR) --golang-deepcopy_out=:$(API_GEN_DIR) $(PROTOBUF_API_DIR)/**/*.proto
134144

145+
$(CRD_GEN): $(CRD_SRC) $(CONTROLLER_GEN) ## Generates CRDs and DeepCopy method implementations.
146+
$(CONTROLLER_GEN) paths="$(CRD_SRC_DIR)/..." \
147+
crd output:crd:artifacts:config="$(CRD_GEN_DIR)" \
148+
object:headerFile="$(LICENSE_FILE)"
149+
135150
.PHONY: fix-imports
136151
fix-imports: $(GOIMPORTS) ## Fixes imports
137152
$(GOIMPORTS) -local "github.com/openshift-service-mesh/federation" -w $(PROJECT_DIR)/
138153

139-
LICENSE_FILE := /tmp/license.txt
154+
LICENSE_FILE := $(PROJECT_DIR)/hack/boilerplate.go.txt
140155
GO_FILES := $(shell find $(PROJECT_DIR)/ -name '*.go')
141156

142157
.PHONY: add-license
143158
add-license: ## Adds license to all Golang files
144-
@echo "// Copyright Red Hat, Inc." > $(LICENSE_FILE)
145-
@echo "//" >> $(LICENSE_FILE)
146-
@echo "// Licensed under the Apache License, Version 2.0 (the "License");" >> $(LICENSE_FILE)
147-
@echo "// you may not use this file except in compliance with the License." >> $(LICENSE_FILE)
148-
@echo "// You may obtain a copy of the License at" >> $(LICENSE_FILE)
149-
@echo "//" >> $(LICENSE_FILE)
150-
@echo "// http://www.apache.org/licenses/LICENSE-2.0" >> $(LICENSE_FILE)
151-
@echo "//" >> $(LICENSE_FILE)
152-
@echo "// Unless required by applicable law or agreed to in writing, software" >> $(LICENSE_FILE)
153-
@echo "// distributed under the License is distributed on an "AS IS" BASIS," >> $(LICENSE_FILE)
154-
@echo "// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied." >> $(LICENSE_FILE)
155-
@echo "// See the License for the specific language governing permissions and" >> $(LICENSE_FILE)
156-
@echo "// limitations under the License." >> $(LICENSE_FILE)
157-
@echo "" >> $(LICENSE_FILE)
158-
159159
@for file in $(GO_FILES); do \
160160
if ! grep -q "Licensed under the Apache License" $$file; then \
161161
echo "Adding license to $$file"; \
162162
cat $(LICENSE_FILE) $$file > temp && mv temp $$file; \
163163
fi \
164164
done
165-
@rm -f $(LICENSE_FILE)

‎PROJECT

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Code generated by tool. DO NOT EDIT.
2+
# This file is used to track the info used to scaffold your project
3+
# and allow the plugins properly work.
4+
# More info: https://book.kubebuilder.io/reference/project-config.html
5+
domain: openshift-service-mesh.io
6+
layout:
7+
- go.kubebuilder.io/v4
8+
projectName: federation
9+
repo: github.com/openshift-service-mesh/federation
10+
resources:
11+
- api:
12+
crdVersion: v1
13+
controller: true
14+
domain: openshift-service-mesh.io
15+
group: federation
16+
kind: MeshFederation
17+
path: github.com/openshift-service-mesh/federation/api/v1alpha1
18+
version: v1alpha1
19+
version: "3"

‎api/v1alpha1/groupversion_info.go

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Copyright Red Hat, Inc.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the License);
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an AS IS BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
// Package v1alpha1 contains API Schema definitions for the federation v1alpha1 API group.
16+
// +kubebuilder:object:generate=true
17+
// +groupName=federation.openshift-service-mesh.io
18+
package v1alpha1
19+
20+
import (
21+
"k8s.io/apimachinery/pkg/runtime/schema"
22+
"sigs.k8s.io/controller-runtime/pkg/scheme"
23+
)
24+
25+
var (
26+
// GroupVersion is group version used to register these objects.
27+
GroupVersion = schema.GroupVersion{Group: "federation.openshift-service-mesh.io", Version: "v1alpha1"}
28+
29+
// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
30+
SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
31+
32+
// AddToScheme adds the types in this group-version to the given scheme.
33+
AddToScheme = SchemeBuilder.AddToScheme
34+
)

‎api/v1alpha1/meshfederation_types.go

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
// Copyright Red Hat, Inc.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the License);
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an AS IS BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
package v1alpha1
16+
17+
import (
18+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
19+
)
20+
21+
// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN!
22+
// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized.
23+
24+
// MeshFederationSpec defines the desired state of MeshFederation.
25+
type MeshFederationSpec struct {
26+
// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
27+
// Important: Run "make" to regenerate code after modifying this file
28+
29+
// Foo is an example field of MeshFederation. Edit meshfederation_types.go to remove/update
30+
Foo string `json:"foo,omitempty"`
31+
}
32+
33+
// MeshFederationStatus defines the observed state of MeshFederation.
34+
type MeshFederationStatus struct {
35+
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
36+
// Important: Run "make" to regenerate code after modifying this file
37+
}
38+
39+
// +kubebuilder:object:root=true
40+
// +kubebuilder:subresource:status
41+
// +kubebuilder:resource:scope=Cluster
42+
43+
// MeshFederation is the Schema for the meshfederations API.
44+
type MeshFederation struct {
45+
metav1.TypeMeta `json:",inline"`
46+
metav1.ObjectMeta `json:"metadata,omitempty"`
47+
48+
Spec MeshFederationSpec `json:"spec,omitempty"`
49+
Status MeshFederationStatus `json:"status,omitempty"`
50+
}
51+
52+
// +kubebuilder:object:root=true
53+
54+
// MeshFederationList contains a list of MeshFederation.
55+
type MeshFederationList struct {
56+
metav1.TypeMeta `json:",inline"`
57+
metav1.ListMeta `json:"metadata,omitempty"`
58+
Items []MeshFederation `json:"items"`
59+
}
60+
61+
func init() {
62+
SchemeBuilder.Register(&MeshFederation{}, &MeshFederationList{})
63+
}

‎api/v1alpha1/zz_generated.deepcopy.go

+112
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎chart/crds/federation.openshift-service-mesh.io_meshfederations.yaml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
apiVersion: apiextensions.k8s.io/v1
3+
kind: CustomResourceDefinition
4+
metadata:
5+
annotations:
6+
controller-gen.kubebuilder.io/version: v0.16.4
7+
name: meshfederations.federation.openshift-service-mesh.io
8+
spec:
9+
group: federation.openshift-service-mesh.io
10+
names:
11+
kind: MeshFederation
12+
listKind: MeshFederationList
13+
plural: meshfederations
14+
singular: meshfederation
15+
scope: Cluster
16+
versions:
17+
- name: v1alpha1
18+
schema:
19+
openAPIV3Schema:
20+
description: MeshFederation is the Schema for the meshfederations API.
21+
properties:
22+
apiVersion:
23+
description: |-
24+
APIVersion defines the versioned schema of this representation of an object.
25+
Servers should convert recognized schemas to the latest internal value, and
26+
may reject unrecognized values.
27+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
28+
type: string
29+
kind:
30+
description: |-
31+
Kind is a string value representing the REST resource this object represents.
32+
Servers may infer this from the endpoint the client submits requests to.
33+
Cannot be updated.
34+
In CamelCase.
35+
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
36+
type: string
37+
metadata:
38+
type: object
39+
spec:
40+
description: MeshFederationSpec defines the desired state of MeshFederation.
41+
properties:
42+
foo:
43+
description: Foo is an example field of MeshFederation. Edit meshfederation_types.go
44+
to remove/update
45+
type: string
46+
type: object
47+
status:
48+
description: MeshFederationStatus defines the observed state of MeshFederation.
49+
type: object
50+
type: object
51+
served: true
52+
storage: true
53+
subresources:
54+
status: {}

‎hack/boilerplate.go.txt

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Copyright Red Hat, Inc.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the License);
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an AS IS BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+

0 commit comments

Comments
 (0)