forked from labring/sealos
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add object storage controller * add GetUserObjectStorageFlow interface Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --------- Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: nowinkeyy <[email protected]>
- Loading branch information
Showing
57 changed files
with
4,531 additions
and
92 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 |
|---|---|---|
|
|
@@ -12,4 +12,5 @@ use ( | |
| ./license | ||
| ./job/init | ||
| ./pkg | ||
| ./objectstorage | ||
| ) | ||
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
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,3 @@ | ||
| # More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file | ||
| # Ignore build and test binaries. | ||
| testbin/ |
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,26 @@ | ||
|
|
||
| # Binaries for programs and plugins | ||
| *.exe | ||
| *.exe~ | ||
| *.dll | ||
| *.so | ||
| *.dylib | ||
| bin | ||
| testbin/* | ||
| Dockerfile.cross | ||
|
|
||
| # Test binary, build with `go test -c` | ||
| *.test | ||
|
|
||
| # Output of the go coverage tool, specifically when used with LiteIDE | ||
| *.out | ||
|
|
||
| # Kubernetes Generated files - skip generated files, except for vendored files | ||
|
|
||
| !vendor/**/zz_generated.* | ||
|
|
||
| # editor and IDE paraphernalia | ||
| .idea | ||
| *.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,22 @@ | ||
| # Copyright © 2023 sealos. | ||
| # | ||
| # 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. | ||
|
|
||
| FROM gcr.io/distroless/static:nonroot | ||
| ARG TARGETARCH | ||
|
|
||
| WORKDIR / | ||
| USER 65532:65532 | ||
|
|
||
| COPY bin/controller-objectstorage-$TARGETARCH /manager | ||
| ENTRYPOINT ["/manager"] |
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,139 @@ | ||
|
|
||
| # Image URL to use all building/pushing image targets | ||
| IMG ?= ghcr.io/labring/sealos-objectstorage-controller:latest | ||
| # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. | ||
| ENVTEST_K8S_VERSION = 1.23 | ||
|
|
||
| # 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 | ||
|
|
||
| # Setting SHELL to bash allows bash commands to be executed by recipes. | ||
| # This is a requirement for 'setup-envtest.sh' in the test target. | ||
| # 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 commands 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 WebhookConfiguration, ClusterRole and CustomResourceDefinition objects. | ||
| $(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases | ||
|
|
||
| .PHONY: generate | ||
| generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. | ||
| $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." | ||
|
|
||
| .PHONY: fmt | ||
| fmt: ## Run go fmt against code. | ||
| go fmt ./... | ||
|
|
||
| .PHONY: vet | ||
| vet: ## Run go vet against code. | ||
| go vet ./... | ||
|
|
||
| .PHONY: test | ||
| test: manifests generate fmt vet envtest ## Run tests. | ||
| KUBEBUILDER_ASSETS="$(shell $(ENVTEST) --arch=amd64 use $(ENVTEST_K8S_VERSION) -p path)" go test ./... -coverprofile cover.out | ||
|
|
||
| ##@ Build | ||
|
|
||
| .PHONY: build | ||
| build: ## Build manager binary. | ||
| CGO_ENABLED=0 GOOS=linux go build $(shell [ -n "${CRYPTOKEY}" ] && echo "-ldflags '-X github.com/labring/sealos/controllers/pkg/crypto.encryptionKey=${CRYPTOKEY} -X github.com/labring/sealos/controllers/pkg/database.cryptoKey=${CRYPTOKEY}'") -o bin/manager main.go | ||
|
|
||
| .PHONY: run | ||
| run: manifests generate fmt vet ## Run a controller from your host. | ||
| go run ./main.go | ||
|
|
||
| .PHONY: docker-build | ||
| docker-build: test ## Build docker image with the manager. | ||
| docker build -t ${IMG} . | ||
|
|
||
| .PHONY: docker-push | ||
| docker-push: ## Push docker image with the manager. | ||
| docker push ${IMG} | ||
|
|
||
| ##@ 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 - | ||
|
|
||
| .PHONY: deploy | ||
| deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. | ||
| cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG} | ||
| $(KUSTOMIZE) build config/default | kubectl apply -f - | ||
|
|
||
| .PHONY: pre-deploy | ||
| pre-deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. | ||
| cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG} | ||
| $(KUSTOMIZE) build config/default > deploy/manifests/deploy.yaml | ||
|
|
||
|
|
||
| .PHONY: undeploy | ||
| undeploy: ## Undeploy controller 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/default | kubectl delete --ignore-not-found=$(ignore-not-found) -f - | ||
|
|
||
| ##@ Build Dependencies | ||
|
|
||
| ## Location to install dependencies to | ||
| LOCALBIN ?= $(shell pwd)/bin | ||
| $(LOCALBIN): | ||
| mkdir -p $(LOCALBIN) | ||
|
|
||
| ## Tool Binaries | ||
| KUSTOMIZE ?= $(LOCALBIN)/kustomize | ||
| CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen | ||
| ENVTEST ?= $(LOCALBIN)/setup-envtest | ||
|
|
||
| ## Tool Versions | ||
| KUSTOMIZE_VERSION ?= v4.2.0 | ||
| CONTROLLER_TOOLS_VERSION ?= v0.8.0 | ||
|
|
||
| KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | ||
| .PHONY: kustomize | ||
| kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. | ||
| $(KUSTOMIZE): $(LOCALBIN) | ||
| curl -s $(KUSTOMIZE_INSTALL_SCRIPT) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN) | ||
|
|
||
| .PHONY: controller-gen | ||
| controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. | ||
| $(CONTROLLER_GEN): $(LOCALBIN) | ||
| GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION) | ||
|
|
||
| .PHONY: envtest | ||
| envtest: $(ENVTEST) ## Download envtest-setup locally if necessary. | ||
| $(ENVTEST): $(LOCALBIN) | ||
| GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest |
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,25 @@ | ||
| domain: sealos.io | ||
| layout: | ||
| - go.kubebuilder.io/v3 | ||
| projectName: objectstorage | ||
| repo: github/labring/sealos/controllers/objectstorage | ||
| resources: | ||
| - api: | ||
| crdVersion: v1 | ||
| namespaced: true | ||
| controller: true | ||
| domain: sealos.io | ||
| group: objectstorage | ||
| kind: ObjectStorageUser | ||
| path: github/labring/sealos/controllers/objectstorage/api/v1 | ||
| version: v1 | ||
| - api: | ||
| crdVersion: v1 | ||
| namespaced: true | ||
| controller: true | ||
| domain: sealos.io | ||
| group: objectstorage | ||
| kind: ObjectStorageBucket | ||
| path: github/labring/sealos/controllers/objectstorage/api/v1 | ||
| version: v1 | ||
| 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,108 @@ | ||
| # objectstorage | ||
|
|
||
| // TODO(user): Add simple overview of use/purpose | ||
|
|
||
| ## Description | ||
|
|
||
| // TODO(user): An in-depth paragraph about your project and overview of use | ||
|
|
||
| ## Getting Started | ||
|
|
||
| You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for | ||
| testing, or run against a remote cluster. | ||
| **Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever | ||
| cluster `kubectl cluster-info` shows). | ||
|
|
||
| ### Running on the cluster | ||
|
|
||
| 1. Install Instances of Custom Resources: | ||
|
|
||
| ```sh | ||
| kubectl apply -f config/samples/ | ||
| ``` | ||
|
|
||
| 2. Build and push your image to the location specified by `IMG`: | ||
|
|
||
| ```sh | ||
| make docker-build docker-push IMG=<some-registry>/objectstorage:tag | ||
| ``` | ||
|
|
||
| 3. Deploy the controller to the cluster with the image specified by `IMG`: | ||
|
|
||
| ```sh | ||
| make deploy IMG=<some-registry>/objectstorage:tag | ||
| ``` | ||
|
|
||
| ### Uninstall CRDs | ||
|
|
||
| To delete the CRDs from the cluster: | ||
|
|
||
| ```sh | ||
| make uninstall | ||
| ``` | ||
|
|
||
| ### Undeploy controller | ||
|
|
||
| UnDeploy the controller to the cluster: | ||
|
|
||
| ```sh | ||
| make undeploy | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| // TODO(user): Add detailed information on how you would like others to contribute to this project | ||
|
|
||
| ### How it works | ||
|
|
||
| This project aims to follow the | ||
| Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) | ||
|
|
||
| It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/) | ||
| which provides a reconcile function responsible for synchronizing resources untile the desired state is reached on the | ||
| cluster | ||
|
|
||
| ### Test It Out | ||
|
|
||
| 1. Install the CRDs into the cluster: | ||
|
|
||
| ```sh | ||
| make install | ||
| ``` | ||
|
|
||
| 2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running): | ||
|
|
||
| ```sh | ||
| make run | ||
| ``` | ||
|
|
||
| **NOTE:** You can also run this in one step by running: `make install run` | ||
|
|
||
| ### Modifying the API definitions | ||
|
|
||
| If you are editing the API definitions, generate the manifests such as CRs or CRDs using: | ||
|
|
||
| ```sh | ||
| make manifests | ||
| ``` | ||
|
|
||
| **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 2023. | ||
|
|
||
| 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.