Fix inventory file and upgrade documentation (#1596)

Author: mateigrigore

Makefile

@@ -9,8 +9,7 @@ NAMESPACE := $(shell jq -r .namespace < $(MONGODB_COMMUNITY_CONFIG))
 UPGRADE_HOOK_IMG := $(shell jq -r .version_upgrade_hook_image < $(MONGODB_COMMUNITY_CONFIG))
 READINESS_PROBE_IMG := $(shell jq -r .readiness_probe_image < $(MONGODB_COMMUNITY_CONFIG))
 REGISTRY := $(shell jq -r .repo_url < $(MONGODB_COMMUNITY_CONFIG))
-AGENT_IMAGE_NAME := $(shell jq -r .agent_image_ubi < $(MONGODB_COMMUNITY_CONFIG))
-
+AGENT_IMAGE_NAME := $(shell jq -r .agent_image < $(MONGODB_COMMUNITY_CONFIG))
 HELM_CHART ?= ./helm-charts/charts/community-operator
 
 STRING_SET_VALUES := --set namespace=$(NAMESPACE),versionUpgradeHook.name=$(UPGRADE_HOOK_IMG),readinessProbe.name=$(READINESS_PROBE_IMG),registry.operator=$(REPO_URL),operator.operatorImageName=$(OPERATOR_IMAGE),operator.version=latest,registry.agent=$(REGISTRY),registry.versionUpgradeHook=$(REGISTRY),registry.readinessProbe=$(REGISTRY),registry.operator=$(REGISTRY),versionUpgradeHook.version=latest,readinessProbe.version=latest,agent.version=latest,agent.name=$(AGENT_IMAGE_NAME)
@@ -134,7 +133,7 @@ install-rbac:
 	$(HELM) template $(STRING_SET_VALUES) -s templates/operator_roles.yaml $(HELM_CHART) | kubectl apply -f -
 
 uninstall-crd:
-	kubectl delete crd mongodbcommunity.mongodbcommunity.mongodb.com
+	kubectl delete crd --ignore-not-found mongodbcommunity.mongodbcommunity.mongodb.com
 
 uninstall-chart:
 	$(HELM) uninstall $(RELEASE_NAME_HELM) -n $(NAMESPACE)
@@ -193,19 +192,19 @@ generate-env-file: ## generates a local-test.env for local testing
 ##@ Image
 
 operator-image: ## Build and push the operator image
-	python pipeline.py --image-name operator
+	python pipeline.py --image-name operator $(IMG_BUILD_ARGS)
 
 e2e-image: ## Build and push e2e test image
-	python pipeline.py --image-name e2e
+	python pipeline.py --image-name e2e $(IMG_BUILD_ARGS)
 
 agent-image: ## Build and push agent image
-	python pipeline.py --image-name agent
+	python pipeline.py --image-name agent $(IMG_BUILD_ARGS)
 
 readiness-probe-image: ## Build and push readiness probe image
-	python pipeline.py --image-name readiness-probe
+	python pipeline.py --image-name readiness-probe $(IMG_BUILD_ARGS)
 
 version-upgrade-post-start-hook-image: ## Build and push version upgrade post start hook image
-	python pipeline.py --image-name version-upgrade-hook
+	python pipeline.py --image-name version-upgrade-hook $(IMG_BUILD_ARGS)
 
 all-images: operator-image e2e-image agent-image readiness-probe-image version-upgrade-post-start-hook-image ## create all required images
 

docs/build_operator_locally.md

@@ -40,7 +40,7 @@ git submodule update --init
 ```
 
 
-5. Build and deploy the operator:
+5. Build and deploy the operator. Also add `IMG_BUILD_ARGS=--insecure` as described [here](contributing.md#deploying-the-operator) if necessary:
 
 ```sh
 # builds all required images and then deploys the operator

docs/contributing.md

@@ -58,9 +58,9 @@ to be able to run properly. Create a json file with the following content:
   "repo_url": "localhost:5000",
   "operator_image": "mongodb-kubernetes-operator",
   "e2e_image": "community-operator-e2e",
-  "version_upgrade_hook_image": "community-operator-version-upgrade-post-start-hook",
+  "version_upgrade_hook_image": "mongodb-kubernetes-operator-version-upgrade-post-start-hook",
   "agent_image": "mongodb-agent-ubi-dev",
-  "readiness_probe_image": "mongodb-kubernetes-readiness",
+  "readiness_probe_image": "mongodb-kubernetes-readinessprobe",
   "s3_bucket": ""
 }
 ```
@@ -132,6 +132,14 @@ make operator-image deploy
 
 This will build and deploy the operator to namespace specified in your configuration file.
 
+If you are using a local docker registry you should run the following command.
+The additional `IMG_BUILD_ARGS=--insecure` variable will add the `--insecure` flag to the command creating the manifests.
+This is necessary if your local registry is not secure. Read more about the flag on the [documentatio](https://docs.docker.com/reference/cli/docker/manifest/#working-with-insecure-registries)
+
+```sh
+IMG_BUILD_ARGS=--insecure make operator-image deploy
+```
+
 
 #### See the operator deployment
 ```sh
@@ -149,7 +157,7 @@ To remove the operator and any created resources you can run
 make undeploy
 ```
 
-Alternatively, you can run the operator locally with
+Alternatively, you can run the operator locally. Make sure you follow the steps outlined in [run-operator-locally.md](run-operator-locally.md)
 
 ```sh
 make run
@@ -168,7 +176,8 @@ make test
 ### E2E Tests
 
 If this is the first time running E2E tests, you will need to ensure that you have built and pushed
