Add sample AWX CR with resource limits for environments with Resource… (#1554)

Add sample AWX CR with resource limits for environments with ResourceQuotas

.github/workflows/promote.yaml

@@ -3,11 +3,26 @@ name: Promote AWX Operator image
 on:
   release:
     types: [published]
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: 'Name for the tag of the release.'
+        required: true
 
 jobs:
   promote:
     runs-on: ubuntu-latest
     steps:
+      - name: Set TAG_NAME for workflow_dispatch event
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: |
+          echo "TAG_NAME=${{ github.event.inputs.tag_name }}" >> $GITHUB_ENV
+
+      - name: Set TAG_NAME for release event
+        if: ${{ github.event_name == 'release' }}
+        run: |
+          echo "TAG_NAME=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
+
       - uses: actions/checkout@v3
         with:
           depth: 0
@@ -22,35 +37,18 @@ jobs:
 
       - name: Re-tag and promote awx-operator image
         run: |
-          # Promote operator image
-          docker pull ghcr.io/${{ github.repository }}:${{ github.event.release.tag_name }}
-          docker tag \
-            ghcr.io/${{ github.repository }}:${{ github.event.release.tag_name }} \
-            quay.io/${{ github.repository }}:${{ github.event.release.tag_name }}
-          docker tag \
-            ghcr.io/${{ github.repository }}:${{ github.event.release.tag_name }} \
-            quay.io/${{ github.repository }}:latest
-          docker push quay.io/${{ github.repository }}:${{ github.event.release.tag_name }}
+          docker pull ghcr.io/${{ github.repository }}:${TAG_NAME}
+          docker tag ghcr.io/${{ github.repository }}:${TAG_NAME} quay.io/${{ github.repository }}:${TAG_NAME}
+          docker tag ghcr.io/${{ github.repository }}:${TAG_NAME} quay.io/${{ github.repository }}:latest
+          docker push quay.io/${{ github.repository }}:${TAG_NAME}
           docker push quay.io/${{ github.repository }}:latest
-          # Promote bundle image
-          docker pull ghcr.io/${{ github.repository }}-bundle:v${{ github.event.release.tag_name }}
-          docker tag \
-            ghcr.io/${{ github.repository }}-bundle:v${{ github.event.release.tag_name }} \
-            quay.io/${{ github.repository }}-bundle:v${{ github.event.release.tag_name }}
-          docker push quay.io/${{ github.repository }}-bundle:v${{ github.event.release.tag_name }}
-          # Promote catalog image
-          docker pull ghcr.io/${{ github.repository }}-catalog:v${{ github.event.release.tag_name }}
-          docker tag \
-            ghcr.io/${{ github.repository }}-catalog:v${{ github.event.release.tag_name }} \
-            quay.io/${{ github.repository }}-catalog:v${{ github.event.release.tag_name }}
-          docker push quay.io/${{ github.repository }}-catalog:v${{ github.event.release.tag_name }}
 
       - name: Release Helm chart
         run: |
           ansible-playbook ansible/helm-release.yml -v \
             -e operator_image=quay.io/${{ github.repository }} \
             -e chart_owner=${{ github.repository_owner }} \
-            -e tag=${{ github.event.release.tag_name }} \
+            -e tag=${TAG_NAME} \
             -e gh_token=${{ secrets.GITHUB_TOKEN }} \
             -e gh_user=${{ github.actor }} \
             -e repo_type=https

.github/workflows/publish-operator-hub.yaml

@@ -0,0 +1,76 @@
+name: Publish AWX Operator on operator-hub
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      tag_name:
+        description: 'Name for the tag of the release.'
+        required: true
+      operator_hub_fork:
+        description: 'Fork of operator-hub where the PR will be created from. default: awx-auto'
+        required: true
+        default: 'awx-auto'
+      image_registry:
+        description: 'Image registry where the image is published to. default: quay.io'
+        required: true
+        default: 'quay.io'
+      image_registry_organization:
+        description: 'Image registry organization where the image is published to. default: ansible'
+        required: true
+        default: 'ansible'
+      community_operator_github_org:
+        description: 'Github organization for community-opeartor project. default: k8s-operatorhub'
+        required: true
+        default: 'k8s-operatorhub'
+      community_operator_prod_github_org:
+        description: 'GitHub organization for community-operator-prod project. default: redhat-openshift-ecosystem'
+        required: true
+        default: 'redhat-openshift-ecosystem'
+jobs:
+  promote:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set TAG_NAME from workflow_dispatch event
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: |
+          echo "TAG_NAME=${{ github.event.inputs.tag_name }}" >> $GITHUB_ENV
+
+      - name: Set TAG_NAME for release event
+        if: ${{ github.event_name == 'release' }}
+        run: |
+          echo "TAG_NAME=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
+
+      - name: Log in to image registry
+        run: |
+          echo ${{ secrets.QUAY_TOKEN }} | docker login ${{github.event.inputs.image_registry}} -u ${{ secrets.QUAY_USER }} --password-stdin
+
+      - name: Checkout awx-operator at workflow branch
+        uses: actions/checkout@v4
+        with:
+          path: awx-operator
+
+      - name: Checkout awx-opearator at TAG_NAME
+        uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+          ref: ${{ env.TAG_NAME }}
+          path: awx-operator-${{ env.TAG_NAME }}
+
+      - name: Copy scripts to awx-operator-${{ env.TAG_NAME }}
+        run: |
+          cp -f \
+            awx-operator/hack/publish-to-operator-hub.sh \
+            awx-operator-${{ env.TAG_NAME }}/hack/publish-to-operator-hub.sh
+
+      - name: Build and publish bundle to operator-hub
+        working-directory: awx-operator-${{ env.TAG_NAME }}
+        env:
+          IMG_REPOSITORY: ${{ github.event.inputs.image_registry }}/${{ github.event.inputs.image_registry_organization }}
+          GITHUB_TOKEN: ${{ secrets.AWX_AUTO_GITHUB_TOKEN }}
+          COMMUNITY_OPERATOR_GITHUB_ORG: ${{ github.event.inputs.community_operator_github_org }}
+          COMMUNITY_OPERATOR_PROD_GITHUB_ORG: ${{ github.event.inputs.community_operator_prod_github_org }}
+        run: |
+          git config --global user.email "awx-automation@redhat.com"
+          git config --global user.name "AWX Automation"
+          ./hack/publish-to-operator-hub.sh

.github/workflows/stage.yml

@@ -63,8 +63,7 @@ jobs:
           BUILD_ARGS="--build-arg DEFAULT_AWX_VERSION=${{ github.event.inputs.default_awx_version }} \
                       --build-arg OPERATOR_VERSION=${{ github.event.inputs.version }}" \
           IMAGE_TAG_BASE=ghcr.io/${{ github.repository_owner }}/awx-operator \
-          VERSION=${{ github.event.inputs.version }} \
-          make bundle docker-build docker-push bundle-build bundle-push catalog-build catalog-push
+          VERSION=${{ github.event.inputs.version }} make docker-build docker-push
 
       - name: Run test deployment
         working-directory: awx-operator

Makefile

@@ -4,6 +4,7 @@
 # - 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 ?= $(shell git describe --tags)
+PREV_VERSION ?= $(git describe --abbrev=0 --tags $(git rev-list --tags --skip=1 --max-count=1))
 
 CONTAINER_CMD ?= docker
 
@@ -88,6 +89,10 @@ all: docker-build
 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)
 
