Skip to content

Commit 235a578

Browse files
tardieutardieu
committed
Initial implementation
1 parent 5b03486 commit 235a578

14 files changed

+1026
-96
lines changed

‎.golangci.yml

+32-23
Original file line numberDiff line numberDiff line change
@@ -9,32 +9,41 @@ issues:
99
# restore some of the defaults
1010
# (fill in the rest as needed)
1111
exclude-rules:
12-
- path: "api/*"
13-
linters:
14-
- lll
15-
- path: "internal/*"
16-
linters:
17-
- dupl
18-
- lll
19-
linters:
20-
disable-all: true
21-
enable:
22-
- dupl
23-
- errcheck
24-
- exportloopref
12+
- path: "test/*"
13+
linters:
2514
- goconst
26-
- gocyclo
27-
- gofmt
28-
- goimports
29-
- gosimple
30-
- govet
31-
- ineffassign
3215
- lll
33-
- misspell
34-
- nakedret
3516
- prealloc
3617
- staticcheck
37-
- typecheck
38-
- unconvert
3918
- unparam
4019
- unused
20+
- ineffassign
21+
- path: "api/*"
22+
linters:
23+
- lll
24+
- path: "internal/*"
25+
linters:
26+
- dupl
27+
- lll
28+
linters:
29+
disable-all: true
30+
enable:
31+
- dupl
32+
- errcheck
33+
- exportloopref
34+
- goconst
35+
- gocyclo
36+
- gofmt
37+
- goimports
38+
- gosimple
39+
- govet
40+
- ineffassign
41+
- lll
42+
- misspell
43+
- nakedret
44+
- prealloc
45+
- staticcheck
46+
- typecheck
47+
- unconvert
48+
- unparam
49+
- unused

‎.pre-commit-config.yaml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
repos:
2+
- repo: https://github.com/dnephin/pre-commit-golang
3+
rev: v0.5.1
4+
hooks:
5+
- id: go-fmt
6+
- id: go-mod-tidy
7+
- repo: local
8+
hooks:
9+
- id: golangci-lint
10+
name: golangci-lint
11+
entry: make lint-fix
12+
language: system
13+
pass_filenames: false
14+
- repo: https://github.com/google/yamlfmt
15+
rev: v0.10.0
16+
hooks:
17+
- id: yamlfmt
18+
exclude: ^deployment/mcad-controller|config/crd/bases/.*\.yaml|config/rbac/role\.yaml
19+
- repo: https://github.com/pre-commit/pre-commit-hooks
20+
rev: v4.5.0
21+
hooks:
22+
- id: trailing-whitespace
23+
- id: end-of-file-fixer
24+
exclude: hack/boilerplate.go.txt
25+
- id: mixed-line-ending
26+
args: ["--fix=lf"]

‎.yamlfmt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
formatter:
2+
type: basic
3+
indentless_arrays: true
4+
retain_line_breaks: true
5+
max_line_length: 80

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎Makefile

+35-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11

2+
# Build info
3+
GIT_BRANCH := $(shell git symbolic-ref --short HEAD 2>&1 | grep -v fatal)
4+
ifneq ($(strip $(GIT_BRANCH)),)
5+
# replace invalid characters that might exist in the branch name
6+
TAG := $(shell echo ${GIT_BRANCH} | sed 's/[^a-zA-Z0-9]/-/g')
7+
else
8+
TAG := detached
9+
endif
10+
RELEASE_VER := $(shell git describe --always --tags --abbrev=0)
11+
TAG := ${TAG}-${RELEASE_VER}
12+
BUILD_DATE := $(shell date +%Y-%m-%d\ %H:%M)
13+
BUILD_TAG_SHA := $(shell git rev-list --abbrev-commit --tags --max-count=1)
14+
BUILD_SHA := $(shell git rev-parse --short HEAD)
15+
BUILD_VERSION := ${TAG}
16+
ifneq ($(BUILD_SHA), $(BUILD_TAG_SHA))
17+
BUILD_VERSION := ${BUILD_VERSION}-${BUILD_SHA}
18+
endif
19+
ifneq ($(shell git status --porcelain),)
20+
BUILD_VERSION := ${BUILD_VERSION}-dirty
21+
endif
22+
223
# Image URL to use all building/pushing image targets
3-
IMG ?= controller:latest
24+
ifeq ($(strip $(quay_repository)),)
25+
IMG=appwrapper:${TAG}
26+
else
27+
IMG=${quay_repository}/appwrapper:${TAG}
28+
endif
29+
430
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
531
ENVTEST_K8S_VERSION = 1.29.0
632

@@ -81,11 +107,16 @@ lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
81107

82108
.PHONY: build
83109
build: manifests generate fmt vet ## Build manager binary.
84-
go build -o bin/manager cmd/main.go
110+
go build \
111+
-ldflags " \
112+
-X 'main.BuildVersion=$(BUILD_VERSION)' \
113+
-X 'main.BuildDate=$(BUILD_DATE)' \
114+
" \
115+
-o bin/manager cmd/main.go
85116

86117
.PHONY: run
87118
run: manifests generate fmt vet ## Run a controller from your host.
88-
go run ./cmd/main.go
119+
go run ./cmd/main.go --metrics-bind-address=localhost:0 --health-probe-bind-address=localhost:0
89120

90121
# If you wish to build the manager image targeting other platforms you can use the --platform flag.
91122
# (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it.
@@ -166,7 +197,7 @@ GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-$(GOLANGCI_LINT_VERSION)
166197
KUSTOMIZE_VERSION ?= v5.3.0
167198
CONTROLLER_TOOLS_VERSION ?= v0.14.0
168199
ENVTEST_VERSION ?= latest
169-
GOLANGCI_LINT_VERSION ?= v1.54.2
200+
GOLANGCI_LINT_VERSION ?= v1.55.2
170201

171202
.PHONY: kustomize
172203
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.

0 commit comments

Comments
 (0)