From 484db004db7b9371f3f68ddd84c191b84f597d59 Mon Sep 17 00:00:00 2001 From: Jake Jackson Date: Mon, 12 Sep 2022 13:04:04 -0400 Subject: [PATCH] Update Kind Docs (#12865) * update kind docs formatting and update some commands * add tested on fedora update --- docs/development/kind.md | 71 +++++++++++++++++++++------------------- 1 file changed, 38 insertions(+), 33 deletions(-) diff --git a/docs/development/kind.md b/docs/development/kind.md index 69a2b6665d..c7dbab493f 100644 --- a/docs/development/kind.md +++ b/docs/development/kind.md @@ -1,7 +1,7 @@ # Running Development Environment in Kubernetes using Kind Cluster ## Start Kind Cluster -Note: This environment has only been tested on MacOS with Docker. +Note: This environment has been tested on MacOS and Fedora with Docker. If you do not already have Kind, install it from: https://kind.sigs.k8s.io/docs/user/quick-start/ @@ -21,13 +21,13 @@ nodes: ``` Start Kind cluster -``` -$ kind create cluster --config kind-cluster.yaml +```bash + kind create cluster --config kind-cluster.yaml ``` Verify AWX source tree is mounted in the kind-control-plane container -``` -$ docker exec -it kind-control-plane ls /awx_devel +```bash + docker exec -it kind-control-plane ls /awx_devel ``` ## Deploy the AWX Operator @@ -36,8 +36,8 @@ Clone the [awx-operator](https://github.com/ansible/awx-operator). For the following playbooks to work, you will need to: -``` -$ pip install openshift +```bash + pip install openshift ``` If you are not changing any code in the operator itself, git checkout the latest version from https://github.com/ansible/awx-operator/releases, and then follow the instructions in the awx-operator [README](https://github.com/ansible/awx-operator#basic-install). @@ -47,15 +47,15 @@ of the awx-operator repo. If not, continue to the next section. ### Building and Deploying a Custom AWX Operator Image -``` +```bash # in awx-operator repo on the branch you want to use -$ export IMAGE_TAG_BASE=quay.io//awx-operator -$ make docker-build docker-push deploy + export IMAGE_TAG_BASE=quay.io//awx-operator + make docker-build docker-push deploy ``` Check the operator deployment -``` -$ kubectl get deployments +```bash + kubectl get deployments NAME READY UP-TO-DATE AVAILABLE AGE awx-operator-controller-manager 1/1 1 1 16h ``` @@ -68,8 +68,8 @@ command. If you need to test out changes to the Dockerfile, see the In the root of awx-operator: -``` -$ ansible-playbook ansible/instantiate-awx-deployment.yml \ +```bash + ansible-playbook ansible/instantiate-awx-deployment.yml \ -e development_mode=yes \ -e image=ghcr.io/ansible/awx_kube_devel \ -e image_version=devel \ @@ -79,14 +79,14 @@ $ ansible-playbook ansible/instantiate-awx-deployment.yml \ ``` Check the operator with the following commands: -``` +```bash # Check the operator deployment -$ kubectl get deployments + kubectl get deployments NAME READY UP-TO-DATE AVAILABLE AGE awx 1/1 1 1 16h awx-operator-controller-manager 1/1 1 1 16h -$ kubectl get pods + kubectl get pods NAME READY STATUS RESTARTS AGE awx-operator-controller-manager-b775bfc7c-fn995 2/2 Running 0 16h ``` @@ -95,20 +95,25 @@ If there are errors in the image pull, check that it is using the right tag. You ### Custom AWX Development Image for Kubernetes +Set these environmental variables before starting: +```bash +export DEV_DOCKER_TAG_BASE=quay.io/ +export COMPOSE_TAG= +``` In the root of the AWX repo: -``` -$ make awx-kube-dev-build -$ docker push ghcr.io/ansible/awx_kube_devel:${COMPOSE_TAG} +```bash +make awx-kube-dev-build +docker push $DEV_DOCKER_TAG_BASE/awx_kube_devel:$COMPOSE_TAG ``` In the root of awx-operator: -``` -$ ansible-playbook ansible/instantiate-awx-deployment.yml \ +```bash + ansible-playbook ansible/instantiate-awx-deployment.yml \ -e development_mode=yes \ - -e image=ghcr.io/ansible/awx_kube_devel \ - -e image_version=${COMPOSE_TAG} \ + -e image=$DEV_DOCKER_TAG_BASE/awx_kube_devel \ + -e image_version=$COMPOSE_TAG \ -e image_pull_policy=Always \ -e service_type=nodeport \ -e namespace=$NAMESPACE @@ -125,28 +130,28 @@ http://localhost:30080 ``` To retrieve your admin password -``` -$ kubectl get secrets awx-admin-password -o json | jq '.data.password' | xargs | base64 -d +```bash + kubectl get secrets awx-admin-password -o json | jq '.data.password' | xargs | base64 -d ``` To tail logs from the task containers -``` -$ kubectl logs -f deployment/awx -n awx -c awx-web +```bash + kubectl logs -f deployment/awx -n awx -c awx-web ``` To tail logs from the web containers -``` -$ kubectl logs -f deployment/awx -n awx -c awx-web +```bash + kubectl logs -f deployment/awx -n awx -c awx-web ``` NOTE: If there's multiple replica of the awx deployment you can use `stern` to tail logs from all replicas. For more information about `stern` check out https://github.com/wercker/stern. To exec in to the a instance of the awx-task container: -``` -$ kubectl exec -it deployment/awx -c awx-task bash +```bash + kubectl exec -it deployment/awx -n awx -c awx-task bash ``` The application will live reload when files are edited just like in the development environment. Just like in the development environment, if the application totally crashes because files are invalid syntax or other fatal problem, you will get an error like "no python application" in the web container. Delete the whole control plane pod and wait until a new one spins up automatically. -``` +```bash oc delete pod -l app.kubernetes.io/component=awx ```