+.PHONY: print-%
+print-%: ## Print any variable from the Makefile. Use as `make print-VARIABLE`
+	@echo $($*)
+
 ##@ Build
 
 .PHONY: run

config/default/manager_auth_proxy_patch.yaml

@@ -15,7 +15,7 @@ spec:
           capabilities:
             drop:
             - "ALL"
-        image: gcr.io/kubebuilder/kube-rbac-proxy:v0.14.1
+        image: gcr.io/kubebuilder/kube-rbac-proxy:v0.15.0
         args:
         - "--secure-listen-address=0.0.0.0:8443"
         - "--upstream=http://127.0.0.1:8080/"

config/samples/awx_v1beta1_awx_resource_limits.yaml

@@ -0,0 +1,55 @@
+---
+apiVersion: awx.ansible.com/v1beta1
+kind: AWX
+metadata:
+  name: awx-with-limits
+spec:
+  task_resource_requirements:
+    requests:
+      cpu: 100m
+      memory: 128Mi
+    limits:
+      cpu: 2000m
+      memory: 4Gi
+  web_resource_requirements:
+    requests:
+      cpu: 100m
+      memory: 128Mi
+    limits:
+      cpu: 1000m
+      memory: 4Gi
+  ee_resource_requirements:
+    requests:
+      cpu: 100m
+      memory: 64Mi
+    limits:
+      cpu: 1000m
+      memory: 4Gi
+  redis_resource_requirements:
+    requests:
+      cpu: 50m
+      memory: 64Mi
+    limits:
+      cpu: 1000m
+      memory: 4Gi
+  rsyslog_resource_requirements:
+    requests:
+      cpu: 100m
+      memory: 128Mi
+    limits:
+      cpu: 1000m
+      memory: 2Gi
+  init_container_resource_requirements:
+    requests:
+      cpu: 100m
+      memory: 128Mi
+    limits:
+      cpu: 1000m
+      memory: 2Gi
+  postgres_init_container_resource_requirements:
+    requests:
+      cpu: 10m
+      memory: 64Mi
+    limits:
+      cpu: 1000m
+      memory: 2Gi

