Feat: project initiation (#1)

Author: alex-wangxy

.github/workflows/ci-build.yml

@@ -4,43 +4,45 @@
 name: CI-Build
 
 on:
-  push:
-    branches:
-      - main
-      - release-*
-  pull_request:
-    branches:
-      - main
-      - release-*
+  release:
+    types:
+      - published
 
 jobs:
   build-docker-images:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: Get the version
+      - name: Get Short SHA
+        id: slug
+        run: echo "git_revision=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Get Version
         id: get_version
         run: |
-          VERSION=${GITHUB_REF#refs/tags/}
+          if [[ "${{ github.ref_name }}" =~ ^[.\|v][0-9]{1,}.[0-9]{1,}[.\|-][0-9]{1,} ]];then
+            VERSION=${{ github.ref_name }}
+          else
+            VERSION="latest"
+          fi
           echo "VERSION=${VERSION}" >> $GITHUB_OUTPUT
 
-      - name: Get image registry
-        id: get_image_registry
-        run: |
-          echo "IMG_REGISTRY=${{ secrets.NX_ALIYUN_REGISTRY }}" >> $GITHUB_OUTPUT
-
-#      - name: Docker Login
-#        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
-#        with:
-#          registry: ${{ secrets.NX_ALIYUN_REGISTRY }}
-#          username: ${{ secrets.NX_ALIYUN_USERNAME }}
-#          password: ${{ secrets.NX_ALIYUN_PASSWORD }}
-
-#      - name: Build Images
-#        run: make docker-build-apiserver IMG_REGISTRY=${{ steps.get_image_registry.outputs.IMG_REGISTRY }} VERSION=${{ steps.get_version.outputs.VERSION }}
-#
-#      - name: Push Images
-#        run: make docker-push-apiserver IMG_REGISTRY=${{ steps.get_image_registry.outputs.IMG_REGISTRY }} VERSION=${{ steps.get_version.outputs.VERSION }}
 
+      - name: Docker Login
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+        with:
+          username: ${{ secrets.REG_USER }}
+          password: ${{ secrets.REG_PASSWD }}
 
+      - name: Build Images
+        run: |
+          if [[ "${{ github.ref_name }}" =~ ^[.\|v][0-9]{1,}.[0-9]{1,}[.\|-][0-9]{1,} ]];then
+            GIT_VERSION=${{ github.ref_name }}
+          else:
+            GIT_VERSION=${{ steps.slug.outputs.git_revision }}
+          fi
+          make docker-build IMG_REGISTRY=${{ secrets.CONTAINER_REGISTRY }} VERSION=${{ steps.get_version.outputs.VERSION }}
+
+      - name: Push Images
+        run: make docker-push IMG_REGISTRY=${{ secrets.CONTAINER_REGISTRY }} VERSION=${{ steps.get_version.outputs.VERSION }}

.github/workflows/ci-chart.yml

@@ -0,0 +1,42 @@
+name: Publish Chart
+
+on:
+  release:
+    types:
+      - published
+
+permissions:
+  contents: read
+
+jobs:
+  publish-charts:
+    env:
+      HELM_CHART_DIR: charts/kdp-oam-operator
+
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
+
+      - name: Get Version
+        id: get_version
+        run: |
+          CHART_VERSION=${GITHUB_REF#refs/tags/}
+          echo "CHART_VERSION=${CHART_VERSION}" >> $GITHUB_OUTPUT
+
+      - name: Install Helm
+        uses: azure/setup-helm@5119fcb9089d432beecbf79bb2c7915207344b78
+        with:
+          version: v3.8.2
+
+      - name: Docker Login
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+        with:
+          username: ${{ secrets.REG_USER }}
+          password: ${{ secrets.REG_PASSWD }}
+
+      - name: Tag helm chart and push to registry
+        run: |
+          chart_version=${{ steps.get_version.outputs.CHART_VERSION }}
+          sed -i "s/v1.0.0/${chart_version}/g" $HELM_CHART_DIR/Chart.yaml
+          helm package ./charts/kdp-oam-operator
+          helm push kdp-oam-operator-chart-${chart_version}.tgz  oci://${{ secrets.CONTAINER_REGISTRY }}/linktimecloud

.github/workflows/unit-test.yml

@@ -16,7 +16,7 @@ permissions:
 
 env:
   # Common versions
-  GO_VERSION: "1.21"
+  GO_VERSION: "1.19"
 
 jobs:
   detect-noop:
@@ -58,5 +58,5 @@ jobs:
           key: ${{ runner.os }}-pkg-${{ hashFiles('**/go.sum') }}
           restore-keys: ${{ runner.os }}-pkg-
 
-      # - name: Run Make test
-      #   run: make test
+      - name: Run Make test
+        run: make test

Dockerfile

@@ -0,0 +1,49 @@
+# Build the manager binary
+FROM golang:1.19 as builder
+ARG TARGETOS
+ARG TARGETARCH
+ARG VERSION
+ARG GITVERSION
+
+WORKDIR /workspace
+# Copy the Go Modules manifests
+COPY go.mod go.mod
+COPY go.sum go.sum
+# cache deps before building and copying source so that we don't need to re-download as much
+# and so that source changes don't invalidate our downloaded layer
+
+# It's a proxy for CN developer, please unblock it if you have network issue
+#ARG GOPROXY
+#ENV GOPROXY=${GOPROXY:-https://goproxy.cn}
+
+RUN go mod download
+
+# Copy the go source
+COPY api/ api/
+COPY cmd/ cmd/
+COPY pkg/ pkg/
+COPY version/ version/
+
+# Build
+# the GOARCH has not a default value to allow the binary be built according to the host where the command
+# was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO
+# the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore,
+# by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build  -a -ldflags "-s -w -X kdp-oam-operator/version.CoreVersion=${VERSION:-undefined} -X kdp-oam-operator/version.GitRevision=${GITVERSION:-undefined}" -o manager cmd/bdc/main.go
+
+# Use distroless as minimal base image to package the manager binary
+# Refer to https://github.com/GoogleContainerTools/distroless for more details
+FROM ${BASE_IMAGE:-alpine:3.15}
+RUN sed -i 's/dl-cdn.alpinelinux.org/mirrors.aliyun.com/g' /etc/apk/repositories && \
+    apk add --no-cache ca-certificates tzdata bash expat && \
+    rm -rf /var/cache/apk/*
+
+ENV TZ=${TZ:-Asia/Shanghai}
+RUN cp /usr/share/zoneinfo/${TZ} /etc/localtime
+RUN echo ${TZ} > /etc/timezone
+WORKDIR /
+
+COPY --from=builder /workspace/manager .
+USER 65532:65532
+
+ENTRYPOINT ["/manager"]

Makefile

@@ -0,0 +1,115 @@
+include makefiles/const.mk
+include makefiles/build-image.mk
+include makefiles/build-swagger.mk
+include makefiles/build-bundle.mk
+include makefiles/build-catalog.mk
+include makefiles/build-helm-package.mk
+include makefiles/dependency.mk
+
+# VERSION defines the project version for the bundle.
+# Update this value when you upgrade the version of your project.
+# To re-generate a bundle for another specific version without changing the standard setup, you can:
+# - use the VERSION as arg of the bundle target (e.g make bundle VERSION=0.0.2)
+# - use environment variables to overwrite this value (e.g export VERSION=0.0.2)
+VERSION ?= 0.0.1
+
+.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
+cli: ## Generate bdcctl cli.
+	go build -o bdcctl reference/cmd/cli/main.go
+
+.PHONY: manifests
+manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
+	$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./api/..." output:crd:artifacts:config=config/crd/bases
+
+.PHONY: cp
+cp: ## Copy CRD files to helm chart.
+	cp -r config/crd/bases/*.yaml charts/kdp-oam-operator/crds
+
+.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 cp fmt vet env-test ## Run tests.
+	KUBEBUILDER_ASSETS="$(shell $(ENV_TEST) use $(ENV_TEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $(shell go list ./pkg/...) -coverprofile cover.out && go tool cover -func=cover.out
+	$(ENV_TEST) cleanup $(ENV_TEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path
+
+.PHONY: clean
+clean: ## clean up env-test binary.
+	if [[ -d $(LOCALBIN)/k8s ]]; then \
+        rm -rf $(LOCALBIN)/k8s; \
+    fi
+
+
+##@ Deployment
+
+.PHONY: build
+build: manifests generate fmt vet ## Build manager binary.
+	go build -o bin/manager cmd/bdc/main.go
+
+.PHONY: run
+run: manifests generate fmt vet ## Run a controller from your host.
+	go run cmd/bdc/main.go
+
+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_CONTROLLER}
+	$(KUSTOMIZE) build config/default | kubectl apply -f -
+
+.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 -
+
+.PHONY: apply
+apply: manifests kustomize ## Apply samples into the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build config/samples | kubectl apply -f -
+
+.PHONY: delete
+delete: manifests kustomize ## Delete samples from the K8s cluster specified in ~/.kube/config.
+	$(KUSTOMIZE) build config/samples | kubectl delete -f -
+
+.PHONY: run-apiserver
+run-apiserver: fmt vet ## Run a api server from your host.
+	go run cmd/apiserver/main.go --kube-api-qps=300 --kube-api-burst=900

PROJECT

@@ -0,0 +1,66 @@
+# 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: kdp.io
+layout:
+- go.kubebuilder.io/v3
+plugins:
+  manifests.sdk.operatorframework.io/v2: {}
+  scorecard.sdk.operatorframework.io/v2: {}
+projectName: kdp-oam-operator
+repo: kdp-oam-operator
+resources:
+- api:
+    crdVersion: v1
+  controller: true
+  domain: kdp.io
+  group: bdc
+  kind: BigDataCluster
+  path: kdp-oam-operator/api/v1alpha1
+  version: v1alpha1
+  webhooks:
+    defaulting: true
+    validation: true
+    webhookVersion: v1
+- api:
+    crdVersion: v1
+  controller: true
+  domain: kdp.io
+  group: bdc
+  kind: ContextSecret
+  path: kdp-oam-operator/api/v1alpha1
+  version: v1alpha1
+  webhooks:
+    defaulting: true
+    validation: true
+    webhookVersion: v1
+- api:
+    crdVersion: v1
+  controller: true
+  domain: kdp.io
+  group: bdc
+  kind: ContextSetting
+  path: kdp-oam-operator/api/v1alpha1
+  version: v1alpha1
+  webhooks:
+    defaulting: true
+    validation: true
+    webhookVersion: v1
+- api:
+    crdVersion: v1
+  controller: true
+  domain: kdp.io
+  group: bdc
+  kind: XDefinition
+  path: kdp-oam-operator/api/v1alpha1
+  version: v1alpha1
+- api:
+    crdVersion: v1
+  controller: true
+  domain: kdp.io
+  group: bdc
+  kind: Application
+  path: kdp-oam-operator/api/v1alpha1
+  version: v1alpha1
+version: "3"

README.md

@@ -1,2 +1,20 @@
-# template-project
-This is the template project for initializing other LTC projects. 
+# kdp-oam-operator
+The kdp-oam-operator, based on the KDP (Kubernetes Data Platform) bigdata model, provides a highly programmable application-centric delivery model. It allows users to build upon the fundamental capabilities of the kdp-oam-operator to extend and customize their services. The most critical components in the kdp-oam-operator are the XDefinition, Application, BDC, ContextSetting, and ContextSecret. All of these are built upon the fundamental structure of the Kubernetes Custom Resource Definition (CRD) model and manage the resource lifecycle through the implementation of independent controller components.
+
+
+## License
+
+Copyright 2023 KDP(Kubernetes Data Platform).
+
+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.
+