generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 231
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1ecfdc1
commit 54fe352
Showing
40 changed files
with
2,069 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Binaries for programs and plugins | ||
*.exe | ||
*.exe~ | ||
*.dll | ||
*.so | ||
*.dylib | ||
bin/* | ||
Dockerfile.cross | ||
|
||
# Test binary, built with `go test -c` | ||
*.test | ||
|
||
# Output of the go coverage tool, specifically when used with LiteIDE | ||
*.out | ||
|
||
# Go workspace file | ||
go.work | ||
|
||
# Kubernetes Generated files - skip generated files, except for vendored files | ||
!vendor/**/zz_generated.* | ||
|
||
# editor and IDE paraphernalia | ||
.idea | ||
.vscode | ||
*.swp | ||
*.swo | ||
*~ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# golangci-lint configuration file | ||
# see: https://golangci-lint.run/usage/configuration/ | ||
|
||
# Settings of specific linters | ||
linters-settings: | ||
gocritic: | ||
enabled-checks: | ||
- dupImport | ||
disabled-checks: | ||
- appendAssign | ||
- exitAfterDefer | ||
goimports: | ||
local-prefixes: sigs.k8s.io/kueue | ||
govet: | ||
enable: | ||
- nilness | ||
perfsprint: | ||
int-conversion: false | ||
errorf: true | ||
sprintf1: false | ||
strconcat: false | ||
revive: | ||
enable-all-rules: false | ||
rules: | ||
- name: empty-lines | ||
- name: var-naming | ||
|
||
# Settings for enabling and disabling linters | ||
linters: | ||
enable: | ||
- copyloopvar | ||
- dupword | ||
- durationcheck | ||
- ginkgolinter | ||
- gocritic | ||
- goimports | ||
- govet | ||
- loggercheck | ||
- misspell | ||
- perfsprint | ||
- revive | ||
- unconvert | ||
|
||
# Settings related to issues | ||
issues: | ||
# Which dirs to exclude: issues from them won't be reported | ||
exclude-dirs: | ||
- bin | ||
# Excluding configuration per-path, per-linter, per-text and per-source | ||
exclude-rules: | ||
- linters: | ||
- staticcheck | ||
# TODO(#768): Drop when incrementing the API version. | ||
text: "SA1019: constants.QueueAnnotation is deprecated" | ||
# Show all issues from a linter | ||
max-issues-per-linter: 0 | ||
# Show all issues with the same text | ||
max-same-issues: 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,168 @@ | ||
# Image URL to use all building/pushing image targets | ||
IMG ?= controller:latest | ||
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. | ||
ENVTEST_K8S_VERSION = 1.30.0 | ||
|
||
# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set) | ||
ifeq (,$(shell go env GOBIN)) | ||
GOBIN=$(shell go env GOPATH)/bin | ||
else | ||
GOBIN=$(shell go env GOBIN) | ||
endif | ||
|
||
GO_CMD ?= go | ||
|
||
# CONTAINER_TOOL defines the container tool to be used for building images. | ||
# Be aware that the target commands are only tested with Docker which is | ||
# scaffolded by default. However, you might want to replace it to use other | ||
# tools. (i.e. podman) | ||
CONTAINER_TOOL ?= docker | ||
|
||
# Setting SHELL to bash allows bash commands to be executed by recipes. | ||
# Options are set to exit when a recipe line exits non-zero or a piped command fails. | ||
SHELL = /usr/bin/env bash -o pipefail | ||
.SHELLFLAGS = -ec | ||
|
||
.PHONY: all | ||
all: build | ||
|
||
##@ General | ||
|
||
# The help target prints out all targets with their descriptions organized | ||
# beneath their categories. The categories are represented by '##@' and the | ||
# target descriptions by '##'. The awk command is responsible for reading the | ||
# entire set of makefiles included in this invocation, looking for lines of the | ||
# file as xyz: ## something, and then pretty-format the target and help. Then, | ||
# if there's a line with ##@ something, that gets pretty-printed as a category. | ||
# More info on the usage of ANSI control characters for terminal formatting: | ||
# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters | ||
# More info on the awk command: | ||
# http://linuxcommand.org/lc3_adv_awk.php | ||
|
||
.PHONY: help | ||
help: ## Display this help. | ||
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) | ||
|
||
##@ Development | ||
|
||
.PHONY: manifests | ||
manifests: controller-gen ## Generate ClusterRole and CustomResourceDefinition objects. | ||
$(CONTROLLER_GEN) crd paths="./..." output:crd:artifacts:config=config/crd/bases | ||
|
||
.PHONY: generate | ||
generate: gomod-download controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. | ||
$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." | ||
./hack/update-codegen.sh $(GO_CMD) | ||
|
||
.PHONY: fmt | ||
fmt: ## Run go fmt against code. | ||
go fmt ./... | ||
|
||
.PHONY: gomod-download | ||
gomod-download: | ||
$(GO_CMD) mod download | ||
|
||
.PHONY: vet | ||
vet: ## Run go vet against code. | ||
go vet ./... | ||
|
||
.PHONY: test | ||
test: manifests generate fmt vet envtest ## Run tests. | ||
KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out | ||
|
||
# Utilize Kind or modify the e2e tests to load the image locally, enabling compatibility with other vendors. | ||
.PHONY: test-e2e # Run the e2e tests against a Kind k8s instance that is spun up. | ||
test-e2e: | ||
go test ./test/e2e/ -v -ginkgo.v | ||
|
||
.PHONY: lint | ||
lint: golangci-lint ## Run golangci-lint linter | ||
$(GOLANGCI_LINT) run | ||
|
||
.PHONY: lint-fix | ||
lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes | ||
$(GOLANGCI_LINT) run --fix | ||
|
||
##@ Build | ||
|
||
.PHONY: build | ||
build: manifests generate fmt vet ## Build manager binary. | ||
go build -o bin/manager cmd/main.go | ||
|
||
.PHONY: run | ||
run: manifests generate fmt vet ## Run a controller from your host. | ||
go run ./cmd/main.go | ||
|
||
.PHONY: build-installer | ||
build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment. | ||
mkdir -p dist | ||
cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG} | ||
$(KUSTOMIZE) build config/default > dist/install.yaml | ||
|
||
##@ Deployment | ||
|
||
ifndef ignore-not-found | ||
ignore-not-found = false | ||
endif | ||
|
||
.PHONY: install | ||
install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config. | ||
$(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f - | ||
|
||
.PHONY: uninstall | ||
uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. | ||
$(KUSTOMIZE) build config/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f - | ||
|
||
##@ Dependencies | ||
|
||
## Location to install dependencies to | ||
LOCALBIN ?= $(shell pwd)/bin | ||
$(LOCALBIN): | ||
mkdir -p $(LOCALBIN) | ||
|
||
## Tool Binaries | ||
KUBECTL ?= kubectl | ||
KUSTOMIZE ?= $(LOCALBIN)/kustomize-$(KUSTOMIZE_VERSION) | ||
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen-$(CONTROLLER_TOOLS_VERSION) | ||
ENVTEST ?= $(LOCALBIN)/setup-envtest-$(ENVTEST_VERSION) | ||
GOLANGCI_LINT = $(LOCALBIN)/golangci-lint-$(GOLANGCI_LINT_VERSION) | ||
|
||
## Tool Versions | ||
KUSTOMIZE_VERSION ?= v5.4.1 | ||
CONTROLLER_TOOLS_VERSION ?= v0.15.0 | ||
ENVTEST_VERSION ?= release-0.18 | ||
GOLANGCI_LINT_VERSION ?= v1.57.2 | ||
|
||
.PHONY: kustomize | ||
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. | ||
$(KUSTOMIZE): $(LOCALBIN) | ||
$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION)) | ||
|
||
.PHONY: controller-gen | ||
controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. | ||
$(CONTROLLER_GEN): $(LOCALBIN) | ||
$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen,$(CONTROLLER_TOOLS_VERSION)) | ||
|
||
.PHONY: envtest | ||
envtest: $(ENVTEST) ## Download setup-envtest locally if necessary. | ||
$(ENVTEST): $(LOCALBIN) | ||
$(call go-install-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest,$(ENVTEST_VERSION)) | ||
|
||
.PHONY: golangci-lint | ||
golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary. | ||
$(GOLANGCI_LINT): $(LOCALBIN) | ||
$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,${GOLANGCI_LINT_VERSION}) | ||
|
||
# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist | ||
# $1 - target path with name of binary (ideally with version) | ||
# $2 - package url which can be installed | ||
# $3 - specific version of package | ||
define go-install-tool | ||
@[ -f $(1) ] || { \ | ||
set -e; \ | ||
package=$(2)@$(3) ;\ | ||
echo "Downloading $${package}" ;\ | ||
GOBIN=$(LOCALBIN) go install $${package} ;\ | ||
mv "$$(echo "$(1)" | sed "s/-$(3)$$//")" $(1) ;\ | ||
} | ||
endef |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# Code generated by tool. DO NOT EDIT. | ||
# This file is used to track the info used to scaffold your project | ||
# and allow the plugins properly work. | ||
# More info: https://book.kubebuilder.io/reference/project-config.html | ||
domain: x-k8s.io | ||
layout: | ||
- go.kubebuilder.io/v4 | ||
projectName: kjobctl | ||
repo: x-k8s.io/kueue | ||
resources: | ||
- api: | ||
crdVersion: v1 | ||
namespaced: true | ||
domain: x-k8s.io | ||
group: kueue.experimental | ||
kind: VolumeBundle | ||
path: x-k8s.io/kueue/apis/v1alpha1 | ||
version: v1alpha1 | ||
version: "3" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
# kjobctl | ||
// TODO(user): Add simple overview of use/purpose | ||
|
||
## Description | ||
// TODO(user): An in-depth paragraph about your project and overview of use | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
- go version v1.22.0+ | ||
- docker version 17.03+. | ||
- kubectl version v1.11.3+. | ||
- Access to a Kubernetes v1.11.3+ cluster. | ||
|
||
### To Deploy on the cluster | ||
**Build and push your image to the location specified by `IMG`:** | ||
|
||
```sh | ||
make docker-build docker-push IMG=<some-registry>/kjobctl:tag | ||
``` | ||
|
||
**NOTE:** This image ought to be published in the personal registry you specified. | ||
And it is required to have access to pull the image from the working environment. | ||
Make sure you have the proper permission to the registry if the above commands don’t work. | ||
|
||
**Install the CRDs into the cluster:** | ||
|
||
```sh | ||
make install | ||
``` | ||
|
||
**Deploy the Manager to the cluster with the image specified by `IMG`:** | ||
|
||
```sh | ||
make deploy IMG=<some-registry>/kjobctl:tag | ||
``` | ||
|
||
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin | ||
privileges or be logged in as admin. | ||
|
||
**Create instances of your solution** | ||
You can apply the samples (examples) from the config/sample: | ||
|
||
```sh | ||
kubectl apply -k config/samples/ | ||
``` | ||
|
||
>**NOTE**: Ensure that the samples has default values to test it out. | ||
### To Uninstall | ||
**Delete the instances (CRs) from the cluster:** | ||
|
||
```sh | ||
kubectl delete -k config/samples/ | ||
``` | ||
|
||
**Delete the APIs(CRDs) from the cluster:** | ||
|
||
```sh | ||
make uninstall | ||
``` | ||
|
||
**UnDeploy the controller from the cluster:** | ||
|
||
```sh | ||
make undeploy | ||
``` | ||
|
||
## Project Distribution | ||
|
||
Following are the steps to build the installer and distribute this project to users. | ||
|
||
1. Build the installer for the image built and published in the registry: | ||
|
||
```sh | ||
make build-installer IMG=<some-registry>/kjobctl:tag | ||
``` | ||
|
||
NOTE: The makefile target mentioned above generates an 'install.yaml' | ||
file in the dist directory. This file contains all the resources built | ||
with Kustomize, which are necessary to install this project without | ||
its dependencies. | ||
|
||
2. Using the installer | ||
|
||
Users can just run kubectl apply -f <URL for YAML BUNDLE> to install the project, i.e.: | ||
|
||
```sh | ||
kubectl apply -f https://raw.githubusercontent.com/<org>/kjobctl/<tag or branch>/dist/install.yaml | ||
``` | ||
|
||
## Contributing | ||
// TODO(user): Add detailed information on how you would like others to contribute to this project | ||
|
||
**NOTE:** Run `make help` for more information on all potential `make` targets | ||
|
||
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html) | ||
|
||
## License | ||
|
||
Copyright 2024. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
|
Oops, something went wrong.