docs/requirements.txt

@@ -7,6 +7,6 @@ mkdocs-material>=9.1.18
 mkdocs
 mkdocstrings-python>=1.1.0
 mkdocstrings>=0.22.0
-pillow==9.5.0
+pillow==10.0.1
 pipdeptree==2.7.1
 pymdown-extensions==10.0.1

docs/user-guide/advanced-configuration/containers-resource-requirements.md

@@ -26,7 +26,13 @@ The resource requirements for both, the task and the web containers are configur
 | -------------------------- | ------------------------------------------------ | ------------------------------------ |
 | web_resource_requirements  | Web container resource requirements              | requests: {cpu: 100m, memory: 128Mi} |
 | task_resource_requirements | Task container resource requirements             | requests: {cpu: 100m, memory: 128Mi} |
-| ee_resource_requirements   | EE control plane container resource requirements | requests: {cpu: 100m, memory: 128Mi} |
+| ee_resource_requirements   | EE control plane container resource requirements | requests: {cpu: 50m, memory: 64Mi} |
+| redis_resource_requirements   | Redis container resource requirements | requests: {cpu: 100m, memory: 128Mi} |
+| postgres_resource_requirements   | Postgres container resource requirements | requests: {cpu: 10m, memory: 64Mi} |
+| rsyslog_resource_requirements   | Rsyslog container resource requirements | requests: {cpu: 100m, memory: 128Mi} |
+| init_container_resource_requirements   | Init Container resource requirements | requests: {cpu: 100m, memory: 128Mi} |
+| postgres_init_container_resource_requirements   | Postgres Init Container resource requirements | requests: {cpu: 10m, memory: 64Mi} |
+
 
 Example of customization could be:
 
@@ -34,31 +40,63 @@ Example of customization could be:
 ---
 spec:
   ...
-  web_resource_requirements:
-    requests:
-      cpu: 250m
-      memory: 2Gi
-      ephemeral-storage: 100M
-    limits:
-      cpu: 1000m
-      memory: 4Gi
-      ephemeral-storage: 500M
+
   task_resource_requirements:
     requests:
-      cpu: 250m
-      memory: 1Gi
+      cpu: 100m
+      memory: 128Mi
       ephemeral-storage: 100M
     limits:
       cpu: 2000m
-      memory: 2Gi
+      memory: 4Gi
       ephemeral-storage: 500M
+  web_resource_requirements:
+    requests:
+      cpu: 100m
+      memory: 128Mi
+    limits:
+      cpu: 1000m
+      memory: 4Gi
   ee_resource_requirements:
     requests:
-      cpu: 250m
-      memory: 100Mi
-      ephemeral-storage: 100M
+      cpu: 100m
+      memory: 64Mi
     limits:
