oracle · s1saurabh · Jul 13, 2023 · Aug 15, 2023 · Aug 15, 2023 · Aug 23, 2023
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,13 @@
+operator.tgz
+cover.out
+bin
+testbin/*
+onpremtest/*
+ords/*zip
+.gitattributes
+.vscode
+.gitlab-ci.yml
+
+# development
+.idea
+.local
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,16 +1,16 @@
 # Contributing to This Repository
 
-We welcome your contributions! There are multiple ways to contribute.
+Oracle welcomes your contributions! There are multiple ways that you can contribute.
 
 ## Opening issues
 
-For bugs or enhancement requests, please file a GitHub issue unless the problem is security-related. When filing a bug, remember that the more specific the bug is, the more likely it is to be fixed. If you think you've found a security
-vulnerability, then do not raise a GitHub issue. Instead, follow the instructions in our
-[security policy](./SECURITY.md).
+For bugs or enhancement requests, please file a GitHub issue, unless the problem is security-related.
+
+When filing a bug, remember that the more specific the bug is, the more likely it is to be fixed. If you think you've found a security vulnerability, then do not raise a GitHub issue. Instead, follow the instructions in our [security policy](./SECURITY.md).
 
 ## Contributing code
 
-We welcome your code contributions. Before submitting code by using a pull request,
+Oracle welcomes your code contributions. Before submitting code by using a pull request,
 you must sign the [Oracle Contributor Agreement][OCA] (OCA), and your commits must include the following line, using the name and e-mail address you used to sign the OCA:
 
 ```text
@@ -29,22 +29,22 @@ can be accepted.
 
 ## Pull request process
 
-1. Ensure there is an issue created to track and discuss the fix or enhancement that you intend to submit.
+1. Ensure that there is an issue created to track and discuss the fix or enhancement that you intend to submit.
 1. Fork this repository.
 1. Create a branch in your fork to implement the changes. Oracle recommends using
    the issue number as part of your branch name. For example: `1234-fixes`
 1. Ensure that any documentation is updated with the changes that are required
    by your change.
-1. Ensure that any samples are updated, if the base image has been changed.
+1. If the base image has been changed, then ensure that any examples are updated. 
 1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
    what your changes are meant to do, and provide simple steps to indicate how to validate
    your changes. Ensure that you reference the issue that you created as well.
-1. Before the changes are merged, Oracle will assign the pull request to 2 or 3 people for review. 
+1. Before the changes are merged, Oracle will assign the pull request to two or three people for review. 
 
 ## Code of conduct
 
 Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
-like more specific guidelines, see the [Contributor Covenant Code of Conduct][COC].
+like more specific guidelines, then see the [Contributor Covenant Code of Conduct][COC].
 
 [OCA]: https://oca.opensource.oracle.com
 [COC]: https://www.contributor-covenant.org/version/1/4/code-of-conduct/
diff --git a/Dockerfile b/Dockerfile
@@ -1,9 +1,20 @@
-# Copyright (c) 2021, Oracle and/or its affiliates.
+# Copyright (c) 2022, Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 #
 
 # Build the manager binary
-FROM golang:1.16 as builder
+ARG BUILDER_IMG
+FROM ${BUILDER_IMG} as builder
+
+# Download golang if BUILD_INTERNAL is set to true
+ARG INSTALL_GO
+ARG GOLANG_VERSION
+RUN if [ "$INSTALL_GO" = "true" ]; then \
+        curl -LJO https://go.dev/dl/go${GOLANG_VERSION}.linux-amd64.tar.gz &&\
+        rm -rf /usr/local/go && tar -C /usr/local -xzf go${GOLANG_VERSION}.linux-amd64.tar.gz &&\
+        rm go${GOLANG_VERSION}.linux-amd64.tar.gz; \
+    fi
+ENV PATH=${GOLANG_VERSION:+"${PATH}:/usr/local/go/bin"}
 
 WORKDIR /workspace
 # Copy the Go Modules manifests
@@ -26,6 +37,10 @@ RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 GO111MODULE=on go build -a -o manager
 
 # Use oraclelinux:8-slim as base image to package the manager binary
 FROM oraclelinux:8-slim
+ARG CI_COMMIT_SHA 
+ARG CI_COMMIT_BRANCH
+ENV COMMIT_SHA=${CI_COMMIT_SHA} \
+    COMMIT_BRANCH=${CI_COMMIT_BRANCH}
 WORKDIR /
 COPY --from=builder /workspace/manager .
 RUN useradd -u 1002 nonroot

diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,4 +1,4 @@
-Copyright (c) 2021 Oracle and/or its affiliates.
+Copyright (c) 2022 Oracle and/or its affiliates.
 
 The Universal Permissive License (UPL), Version 1.0
 

diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2021, Oracle and/or its affiliates. 
+# Copyright (c) 2022, Oracle and/or its affiliates. 
 # Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
 #
 
@@ -23,6 +23,8 @@ IMG ?= controller:latest
 CRD_OPTIONS ?= "crd:trivialVersions=true,preserveUnknownFields=false"
 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
 ENVTEST_K8S_VERSION = 1.21
+# Operator YAML file
+OPERATOR_YAML=$$(basename $$(pwd)).yaml
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -53,13 +55,13 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	go vet ./...
 
-TEST ?= ./apis/... ./commons/... ./controllers/...
+TEST ?= ./apis/database/v1alpha1 ./commons/... ./controllers/...
 test: manifests generate fmt vet envtest ## Run unit tests.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test $(TEST) -coverprofile cover.out
 
 E2ETEST ?= ./test/e2e/
 e2e: manifests generate fmt vet envtest ## Run e2e tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test $(E2ETEST) -v -timeout 40m -ginkgo.v -ginkgo.failFast
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test $(E2ETEST) -test.timeout 0 -test.v --ginkgo.fail-fast
 
 ##@ Build
 
@@ -69,14 +71,23 @@ build: generate fmt vet ## Build manager binary.
 run: manifests generate fmt vet ## Run a controller from your host.
 	go run ./main.go
 
-docker-build: test ## Build docker image with the manager.
-	docker build --no-cache=true --build-arg http_proxy=${HTTP_PROXY} --build-arg https_proxy=${HTTPS_PROXY} . -t ${IMG}
-
-#docker-build-proxy: test
-# docker build --build-arg http_proxy=${http_proxy} --build-arg https_proxy=${https_proxy} build . -t ${IMG}
+GOLANG_VERSION ?= 1.21.7
+## Download golang in the Dockerfile if BUILD_INTERNAL is set to true.
+## Otherwise, use golang image from docker hub as the builder.
+ifeq ($(BUILD_INTERNAL), true)
+BUILDER_IMG = oraclelinux:8
+BUILD_ARGS = --build-arg BUILDER_IMG=$(BUILDER_IMG) --build-arg GOLANG_VERSION=$(GOLANG_VERSION) --build-arg INSTALL_GO=true
+else
+BUILDER_IMG = golang:$(GOLANG_VERSION)
+BUILD_ARGS = --build-arg BUILDER_IMG=$(BUILDER_IMG) --build-arg INSTALL_GO=false
+endif
+docker-build: #manifests generate fmt vet #test ## Build docker image with the manager. Disable the test but keep the validations to fail fast
+	docker build --no-cache=true --build-arg http_proxy=$(HTTP_PROXY) --build-arg https_proxy=$(HTTPS_PROXY) \
+	             --build-arg CI_COMMIT_SHA=$(CI_COMMIT_SHA) --build-arg CI_COMMIT_BRANCH=$(CI_COMMIT_BRANCH) \
+	             $(BUILD_ARGS) . -t $(IMG)
 
 docker-push: ## Push docker image with the manager.
-	docker push ${IMG}
+	docker push $(IMG)
 
 ##@ Deployment
 
@@ -87,42 +98,53 @@ uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified
 	$(KUSTOMIZE) build config/crd | kubectl delete -f -
 
 deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
+	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
 	$(KUSTOMIZE) build config/default | kubectl apply -f -
 
+# Bug:34265574
+# Used sed to reposition the controller-manager Deployment after the certificate creation in the OPERATOR_YAML  
 operator-yaml: manifests kustomize
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
-	$(KUSTOMIZE) build config/default > $$(basename $$(pwd)).yaml
+	cd config/manager && $(KUSTOMIZE) edit set image controller=$(IMG)
+	$(KUSTOMIZE) build config/default > "$(OPERATOR_YAML)"
+	sed -i.bak -e '/^apiVersion: apps\/v1/,/---/d' "$(OPERATOR_YAML)"
+	(echo --- && sed '/^apiVersion: apps\/v1/,/---/!d' "$(OPERATOR_YAML).bak")  >>  "$(OPERATOR_YAML)"
+	rm "$(OPERATOR_YAML).bak"
 
 undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
 	$(KUSTOMIZE) build config/default | kubectl delete -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 ?= v3.8.7
+CONTROLLER_TOOLS_VERSION ?= v0.6.1
+
+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
 
-CONTROLLER_GEN = $(shell pwd)/bin/controller-gen
-controller-gen: ## Download controller-gen locally if necessary.
-	$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/[email protected])
-
-KUSTOMIZE = $(shell pwd)/bin/kustomize
-kustomize: ## Download kustomize locally if necessary.
-	$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/[email protected])
-
-ENVTEST = $(shell pwd)/bin/setup-envtest
-envtest: ## Download envtest-setup locally if necessary.
-	$(call go-get-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@latest)
-
-# go-get-tool will 'go get' any package $2 and install it to $1.
-PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
-define go-get-tool
-@[ -f $(1) ] || { \
-set -e ;\
-TMP_DIR=$$(mktemp -d) ;\
-cd $$TMP_DIR ;\
-go mod init tmp ;\
-echo "Downloading $(2)" ;\
-GOBIN=$(PROJECT_DIR)/bin go get $(2) ;\
-rm -rf $$TMP_DIR ;\
-}
-endef
 
 .PHONY: bundle
 bundle: manifests kustomize ## Generate bundle manifests and metadata, then validate generated files.
@@ -179,3 +201,4 @@ catalog-build: opm ## Build a catalog image.
 .PHONY: catalog-push
 catalog-push: ## Push a catalog image.
 	$(MAKE) docker-push IMG=$(CATALOG_IMG)
+
diff --git a/PREREQUISITES.md b/PREREQUISITES.md
@@ -2,13 +2,14 @@
 
 ## Prerequisites for Using Oracle Database Operator for Kubernetes
 
-Oracle Database operator for Kubernetes (OraOperator) manages all Cloud deployments of Oracle Database, including:
+Oracle Database Operator for Kubernetes (OraOperator) manages all Cloud deployments of Oracle Database, including:
 
 * Oracle Autonomous Database (ADB)
 * Containerized Oracle Database Single Instance (SIDB)
 * Containerized Sharded Oracle Database (SHARDING)
 
 ### Setting Up a Kubernetes Cluster and Volumes
+Review and complete each step as needed.
 
 #### Setting Up an OKE Cluster on Oracle Cloud Infrastructure (OCI)
 
@@ -26,7 +27,7 @@ If you intent to use `OraOperator` to handle Oracle Autonomous Database lifecycl
 
 ### Prerequites for Single Instance Databases (SIDB)
 
-If you intent to use `OraOperator` to handle Oracle Database Single Instance lifecycles, then read [Single Instance Database Prerequisites](./docs/sidb/SIDB_PREREQUISITES.md)
+If you intent to use `OraOperator` to handle Oracle Database Single Instance lifecycles, then read [Single Instance Database Prerequisites](./docs/sidb/PREREQUISITES.md)
 
 ### Prerequites for Sharded Databases (SHARDING)