Refactor to resolve the linter warnings on PRs (#1668)

* add 'extraDeploy' value to Helm Chart to allow deploying additional resources

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

@@ -64,7 +64,7 @@ jobs:
           fetch-tags: true
           ref: ${{ env.VERSION }}
           path: awx-operator-${{ env.VERSION }}
-          fetch-depth: 0 # fetch all history so that git describe works
+          fetch-depth: 0  # fetch all history so that git describe works
 
       - name: Copy scripts to awx-operator-${{ env.VERSION }}
         run: |

.helm/starter/README.md

@@ -32,6 +32,63 @@ These sub-headers aim to be a more intuitive entrypoint into customizing your de
 ### External Postgres
 The `AWX.postgres` section simplifies the creation of the external postgres secret. If enabled, the configs provided will automatically be placed in a `postgres-config` secret and linked to the `AWX` resource. For proper secret management, the `AWX.postgres.password` value, and any other sensitive values, can be passed in at the command line rather than specified in code. Use the `--set` argument with `helm install`. Supplying the password this way is not recommended for production use, but may be helpful for initial PoC.
 
+### Additional Kubernetes Resources
+The `AWX.extraDeploy` section allows the creation of additional Kubernetes resources. This simplifies setups requiring additional objects that are used by AWX, e.g. using `ExternalSecrets` to create Kubernetes secrets.
+
+Resources are passed as an array, either as YAML or strings (literal "|"). The resources are passed through `tpl`, so templating is possible. Example:
+
+```yaml
+AWX:
+  # enable use of awx-deploy template
+  ...
+
+  # configurations for external postgres instance
+  postgres:
+    enabled: false
+    ...
+
+extraDeploy:
+  - |
+    apiVersion: external-secrets.io/v1beta1
+    kind: ExternalSecret
+    metadata:
+      name: {{ .Release.Name }}-postgres-secret-string-example
+      namespace: {{ .Release.Namespace }}
+      labels:
+        app: {{ .Release.Name }}
+    spec:
+      secretStoreRef:
+        name: vault
+        kind: ClusterSecretStore
+      refreshInterval: "1h"
+      target:
+        name: postgres-configuration-secret-string-example
+        creationPolicy: "Owner"
+        deletionPolicy: "Delete"
+      dataFrom:
+        - extract:
+            key: awx/postgres-configuration-secret
+
+  - apiVersion: external-secrets.io/v1beta1
+    kind: ExternalSecret
+    metadata:
+      name: "{{ .Release.Name }}-postgres-secret-yaml-example"
+      namespace: "{{ .Release.Namespace }}"
+      labels:
+        app: "{{ .Release.Name }}"
+    spec:
+      secretStoreRef:
+        name: vault
+        kind: ClusterSecretStore
+      refreshInterval: "1h"
+      target:
+        name: postgres-configuration-secret-yaml-example
+        creationPolicy: "Owner"
+        deletionPolicy: "Delete"
+      dataFrom:
+        - extract:
+            key: awx/postgres-configuration-secret
+```
 
 ## Values Summary
 
@@ -43,6 +100,10 @@ The `AWX.postgres` section simplifies the creation of the external postgres secr
 | `AWX.spec` | specs to directly configure the AWX resource | `{}` |
 | `AWX.postgres` | configurations for the external postgres secret | - |
 
+### extraDeploy
+| Value | Description | Default |
+|---|---|---|
+| `extraDeploy` | array of additional resources to be deployed (supports YAML or literal "\|") | - |
 
 # Contributing
 
@@ -63,5 +124,3 @@ The chart is currently hosted on the gh-pages branch of the repo. During the rel
 Instead of CR, we use `helm repo index` to generate an index from all locally pulled chart versions. Since we build from scratch every time, the timestamps of all entries will be updated. This could be improved by using yq or something similar to detect which tags are already in the index.yaml file, and only merge in tags that are not present.
 
 Not using CR could be addressed in the future by keeping the chart built as a part of releases, as long as CR compares the chart to previous release packages rather than previous commits. If the latter is the case, then we would not have the necessary history for comparison.
-
-

.helm/starter/templates/extra-list.yaml

@@ -0,0 +1,8 @@
+{{- range .Values.extraDeploy }}
+---
+  {{- if typeIs "string" . }}
+    {{- tpl . $ }}
+  {{- else }}
+    {{- tpl (. | toYaml | nindent 0) $ }}
+  {{- end }}
+{{- end }}

docs/user-guide/advanced-configuration/scaling-the-web-and-task-pods-independently.md

@@ -5,4 +5,4 @@ You can scale replicas up or down for each deployment by using the `web_replicas
 - If you specify the `replicas` field, the key passed will scale both the `web` and `task` replicas to the same number. 
 - If `web_replicas` or `task_replicas` is ever passed, it will override the existing `replicas` field on the specific deployment with the new key value.
 
-These new replicas can be constrained in a similar manner to previous single deployments by appending the particular deployment name in front of the constraint used. More about those new constraints can be found below in the [Assigning AWX pods to specific nodes](#assigning-awx-pods-to-specific-nodes) section. 
+These new replicas can be constrained in a similar manner to previous single deployments by appending the particular deployment name in front of the constraint used. More about those new constraints can be found in the [Assigning AWX pods to specific nodes](./assigning-awx-pods-to-specific-nodes.md) page. 

roles/backup/tasks/postgres.yml

@@ -70,13 +70,6 @@
     command: >-
       touch {{ backup_dir }}/tower.db
 
-- name: Set permissions on file for database dump
-  k8s_exec:
-    namespace: "{{ backup_pvc_namespace }}"
-    pod: "{{ ansible_operator_meta.name }}-db-management"
-    command: >-
-      bash -c "chmod 660 {{ backup_dir }}/tower.db && chown :root {{ backup_dir }}/tower.db"
-
 - name: Set full resolvable host name for postgres pod
   set_fact:
     resolvable_db_host: '{{ (awx_postgres_type == "managed") | ternary(awx_postgres_host + "." + ansible_operator_meta.namespace + ".svc", awx_postgres_host) }}'  # yamllint disable-line rule:line-length

roles/installer/tasks/install.yml

@@ -84,8 +84,8 @@
     namespace: "{{ ansible_operator_meta.namespace }}"
   register: restore_status_check
   until:
-    # yamllint disable-line rule:line-length
-    - (restore_status_check.resources | length == 0) or (restore_status_check.resources | selectattr('spec.deployment_name', 'equalto', ansible_operator_meta.name) | map(attribute='status') | selectattr('restoreComplete', 'defined') | map(attribute='restoreComplete') | list | length > 0)
+  # yamllint disable-line rule:line-length
+  - (restore_status_check.resources | length == 0) or (restore_status_check.resources | selectattr('spec.deployment_name', 'equalto', ansible_operator_meta.name) | map(attribute='status') | selectattr('restoreComplete', 'defined') | map(attribute='restoreComplete') | list | length > 0)
   delay: 10
   retries: 8640
   ignore_errors: yes

roles/restore/tasks/postgres.yml

@@ -82,25 +82,34 @@
       -p {{ awx_postgres_port }}
   no_log: "{{ no_log }}"
 
-- name: Set drop db command
-  set_fact:
-    pg_drop_db: >-
-      echo 'DROP DATABASE {{ awx_postgres_database }} WITH (FORCE);' | PGPASSWORD='{{ awx_postgres_pass }}' psql
-      -U {{ awx_postgres_user }}
-      -h {{ resolvable_db_host }}
-      -d postgres
-      -p {{ awx_postgres_port }}
-  no_log: "{{ no_log }}"
+- name: Force drop and create database if force_drop_db is true
+  block:
+    - name: Set drop db command
+      set_fact:
+        pg_drop_db: >-
+          echo 'DROP DATABASE {{ awx_postgres_database }} WITH (FORCE);' | PGPASSWORD='{{ awx_postgres_pass }}' psql
+          -U {{ awx_postgres_user }}
+          -h {{ resolvable_db_host }}
+          -d postgres
+          -p {{ awx_postgres_port }} ;
+      no_log: "{{ no_log }}"
 
-- name: Set create db command
-  set_fact:
-    pg_create_db: >-
-      echo 'CREATE DATABASE {{ awx_postgres_database }} WITH OWNER = {{ awx_postgres_user }};' | PGPASSWORD='{{ awx_postgres_pass }}' psql
-      -U {{ awx_postgres_user }}
-      -h {{ resolvable_db_host }}
-      -d postgres
-      -p {{ awx_postgres_port }}
-  no_log: "{{ no_log }}"
+    - name: Set create db command
+      set_fact:
+        pg_create_db: >-
+          echo 'CREATE DATABASE {{ awx_postgres_database }} WITH OWNER = {{ awx_postgres_user }};' | PGPASSWORD='{{ awx_postgres_pass }}' psql
+          -U {{ awx_postgres_user }}
+          -h {{ resolvable_db_host }}
+          -d postgres
+          -p {{ awx_postgres_port }} ;
+      no_log: "{{ no_log }}"
+
+    - name: Set complete pg restore command
+      set_fact:
+        pg_drop_create: >-
+          {{ pg_drop_db }}
+          {{ pg_create_db }}
+  when: force_drop_db
 
 - name: Restore database dump to the new postgresql container
   k8s_exec:
@@ -124,14 +133,11 @@
       trap 'end_keepalive \"$keepalive_file\" \"$keepalive_pid\"' EXIT SIGINT SIGTERM
       echo keepalive_pid: $keepalive_pid
       set -e -o pipefail
-      if {{ force_drop_db }}; then
-        {{ pg_drop_db }}
-        {{ pg_create_db }}
-      fi
+      {{ pg_drop_create }}
       cat {{ backup_dir }}/tower.db | PGPASSWORD='{{ awx_postgres_pass }}' {{ pg_restore }}
+      PG_RC=$?
       set +e +o pipefail
-      echo 'Successful'
+      exit $PG_RC
       "
   register: data_migration
   no_log: "{{ no_log }}"
-  failed_when: "'Successful' not in data_migration.stdout"

roles/restore/vars/main.yml

@@ -14,3 +14,7 @@ broadcast_websocket_secret: '{{ deployment_name }}-broadcast-websocket'
 postgres_configuration_secret: '{{ deployment_name }}-postgres-configuration'
 supported_pg_version: 13
 image_pull_policy: IfNotPresent
+
+# If set to true, the restore process will delete the existing database and create a new one
+force_drop_db: false
+pg_drop_create: ''