-      cpu: 500m
+      cpu: 1000m
+      memory: 4Gi
+  redis_resource_requirements:
+    requests:
+      cpu: 50m
+      memory: 64Mi
+    limits:
+      cpu: 1000m
+      memory: 4Gi
+  rsyslog_resource_requirements:
+    requests:
+      cpu: 100m
+      memory: 128Mi
+    limits:
+      cpu: 1000m
+      memory: 2Gi
+  init_container_resource_requirements:
+    requests:
+      cpu: 100m
+      memory: 128Mi
+    limits:
+      cpu: 1000m
+      memory: 2Gi
+  postgres_init_container_resource_requirements:
+    requests:
+      cpu: 10m
+      memory: 64Mi
+    limits:
+      cpu: 1000m
       memory: 2Gi
-      ephemeral-storage: 500M
 ```
+
+
+#### Limits and ResourceQuotas
+
+If the cluster you are deploying in has a ResoruceQuota, you will need to configure resource limits for all of the pods deployed in that cluster. This can be done for AWX pods on the AWX spec in the manner shown above.
+
+There is an example you can use in [`config/samples/awx_v1beta1_awx_resource_limits.yaml`](../../../config/samples/awx_v1beta1_awx_resource_limits.yaml).

hack/publish-to-operator-hub.sh

@@ -19,34 +19,33 @@
 #
 # Remember to change update the VERSION and PREV_VERSION before running!!!
 
-
 set -e
 
-VERSION=${VERSION:-blah2}
-PREV_VERSION=${PREV_VERSION:-blah1}
+VERSION=${VERSION:-$(make print-VERSION)}
+PREV_VERSION=${PREV_VERSION:-$(make print-PREV_VERSION)}
+
 BRANCH=publish-awx-operator-$VERSION
-FORK=${FORK:-fork}
+FORK=${FORK:-awx-auto}
+GITHUB_TOKEN=${GITHUB_TOKEN:-$AWX_AUTO_GITHUB_TOKEN}
 
-IMG=quay.io/ansible/awx-operator:$VERSION
-CATALOG_IMG=quay.io/ansible/awx-operator-catalog:$VERSION
-BUNDLE_IMG=quay.io/ansible/awx-operator-bundle:$VERSION
+IMG_REPOSITORY=${IMG_REPOSITORY:-quay.io/ansible}
 
-# Set path variables
-OPERATOR_PATH=${OPERATOR_PATH:-~/awx-operator}
+OPERATOR_IMG=$IMG_REPOSITORY/awx-operator:$VERSION
+CATALOG_IMG=$IMG_REPOSITORY/awx-operator-catalog:$VERSION
+BUNDLE_IMG=$IMG_REPOSITORY/awx-operator-bundle:$VERSION
 
-# Build & Push Operator Image  # Not needed because it is done as part of the GHA release automation
-# make docker-build docker-push IMG=$IMG
+COMMUNITY_OPERATOR_GITHUB_ORG=${COMMUNITY_OPERATOR_GITHUB_ORG:-k8s-operatorhub}
+COMMUNITY_OPERATOR_PROD_GITHUB_ORG=${COMMUNITY_OPERATOR_PROD_GITHUB_ORG:-redhat-openshift-ecosystem}
 
 # Build bundle directory
-rm -rf bundle/
-make bundle IMG=$IMG
+make bundle IMG=$OPERATOR_IMG
 
 # Build bundle and catalog images
-make bundle-build bundle-push BUNDLE_IMG=$BUNDLE_IMG IMG=$IMG
-make catalog-build catalog-push CATALOG_IMG=$CATALOG_IMG BUNDLE_IMGS=$BUNDLE_IMG BUNDLE_IMG=$BUNDLE_IMG IMG=$IMG
+make bundle-build bundle-push BUNDLE_IMG=$BUNDLE_IMG IMG=$OPERATOR_IMG
+make catalog-build catalog-push CATALOG_IMG=$CATALOG_IMG BUNDLE_IMGS=$BUNDLE_IMG BUNDLE_IMG=$BUNDLE_IMG IMG=$OPERATOR_IMG
 
 # Set containerImage & namespace variables in CSV
-sed -i.bak -e "s|containerImage: quay.io/ansible/awx-operator:devel|containerImage: quay.io/ansible/awx-operator:${VERSION}|g" bundle/manifests/awx-operator.clusterserviceversion.yaml
+sed -i.bak -e "s|containerImage: quay.io/ansible/awx-operator:devel|containerImage: ${OPERATOR_IMG}|g" bundle/manifests/awx-operator.clusterserviceversion.yaml
 sed -i.bak -e "s|namespace: placeholder|namespace: awx|g" bundle/manifests/awx-operator.clusterserviceversion.yaml
 
 # Add replaces to dependency graph for upgrade path
@@ -67,17 +66,13 @@ fi
 # Remove .bak files from bundle result from sed commands
 find bundle -name "*.bak" -type f -delete
 
-# -- Put up community-operators PR
-cd $OPERATOR_PATH
-git clone git@github.com:k8s-operatorhub/community-operators.git
+echo "-- Create branch on community-operators fork --"
+git clone https://github.com/$COMMUNITY_OPERATOR_GITHUB_ORG/community-operators.git
 
 mkdir -p community-operators/operators/awx-operator/$VERSION/
 cp -r bundle/* community-operators/operators/awx-operator/$VERSION/
-cd community-operators/operators/awx-operator/$VERSION/
-pwd
-ls -la
+pushd community-operators/operators/awx-operator/$VERSION/
 
-# Commit and push PR
 git checkout -b $BRANCH
 git add ./
 git status
@@ -86,26 +81,26 @@ message='operator [N] [CI] awx-operator'
 commitMessage="${message} ${VERSION}"
 git commit -m "$commitMessage" -s
 
-git remote add upstream git@github.com:$FORK/community-operators.git
+git remote add upstream https://$GITHUB_TOKEN@github.com/$FORK/community-operators.git
+
+git push upstream --delete $BRANCH || true
 git push upstream $BRANCH
 
+gh pr create \
+  --title "operator awx-operator (${VERSION})" \
+  --body "operator awx-operator (${VERSION})" \
+  --base main \
+  --head $FORK:$BRANCH \
+  --repo $COMMUNITY_OPERATOR_GITHUB_ORG/community-operators
+popd
 
-# -- Put up community-operators-prod PR
-# Reset directory
-cd $OPERATOR_PATH
-
-pwd
-
-git clone git@github.com:redhat-openshift-ecosystem/community-operators-prod.git
+echo "-- Create branch on community-operators-prod fork --"
+git clone https://github.com/$COMMUNITY_OPERATOR_PROD_GITHUB_ORG/community-operators-prod.git
 
 mkdir -p community-operators-prod/operators/awx-operator/$VERSION/
 cp -r bundle/* community-operators-prod/operators/awx-operator/$VERSION/
-cd community-operators-prod/operators/awx-operator/$VERSION/
+pushd community-operators-prod/operators/awx-operator/$VERSION/
 
-pwd
-ls -la
-
-# Commit and push PR
 git checkout -b $BRANCH
 git add ./
 git status
@@ -114,15 +109,15 @@ message='operator [N] [CI] awx-operator'
 commitMessage="${message} ${VERSION}"
 git commit -m "$commitMessage" -s
 
-git remote add upstream git@github.com:$FORK/community-operators-prod.git
+git remote add upstream https://$GITHUB_TOKEN@github.com/$FORK/community-operators-prod.git
+
+git push upstream --delete $BRANCH || true
 git push upstream $BRANCH
 
-
-# -- Print Links to Branches
-echo "Commnity Operators: https://github.com/$FORK/community-operators/pull/new/$BRANCH"
-echo "Commnity Operators Prod: https://github.com/$FORK/community-operators-prod/pull/new/$BRANCH"
-
-# -- Cleanup
-
-rm -rf $OPERATOR_PATH/community-operators
-rm -rf $OPERATOR_PATH/community-operators-prod
+gh pr create \
+  --title "operator awx-operator (${VERSION})" \
+  --body "operator awx-operator (${VERSION})" \
+  --base main \
+  --head $FORK:$BRANCH \
+  --repo $COMMUNITY_OPERATOR_PROD_GITHUB_ORG/community-operators-prod
+popd

roles/installer/tasks/upgrade_postgres.yml

@@ -101,7 +101,7 @@
       }
       keepalive_file=\"$(mktemp)\"
       while [[ -f \"$keepalive_file\" ]]; do
-        echo 'Migrating data to new PostgreSQL {{ supported_postgres_version }} Database...'
+        echo 'Migrating data to new PostgreSQL {{ supported_pg_version }} Database...'
         sleep 60
       done &
       keepalive_pid=$!