diff --git a/.gitignore b/.gitignore index 6ae35bd3b..c2c7b55c7 100644 --- a/.gitignore +++ b/.gitignore @@ -45,4 +45,7 @@ serverless.yaml moduletemplate-latest.yaml module-config.yaml -examples/python-text2img/resources/secrets/deepai.env \ No newline at end of file +examples/python-text2img/resources/secrets/deepai.env + +# draw.io +*.bkp diff --git a/README.md b/README.md index 1d083fb3b..a03d40ba9 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,9 @@ Serverless Operator allows deploying the [Serverless](https://kyma-project.io/docs/kyma/latest/01-overview/serverless/) component in the Kyma cluster in compatibility with [Lifecycle Manager](https://github.com/kyma-project/lifecycle-manager). +### Architecture Diagram +![Architecture](./architecture.svg) + ## Install Create the `kyma-system` namespace: diff --git a/architecture.svg b/architecture.svg new file mode 100644 index 000000000..cb4dad415 --- /dev/null +++ b/architecture.svg @@ -0,0 +1,4 @@ + + + +
Serverless Operator
Serverless Operator
Serverless
Serverless
config/operator
serverless operator kustomization
config/operator...
contains
contains
Serverless Operator Deployment
Serverless Operator D...
Serverless
<<Custom Resource Definition>>
Serverless...
deploys
deploys
Serverless controller Deployment
Serverless controller...
config/serverless
serverless helm chart
config/serverles...
Function
<<Custom Resource Definition>>
Function...
Serverless CR
Serverless CR
Function CR
Function CR
applies
applies
applies
applies
deploy to k8s
deploy to k8s
K8s Configuration resources (rbac and etc)
K8s Configuration res...
deploys serverless helm chart with config from serverless cr
deploys serverless helm chart with config from serverless cr
K8s Configuration resources (rbac and etc)
K8s Configuration res...
Function
Function
K8s resources need to function to work
K8s resources need to...
Text is not SVG - cannot display
\ No newline at end of file diff --git a/components/operator/Makefile b/components/operator/Makefile index 2b0eb9bc3..4cf11cf95 100644 --- a/components/operator/Makefile +++ b/components/operator/Makefile @@ -35,6 +35,8 @@ fmt: ## Run go fmt against code. vet: ## Run go vet against code. go vet ./... +##@ Verification + .PHONY: test test: manifests generate fmt vet kubebuilder-assets ## Run unit tests. KUBEBUILDER_CONTROLPLANE_START_TIMEOUT=2m KUBEBUILDER_CONTROLPLANE_STOP_TIMEOUT=2m KUBEBUILDER_ASSETS="$(KUBEBUILDER_ASSETS)" go test ./... -coverprofile cover.out @@ -46,7 +48,7 @@ build: generate fmt vet ## Build operator binary. go build -o bin/operator main.go .PHONY: run -run: manifests generate fmt vet ## Run a controller from your host. +run: manifests generate fmt vet ## Run a operator from your host. go run ./main.go .PHONY: docker-build-dev @@ -87,7 +89,7 @@ uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified $(KUSTOMIZE) build $(CONFIG_OPERATOR)/crd | kubectl delete --ignore-not-found=$(IGNORE_NOT_FOUND) -f - .PHONY: deploy-main -deploy-main: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. +deploy-main: manifests kustomize ## Deploy operator to the K8s cluster specified in ~/.kube/config. kubectl create namespace kyma-system || true $(KUSTOMIZE) build $(CONFIG_OPERATOR_MAIN) | kubectl apply -f - @@ -117,7 +119,7 @@ deploy-local: build-image-operator ## Deploy operator to the K8s cluster specifi IMG=$(IMG) make deploy .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. +undeploy: ## Undeploy operator 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_OPERATOR) | kubectl delete --ignore-not-found=$(IGNORE_NOT_FOUND) -f - .PHONY: render-manifest