From 4d027c7d22c0bc76393b79cde60bf34ec01fbc76 Mon Sep 17 00:00:00 2001 From: Shane McDonald Date: Thu, 17 Jun 2021 16:24:19 -0400 Subject: [PATCH] Update README --- README.md | 55 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 28 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index a17c2606..1b850376 100644 --- a/README.md +++ b/README.md @@ -725,33 +725,6 @@ There are a few moving parts to this project: Each of these must be appropriately built in preparation for a new tag: -### Verify Functionality - -Run the following command inside this directory: - -```sh -#> operator-sdk build quay.io//awx-operator:test -``` - -Then push the generated image to Docker Hub: - -```sh -#> docker push quay.io//awx-operator:test -``` - -After it is built, test it on a local cluster: - - -```sh -#> minikube start --memory 6g --cpus 4 -#> minikube addons enable ingress -#> ansible-playbook ansible/deploy-operator.yml -e operator_image=quay.io//awx-operator -e operator_version=test -#> kubectl create namespace example-awx -#> ansible-playbook ansible/instantiate-awx-deployment.yml -e namespace=example-awx -#> -#> minikube delete -``` - ### Update version and files Update the awx-operator version: @@ -774,6 +747,34 @@ $ operator-sdk generate bundle --operator-name awx-operator --version > It is a good idea to use the [build script](./build.sh) at this point to build the catalog and test out installing it in Operator Hub. +### Verify Functionality + +Run the following command inside this directory: + +```sh +#> operator-sdk build quay.io//awx-operator: +``` + +Then push the generated image to Docker Hub: + +```sh +#> docker push quay.io//awx-operator: +``` + +After it is built, test it on a local cluster: + + +```sh +#> minikube start --memory 6g --cpus 4 +#> minikube addons enable ingress +#> ansible-playbook ansible/deploy-operator.yml -e operator_image=quay.io//awx-operator -e operator_version= -e pull_policy=Always +#> kubectl create namespace example-awx +#> ansible-playbook ansible/instantiate-awx-deployment.yml -e namespace=example-awx -e image=quay.io//awx -e service_type=nodeport +#> # Verify that the awx-task and awx-web containers are launched +#> # with the right version of the awx image +#> minikube delete +``` + ### Update changelog Generate a list of commits between the versions and add it to the [changelog](./CHANGELOG.md).