-all images required by the E2E tests. You can do this by running.
+all images required by the E2E tests. You can do this by running the following command, 
+or with the additional `IMG_BUILD_ARGS=--insecure` described above.
 
 ```sh
 make all-images
@@ -180,7 +189,7 @@ For subsequent tests you can use
 make e2e-k8s test=<test-name>
 ```
 
-This will only re-build the e2e test image.
+This will only re-build the e2e test image. Add `IMG_BUILD_ARGS=--insecure` if necessary
 
 We have built a simple mechanism to run E2E tests on your cluster using a runner
 that deploys a series of Kubernetes objects, runs them, and awaits for their
@@ -199,7 +208,7 @@ replica_set_scale
 ...
 ```
 
-The tests should run individually using the runner like this:
+The tests should run individually using the runner like this, or additionally with `IMG_BUILD_ARGS=--insecure`:
 
 ```sh
 make e2e-k8s test=replica_set

docs/run-operator-locally.md

@@ -18,17 +18,23 @@ Being able to run and build the binary locally can help with faster feedback-cyc
 - Run e2e tests locally
 
 ## Running The Operator locally
-1. Use the dedicated make target which exports the needed environment variables and builds & runs the operator binary
-
-```sh
-make run
-```
+1. Use the dedicated make target which exports the needed environment variables and builds & runs the operator binary.
+
+   Before doing that you need to add 2 more fields to the `config.json` file found in [contributing.md](contributing.md), because the python script looks for them in the file:
+    - `mdb_local_operator`: needs to be set to `true`, to allow for the operator to be run locally
+    - `kubeconfig`: needs to be set to the path of the `kubeconfig` configuration file, for example `$HOME/.kube/config`
+  
+   Then you can run the command:
+  
+    ```sh
+       make run
+    ```
 
 2.  For debugging one can use the following make target, which uses [dlv](https://github.com/go-delve/delve):
 
-```sh
-make debug
-```
+    ```sh
+    make debug
+    ```
 
 ## Running e2e tests with the local operator
 - Our [e2e tests](../test/e2e), contains sub-steps that will install the following helm-chart: [operator.yaml](../helm-charts/charts/community-operator/templates/operator.yaml)

inventory.yaml

@@ -9,9 +9,6 @@ images:
     vars:
       context: .
       template_context: scripts/dev/templates/agent
-      # Default values but overwritten in pipeline.py
-      agent_distro: rhel7_x86_64
-      tools_distro: rhel70-x86_64
 
     inputs:
       - release_version
@@ -83,8 +80,8 @@ images:
         buildargs:
           agent_version: $(inputs.params.release_version)
           tools_version: $(inputs.params.tools_version)
-          agent_distro: rhel7_x86_64
-          tools_distro: rhel70-x86_64
+          agent_distro: $(inputs.params.agent_distro)
+          tools_distro: $(inputs.params.tools_distro)
 
         labels:
           quay.expires-after: Never

pipeline.py

@@ -87,6 +87,7 @@ def build_and_push_image(
     architectures: Set[str],
     release: bool,
     sign: bool,
+    insecure: bool = False,
 ) -> None:
     if sign:
         mongodb_artifactory_login()
@@ -119,16 +120,18 @@ def build_and_push_image(
     else:
         raise Exception("Dev image must be specified")
 
-    push_manifest(config, architectures, image_to_push)
+    push_manifest(config, architectures, image_to_push, insecure)
 
     if config.gh_run_id:
-        push_manifest(config, architectures, image_to_push, config.gh_run_id)
+        push_manifest(config, architectures, image_to_push, insecure, config.gh_run_id)
 
     if release:
         registry = args["registry"] + "/" + args["image"]
         context_tag = args["release_version"] + "-context"
-        push_manifest(config, architectures, args["image"], args["release_version"])
-        push_manifest(config, architectures, args["image"], context_tag)
+        push_manifest(
+            config, architectures, args["image"], insecure, args["release_version"]
+        )
+        push_manifest(config, architectures, args["image"], insecure, context_tag)
         if sign:
             sign_and_verify(registry, args["release_version"])
             sign_and_verify(registry, context_tag)
@@ -149,6 +152,7 @@ def push_manifest(
     config: DevConfig,
     architectures: Set[str],
     image_name: str,
+    insecure: bool = False,
     image_tag: str = "latest",
 ) -> None:
     logger.info(f"Pushing manifest for {image_tag}")
@@ -164,6 +168,9 @@ def push_manifest(
         final_manifest,
     ]
 
+    if insecure:
+        create_args.append("--insecure")
+
     for arch in architectures:
         create_args.extend(["--amend", final_manifest + "-" + arch])
 
@@ -220,6 +227,7 @@ def _parse_args() -> argparse.Namespace:
     )
     parser.add_argument("--tag", type=str)
     parser.add_argument("--sign", action="store_true", default=False)
+    parser.add_argument("--insecure", action="store_true", default=False)
     return parser.parse_args()
 
 
@@ -277,7 +285,7 @@ def main() -> int:
     image_args = build_image_args(config, image_name)
 
     build_and_push_image(
-        image_name, config, image_args, arch_set, args.release, args.sign
+        image_name, config, image_args, arch_set, args.release, args.sign, args.insecure
     )
     return 0
 

scripts/dev/setup_kind_cluster.sh

@@ -97,4 +97,4 @@ EOF
 
 if [[ "${export_kubeconfig}" == "1" ]]; then
   kind export kubeconfig --name "${cluster_name}"
-fi
+fi