Merge pull request #811 from shanemcd/format-readme-tables

Reformat markdown tables in README.md
2026-03-27 05:43:11 +00:00 · 2022-03-05 12:12:25 -05:00 · 2022-03-05 12:02:18 -05:00 · 2022-03-05 11:59:00 -05:00 · 2022-03-05 11:48:13 -05:00 · 2022-03-05 10:18:50 -05:00
17 changed files with 311 additions and 149 deletions
--- a/.github/issue_labeler.yml
+++ b/.github/issue_labeler.yml
@@ -0,0 +1,3 @@
+---
+needs_triage:
+  - '.*'
--- a/.github/workflows/triage_new.yml
+++ b/.github/workflows/triage_new.yml
@@ -0,0 +1,22 @@
+---
+name: Triage
+
+on:
+  issues:
+    types:
+      - opened
+
+jobs:
+  triage:
+    runs-on: ubuntu-latest
+    name: Label
+
+    steps:
+      - name: Label issues
+        uses: github/issue-labeler@v2.4.1
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          not-before: 2021-12-07T07:00:00Z
+          configuration-path: .github/issue_labeler.yml
+          enable-versioned-regex: 0
+        if: github.event_name == 'issues'
--- a/3
+++ b/3
@@ -89,10 +89,11 @@ deploy: kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/c
 	@$(KUSTOMIZE) build config/default | kubectl apply -f -

 undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
+	@cd config/default && $(KUSTOMIZE) edit set namespace ${NAMESPACE}
 	$(KUSTOMIZE) build config/default | kubectl delete -f -

 OS := $(shell uname -s | tr '[:upper:]' '[:lower:]')
-ARCH := $(shell uname -m | sed 's/x86_64/amd64/')
+ARCH := $(shell uname -m | sed -e 's/x86_64/amd64/' -e 's/aarch64/arm64/')

 .PHONY: kustomize
 KUSTOMIZE = $(shell pwd)/bin/kustomize
--- a/README.md
+++ b/README.md
@@ -11,7 +11,8 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w
 * [Table of Contents](#table-of-contents)
   * [Purpose](#purpose)
   * [Usage](#usage)
-      * [Basic Install](#basic-install)
+      * [Basic Install on minikube (beginner or testing)](#basic-install-on-minikube-beginner-or-testing)
+      * [Basic Install on existing cluster](#basic-install-on-existing-cluster)
      * [Admin user account configuration](#admin-user-account-configuration)
      * [Network and TLS Configuration](#network-and-tls-configuration)
         * [Service Type](#service-type)
@@ -22,21 +23,22 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w
         * [Managed PostgreSQL Service](#managed-postgresql-service)
      * [Advanced Configuration](#advanced-configuration)
         * [Deploying a specific version of AWX](#deploying-a-specific-version-of-awx)
+         * [Redis container capabilities](#redis-container-capabilities)
         * [Privileged Tasks](#privileged-tasks)
         * [Containers Resource Requirements](#containers-resource-requirements)
+         * [Assigning AWX pods to specific nodes](#assigning-awx-pods-to-specific-nodes)
         * [Trusting a Custom Certificate Authority](#trusting-a-custom-certificate-authority)
         * [Persisting Projects Directory](#persisting-projects-directory)
         * [Custom Volume and Volume Mount Options](#custom-volume-and-volume-mount-options)
+         * [Default execution environments from private registries](#default-execution-environments-from-private-registries)
         * [Exporting Environment Variables to Containers](#exporting-environment-variables-to-containers)
         * [Extra Settings](#extra-settings)
         * [Service Account](#service-account)
      * [Uninstall](#uninstall)
-   * [Upgrading](#upgrading)
+      * [Upgrading](#upgrading)
+         * [v0.14.0](#v0140)
   * [Contributing](#contributing)
   * [Release Process](#release-process)
-      * [Verifiy Functionality](#verify-functionality)
-      * [Update Version](#update-version)
-      * [Commit / Create Release](#commit--create-release)
   * [Author](#author)
 <!--te-->

@@ -46,7 +48,7 @@ This operator is meant to provide a more Kubernetes-native installation method f

 ## Usage

-### Basic Install
+### Basic Install on minikube (beginner or testing)

 This Kubernetes Operator is meant to be deployed in your Kubernetes cluster(s) and can manage one or more AWX instances in any namespace.

@@ -104,23 +106,22 @@ Now you need to deploy AWX Operator into your cluster. Clone this repo and `git
 ```
 $ export NAMESPACE=my-namespace
 $ make deploy
-cd config/manager && /home/user/awx-operator/bin/kustomize edit set image controller=quay.io/ansible/awx-operator:0.14.0
-/home/user/awx-operator/bin/kustomize build config/default | kubectl apply -f -
-namespace/my-namespace created
-customresourcedefinition.apiextensions.k8s.io/awxbackups.awx.ansible.com created
-customresourcedefinition.apiextensions.k8s.io/awxrestores.awx.ansible.com created
-customresourcedefinition.apiextensions.k8s.io/awxs.awx.ansible.com created
-serviceaccount/awx-operator-controller-manager created
-role.rbac.authorization.k8s.io/awx-operator-leader-election-role created
-role.rbac.authorization.k8s.io/awx-operator-manager-role created
-clusterrole.rbac.authorization.k8s.io/awx-operator-metrics-reader created
-clusterrole.rbac.authorization.k8s.io/awx-operator-proxy-role created
-rolebinding.rbac.authorization.k8s.io/awx-operator-leader-election-rolebinding created
-rolebinding.rbac.authorization.k8s.io/awx-operator-manager-rolebinding created
-clusterrolebinding.rbac.authorization.k8s.io/awx-operator-proxy-rolebinding created
-configmap/awx-operator-manager-config created
-service/awx-operator-controller-manager-metrics-service created
-deployment.apps/awx-operator-controller-manager created
+  /home/user/awx-operator/bin/kustomize build config/default | kubectl apply -f -
+  namespace/my-namespace created
+  customresourcedefinition.apiextensions.k8s.io/awxbackups.awx.ansible.com created
+  customresourcedefinition.apiextensions.k8s.io/awxrestores.awx.ansible.com created
+  customresourcedefinition.apiextensions.k8s.io/awxs.awx.ansible.com created
+  serviceaccount/awx-operator-controller-manager created
+  role.rbac.authorization.k8s.io/awx-operator-leader-election-role created
+  role.rbac.authorization.k8s.io/awx-operator-manager-role created
+  clusterrole.rbac.authorization.k8s.io/awx-operator-metrics-reader created
+  clusterrole.rbac.authorization.k8s.io/awx-operator-proxy-role created
+  rolebinding.rbac.authorization.k8s.io/awx-operator-leader-election-rolebinding created
+  rolebinding.rbac.authorization.k8s.io/awx-operator-manager-rolebinding created
+  clusterrolebinding.rbac.authorization.k8s.io/awx-operator-proxy-rolebinding created
+  configmap/awx-operator-manager-config created
+  service/awx-operator-controller-manager-metrics-service created
+  deployment.apps/awx-operator-controller-manager created
 ```

 Wait a bit and you should have the `awx-operator` running:
@@ -137,6 +138,8 @@ So we don't have to keep repeating `-n $NAMESPACE`, let's set the current namesp
 $ kubectl config set-context --current --namespace=$NAMESPACE
 ```

+It is important to know that when you do not set the default namespace to $NAMESPACE that the `awx-operator-controller-manager` might get confused.
+
 Next, create a file named `awx-demo.yml` with the suggested content below. The `metadata.name` you provide, will be the name of the resulting AWX deployment.

 **Note:** If you deploy more than one AWX instance to the same namespace, be sure to use unique names.
@@ -157,6 +160,12 @@ Finally, use `kubectl` to create the awx instance in your cluster:
 $ kubectl apply -f awx-demo.yml
 awx.awx.ansible.com/awx-demo created
 ```
+Or, when you haven't set a default namespace
+
+```
+$ kubectl apply -f awx-demo.yml --namespace=$NAMESPACE
+awx.awx.ansible.com/awx-demo created
+```

 After a few minutes, the new AWX instance will be deployed. You can look at the operator pod logs in order to know where the installation process is at:

@@ -197,15 +206,30 @@ For an example using the Nginx Controller in Minukube, don't miss our [demo vide

 [![asciicast](https://raw.githubusercontent.com/ansible/awx-operator/devel/docs/awx-demo.svg)](https://asciinema.org/a/416946)

+### Basic Install on existing cluster
+
+For those running a whole K8S Cluster the steps to set up the awx-operator are:
+
+```
+$ Prepare required files
+git clone https://github.com/ansible/awx-operator.git
+cd awx-operator
+git checkout {{ latest_released_version }} # replace variable by latest version number in releases
+
+$ Deploy new AWX Operator
+export NAMESPACE=<Name of the namespace where your AWX instanse exists>
+make deploy
+```
+
 ### Admin user account configuration

 There are three variables that are customizable for the admin user account creation.

-| Name                        | Description                                  | Default          |
-| --------------------------- | -------------------------------------------- | ---------------- |
-| admin_user                  | Name of the admin user                       | admin            |
-| admin_email                 | Email of the admin user                      | test@example.com |
-| admin_password_secret       | Secret that contains the admin user password | Empty string     |
+| Name                  | Description                                  | Default          |
+| --------------------- | -------------------------------------------- | ---------------- |
+| admin_user            | Name of the admin user                       | admin            |
+| admin_email           | Email of the admin user                      | test@example.com |
+| admin_password_secret | Secret that contains the admin user password | Empty string     |


 > :warning: **admin_password_secret must be a Kubernetes secret and not your text clear password**.
@@ -238,15 +262,18 @@ The `service_type` supported options are: `ClusterIP`, `LoadBalancer` and `NodeP

 The following variables are customizable for any `service_type`

-| Name                                  | Description                                   | Default                           |
-| ------------------------------------- | --------------------------------------------- | --------------------------------- |
-| service_labels                  | Add custom labels                             | Empty string                      |
+| Name                | Description             | Default      |
+| ------------------- | ----------------------- | ------------ |
+| service_labels      | Add custom labels       | Empty string |
+| service_annotations | Add service annotations | Empty string |

 ```yaml
 ---
 spec:
  ...
  service_type: ClusterIP
+  service_annotations: |
+    environment: testing
  service_labels: |
    environment: testing
 ```
@@ -255,11 +282,10 @@ spec:

 The following variables are customizable only when `service_type=LoadBalancer`

-| Name                           | Description                              | Default       |
-| ------------------------------ | ---------------------------------------- | ------------- |
-| loadbalancer_annotations | LoadBalancer annotations                 | Empty string  |
-| loadbalancer_protocol    | Protocol to use for Loadbalancer ingress | http          |
-| loadbalancer_port        | Port used for Loadbalancer ingress       | 80            |
+| Name                  | Description                              | Default |
+| --------------------- | ---------------------------------------- | ------- |
+| loadbalancer_protocol | Protocol to use for Loadbalancer ingress | http    |
+| loadbalancer_port     | Port used for Loadbalancer ingress       | 80      |

 ```yaml
 ---
@@ -268,7 +294,7 @@ spec:
  service_type: LoadBalancer
  loadbalancer_protocol: https
  loadbalancer_port: 443
-  loadbalancer_annotations: |
+  service_annotations: |
    environment: testing
  service_labels: |
    environment: testing
@@ -282,9 +308,9 @@ The HTTPS Load Balancer also uses SSL termination at the Load Balancer level and

 The following variables are customizable only when `service_type=NodePort`

-| Name                           | Description                              | Default       |
-| ------------------------------ | ---------------------------------------- | ------------- |
-| nodeport_port            | Port used for NodePort       | 30080            |
+| Name          | Description            | Default |
+| ------------- | ---------------------- | ------- |
+| nodeport_port | Port used for NodePort | 30080   |

 ```yaml
 ---
@@ -312,13 +338,13 @@ spec:

 The following variables are customizable when `ingress_type=ingress`. The `ingress` type creates an Ingress resource as [documented](https://kubernetes.io/docs/concepts/services-networking/ingress/) which can be shared with many other Ingress Controllers as [listed](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/).

-| Name                       | Description                              | Default                      |
-| -------------------------- | ---------------------------------------- | ---------------------------- |
-| ingress_annotations        | Ingress annotations                      | Empty string                 |
-| ingress_tls_secret         | Secret that contains the TLS information | Empty string                 |
-| hostname                   | Define the FQDN                          | {{ meta.name }}.example.com  |
-| ingress_path               | Define the ingress path to the service   | /                            |
-| ingress_path_type          | Define the type of the path (for LBs)    | Prefix                       |
+| Name                | Description                              | Default                     |
+| ------------------- | ---------------------------------------- | --------------------------- |
+| ingress_annotations | Ingress annotations                      | Empty string                |
+| ingress_tls_secret  | Secret that contains the TLS information | Empty string                |
+| hostname            | Define the FQDN                          | {{ meta.name }}.example.com |
+| ingress_path        | Define the ingress path to the service   | /                           |
+| ingress_path_type   | Define the type of the path (for LBs)    | Prefix                      |

 ```yaml
 ---
@@ -334,8 +360,8 @@ spec:

 The following variables are customizable when `ingress_type=route`

-| Name                                  | Description                                   | Default                                                 |
-| ------------------------------------- | --------------------------------------------- | --------------------------------------------------------|
+| Name                            | Description                                   | Default                                                 |
+| ------------------------------- | --------------------------------------------- | ------------------------------------------------------- |
 | route_host                      | Common name the route answers for             | `<instance-name>-<namespace>-<routerCanonicalHostname>` |
 | route_tls_termination_mechanism | TLS Termination mechanism (Edge, Passthrough) | Edge                                                    |
 | route_tls_secret                | Secret that contains the TLS information      | Empty string                                            |
@@ -393,13 +419,14 @@ If you don't have access to an external PostgreSQL service, the AWX operator can

 The following variables are customizable for the managed PostgreSQL service

-| Name                                 | Description                                | Default                           |
-| ------------------------------------ | ------------------------------------------ | --------------------------------- |
-| postgres_image                       | Path of the image to pull                  | postgres:12                       |
-| postgres_resource_requirements       | PostgreSQL container resource requirements | Empty object                      |
-| postgres_storage_requirements        | PostgreSQL container storage requirements  | requests: {storage: 8Gi}          |
-| postgres_storage_class               | PostgreSQL PV storage class                | Empty string                      |
-| postgres_data_path                   | PostgreSQL data path                       | `/var/lib/postgresql/data/pgdata` |
+| Name                                          | Description                                   | Default                           |
+| --------------------------------------------- | --------------------------------------------- | --------------------------------- |
+| postgres_image                                | Path of the image to pull                     | postgres:12                       |
+| postgres_init_container_resource_requirements | Database init container resource requirements | requests: {}                      |
+| postgres_resource_requirements                | PostgreSQL container resource requirements    | requests: {}                      |
+| postgres_storage_requirements                 | PostgreSQL container storage requirements     | requests: {storage: 8Gi}          |
+| postgres_storage_class                        | PostgreSQL PV storage class                   | Empty string                      |
+| postgres_data_path                            | PostgreSQL data path                          | `/var/lib/postgresql/data/pgdata` |

 Example of customization could be:

@@ -433,15 +460,15 @@ spec:

 There are a few variables that are customizable for awx the image management.

-| Name                      | Description                |
-| --------------------------| -------------------------- |
-| image                     | Path of the image to pull  |
-| image_version             | Image version to pull      |
-| image_pull_policy         | The pull policy to adopt   |
-| image_pull_secret         | The pull secret to use     |
-| ee_images                 | A list of EEs to register  |
-| redis_image               | Path of the image to pull  |
-| redis_image_version       | Image version to pull      |
+| Name                | Description               |
+| ------------------- | ------------------------- |
+| image               | Path of the image to pull |
+| image_version       | Image version to pull     |
+| image_pull_policy   | The pull policy to adopt  |
+| image_pull_secret   | The pull secret to use    |
+| ee_images           | A list of EEs to register |
+| redis_image         | Path of the image to pull |
+| redis_image_version | Image version to pull     |

 Example of customization could be:

@@ -498,11 +525,11 @@ Again, this is the most relaxed SCC that is provided by OpenShift, so be sure to

 The resource requirements for both, the task and the web containers are configurable - both the lower end (requests) and the upper end (limits).

-| Name                             | Description                                      | Default                             |
-| -------------------------------- | ------------------------------------------------ | ----------------------------------- |
-| web_resource_requirements        | Web container resource requirements              | requests: {cpu: 1000m, memory: 2Gi} |
-| task_resource_requirements       | Task container resource requirements             | requests: {cpu: 500m, memory: 1Gi}  |
-| ee_resource_requirements         | EE control plane container resource requirements | requests: {cpu: 500m, memory: 1Gi}  |
+| Name                       | Description                                      | Default                             |
+| -------------------------- | ------------------------------------------------ | ----------------------------------- |
+| web_resource_requirements  | Web container resource requirements              | requests: {cpu: 1000m, memory: 2Gi} |
+| task_resource_requirements | Task container resource requirements             | requests: {cpu: 500m, memory: 1Gi}  |
+| ee_resource_requirements   | EE control plane container resource requirements | requests: {cpu: 500m, memory: 1Gi}  |

 Example of customization could be:

@@ -541,15 +568,16 @@ pods to be scheduled onto nodes with matching taints.
 The ability to specify topologySpreadConstraints is also allowed through `topology_spread_constraints`  


-| Name                           | Description                              | Default |
-| -------------------------------| ---------------------------------------- | ------- |
-| postgres_image                 | Path of the image to pull                | 12      |
-| postgres_image_version         | Image version to pull                    | 12      |
-| node_selector                  | AWX pods' nodeSelector                   | ''      |
-| topology_spread_constraints    | AWX pods' topologySpreadConstraints      | ''      |
-| tolerations                    | AWX pods' tolerations                    | ''      |
-| postgres_selector              | Postgres pods' nodeSelector              | ''      |
-| postgres_tolerations           | Postgres pods' tolerations               | ''      |
+| Name                        | Description                         | Default |
+| --------------------------- | ----------------------------------- | ------- |
+| postgres_image              | Path of the image to pull           | 12      |
+| postgres_image_version      | Image version to pull               | 12      |
+| node_selector               | AWX pods' nodeSelector              | ''      |
+| topology_spread_constraints | AWX pods' topologySpreadConstraints | ''      |
+| tolerations                 | AWX pods' tolerations               | ''      |
+| annotations                 | AWX pods' annotations               | ''      |
+| postgres_selector           | Postgres pods' nodeSelector         | ''      |
+| postgres_tolerations        | Postgres pods' tolerations          | ''      |

 Example of customization could be:

@@ -591,10 +619,10 @@ In cases which you need to trust a custom Certificate Authority, there are few v
 Trusting a custom Certificate Authority allows the AWX to access network services configured with SSL certificates issued locally, such as cloning a project from from an internal Git server via HTTPS. It is common for these scenarios, experiencing the error [unable to verify the first certificate](https://github.com/ansible/awx-operator/issues/376).


-| Name                             | Description                              | Default |
-| -------------------------------- | ---------------------------------------- | --------|
-| ldap_cacert_secret               | LDAP Certificate Authority secret name   |  ''     |
-| bundle_cacert_secret             | Certificate Authority secret name        |  ''     |
+| Name                 | Description                            | Default |
+| -------------------- | -------------------------------------- | ------- |
+| ldap_cacert_secret   | LDAP Certificate Authority secret name | ''      |
+| bundle_cacert_secret | Certificate Authority secret name      | ''      |

 Please note the `awx-operator` will look for the data field `ldap-ca.crt` in the specified secret when using the `ldap_cacert_secret`, whereas the data field `bundle-ca.crt` is required for `bundle_cacert_secret` parameter.

@@ -620,13 +648,13 @@ To create the secret, you can use the command below:

 In cases which you want to persist the `/var/lib/projects` directory, there are few variables that are customizable for the `awx-operator`.

-| Name                               | Description                                                                                          | Default        |
-| -----------------------------------| ---------------------------------------------------------------------------------------------------- | ---------------|
-| projects_persistence         | Whether or not the /var/lib/projects directory will be persistent                                    |  false         |
-| projects_storage_class       | Define the PersistentVolume storage class                                                            |  ''            |
-| projects_storage_size        | Define the PersistentVolume size                                                                     |  8Gi           |
-| projects_storage_access_mode | Define the PersistentVolume access mode                                                              |  ReadWriteMany |
-| projects_existing_claim      | Define an existing PersistentVolumeClaim to use (cannot be combined with `projects_storage_*`) |  ''            |
+| Name                         | Description                                                                                    | Default       |
+| ---------------------------- | ---------------------------------------------------------------------------------------------- | ------------- |
+| projects_persistence         | Whether or not the /var/lib/projects directory will be persistent                              | false         |
+| projects_storage_class       | Define the PersistentVolume storage class                                                      | ''            |
+| projects_storage_size        | Define the PersistentVolume size                                                               | 8Gi           |
+| projects_storage_access_mode | Define the PersistentVolume access mode                                                        | ReadWriteMany |
+| projects_existing_claim      | Define an existing PersistentVolumeClaim to use (cannot be combined with `projects_storage_*`) | ''            |

 Example of customization when the `awx-operator` automatically handles the persistent volume could be:

@@ -643,14 +671,14 @@ spec:

 In a scenario where custom volumes and volume mounts are required to either overwrite defaults or mount configuration files.

-| Name                              | Description                                              | Default |
-| --------------------------------- | -------------------------------------------------------- | ------- |
-| extra_volumes                     | Specify extra volumes to add to the application pod      | ''      |
-| web_extra_volume_mounts           | Specify volume mounts to be added to Web container       | ''      |
-| task_extra_volume_mounts          | Specify volume mounts to be added to Task container      | ''      |
-| ee_extra_volume_mounts            | Specify volume mounts to be added to Execution container | ''      |
-| init_container_extra_volume_mounts| Specify volume mounts to be added to Init container      | ''      |
-| init_container_extra_commands     | Specify additional commands for Init container           | ''      |
+| Name                               | Description                                              | Default |
+| ---------------------------------- | -------------------------------------------------------- | ------- |
+| extra_volumes                      | Specify extra volumes to add to the application pod      | ''      |
+| web_extra_volume_mounts            | Specify volume mounts to be added to Web container       | ''      |
+| task_extra_volume_mounts           | Specify volume mounts to be added to Task container      | ''      |
+| ee_extra_volume_mounts             | Specify volume mounts to be added to Execution container | ''      |
+| init_container_extra_volume_mounts | Specify volume mounts to be added to Init container      | ''      |
+| init_container_extra_commands      | Specify additional commands for Init container           | ''      |


 > :warning: The `ee_extra_volume_mounts` and `extra_volumes` will only take effect to the globally available Execution Environments. For custom `ee`, please [customize the Pod spec](https://docs.ansible.com/ansible-tower/latest/html/administration/external_execution_envs.html#customize-the-pod-spec).
@@ -771,11 +799,11 @@ type: kubernetes.io/dockerconfigjson

 If you need to export custom environment variables to your containers.

-| Name                          | Description                                              | Default |
-| ----------------------------- | -------------------------------------------------------- | ------- |
-| task_extra_env                | Environment variables to be added to Task container      | ''      |
-| web_extra_env                 | Environment variables to be added to Web container       | ''      |
-| ee_extra_env                  | Environment variables to be added to EE container        | ''      |
+| Name           | Description                                         | Default |
+| -------------- | --------------------------------------------------- | ------- |
+| task_extra_env | Environment variables to be added to Task container | ''      |
+| web_extra_env  | Environment variables to be added to Web container  | ''      |
+| ee_extra_env   | Environment variables to be added to EE container   | ''      |

 > :warning: The `ee_extra_env` will only take effect to the globally available Execution Environments. For custom `ee`, please [customize the Pod spec](https://docs.ansible.com/ansible-tower/latest/html/administration/external_execution_envs.html#customize-the-pod-spec).

@@ -798,9 +826,9 @@ Example configuration of environment variables

 With`extra_settings`, you can pass multiple custom settings via the `awx-operator`. The parameter `extra_settings`  will be appended to the `/etc/tower/settings.py` and can be an alternative to the `extra_volumes` parameter.

-| Name                          | Description                                              | Default |
-| ----------------------------- | -------------------------------------------------------- | ------- |
-| extra_settings                | Extra settings                                           | ''      |
+| Name           | Description    | Default |
+| -------------- | -------------- | ------- |
+| extra_settings | Extra settings | ''      |

 Example configuration of `extra_settings` parameter

@@ -818,9 +846,9 @@ Example configuration of `extra_settings` parameter

 If you need to modify some `ServiceAccount` proprieties

-| Name                          | Description                                              | Default |
-| ----------------------------- | -------------------------------------------------------- | ------- |
-| service_account_annotations   | Annotations to the ServiceAccount                        | ''      |
+| Name                        | Description                       | Default |
+| --------------------------- | --------------------------------- | ------- |
+| service_account_annotations | Annotations to the ServiceAccount | ''      |

 Example configuration of environment variables

@@ -859,6 +887,21 @@ delete your existing `awx-operator` service account, role and role binding.

 Starting with awx-operator 0.14.0, the project is now based on operator-sdk 1.x. You may need to manually delete your old operator Deployment to avoid issues.

+##### Steps to upgrade
+
+Delete your old AWX Operator and existing `awx-operator` service account, role and role binding in `default` namespace first:
+
+```
+$ kubectl -n default delete deployment awx-operator
+$ kubectl -n default delete serviceaccount awx-operator
+$ kubectl -n default delete clusterrolebinding awx-operator
+$ kubectl -n default delete clusterrole awx-operator
+```
+
+Then install the new AWX Operator by following the instructions in [Basic Install](#basic-install-on-existing-cluster). The `NAMESPACE` environment variable have to be the name of the namespace in which your old AWX instance resides.
+
+Once the new AWX Operator is up and running, your AWX deployment will also be upgraded.
+
 ## Contributing

 Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md).
--- a/config/crd/bases/awx.ansible.com_awxs.yaml
+++ b/config/crd/bases/awx.ansible.com_awxs.yaml
@@ -67,6 +67,9 @@ spec:
                extra_volumes:
                  description: Specify extra volumes to add to the application pod
                  type: string
+                service_annotations:
+                  description: Annotations to add to the service
+                  type: string
                service_type:
                  description: The service type to be used on the deployed instance
                  type: string
@@ -98,9 +101,6 @@ spec:
                ingress_tls_secret:
                  description: Secret where the Ingress TLS secret can be found
                  type: string
-                loadbalancer_annotations:
-                  description: Annotations to add to the loadbalancer
-                  type: string
                loadbalancer_protocol:
                  description: Protocol to use for the loadbalancer
                  type: string
@@ -140,6 +140,9 @@ spec:
                service_labels:
                  description: Additional labels to apply to the service
                  type: string
+                annotations:
+                  description: annotations for the pods
+                  type: string
                tolerations:
                  description: node tolerations for the pods
                  type: string
@@ -245,6 +248,28 @@ spec:
                          type: string
                      type: object
                  type: object
+                postgres_init_container_resource_requirements:
+                  description: Resource requirements for the postgres init container
+                  properties:
+                    requests:
+                      properties:
+                        cpu:
+                          type: string
+                        memory:
+                          type: string
+                        storage:
+                          type: string
+                      type: object
+                    limits:
+                      properties:
+                        cpu:
+                          type: string
+                        memory:
+                          type: string
+                        storage:
+                          type: string
+                      type: object
+                  type: object
                service_account_annotations:
                  description: ServiceAccount annotations
                  type: string
--- a/config/manifests/bases/olm-parameters.yaml
+++ b/config/manifests/bases/olm-parameters.yaml
@@ -199,7 +199,7 @@
        - urn:alm:descriptor:io.kubernetes:Secret
        - urn:alm:descriptor:com.tectonic.ui:fieldDependency:ingress_type:Ingress
    - displayName: Tower LoadBalancer Annotations
-      path: loadbalancer_annotations
+      path: service_annotations
      x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:advanced
        - urn:alm:descriptor:com.tectonic.ui:text
@@ -261,14 +261,17 @@
      x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:advanced
        - urn:alm:descriptor:com.tectonic.ui:resourceRequirements
-    - displayName: PostgreSQL container resource requirements (when using a managed
-        instance)
+    - displayName: PostgreSQL init container resource requirements (when using a managed instance)
+      path: postgres_init_container_resource_requirements
+      x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:resourceRequirements
+    - displayName: PostgreSQL container resource requirements (when using a managed instance)
      path: postgres_resource_requirements
      x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:advanced
        - urn:alm:descriptor:com.tectonic.ui:resourceRequirements
-    - displayName: PostgreSQL container storage requirements (when using a managed
-        instance)
+    - displayName: PostgreSQL container storage requirements (when using a managed instance)
      path: postgres_storage_requirements
      x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:advanced
@@ -375,6 +378,11 @@
      x-descriptors:
        - urn:alm:descriptor:com.tectonic.ui:advanced
        - urn:alm:descriptor:com.tectonic.ui:hidden
+    - displayName: Postgres Extra Arguments
+      path: postgres_extra_args
+      x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:hidden
    - displayName: Certificate Authorirty Trust Bundle
      path: ca_trust_bundle
      x-descriptors:
@@ -522,6 +530,11 @@
        - urn:alm:descriptor:com.tectonic.ui:advanced
        - urn:alm:descriptor:com.tectonic.ui:text
        - urn:alm:descriptor:com.tectonic.ui:hidden
+    - displayName: Annotations
+      path: annotations
+      x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:advanced
+        - urn:alm:descriptor:com.tectonic.ui:hidden
    - displayName: Tolerations
      path: tolerations
      x-descriptors:
--- a/molecule/default/tasks/awx_test.yml
+++ b/molecule/default/tasks/awx_test.yml
@@ -55,7 +55,7 @@
  rescue:
    - name: Get list of project updates and jobs
      uri:
-        url: "http://localhost/api/v2/{{ item }}/"
+        url: "http://localhost/api/v2/{{ resource }}/"
        user: admin
        password: "{{ admin_pw_secret.resources[0].data.password | b64decode }}"
        force_basic_auth: yes
@@ -63,15 +63,19 @@
      loop:
        - project_updates
        - jobs
+      loop_control:
+        loop_var: resource

    - name: Get all job and project details
      uri:
-        url: "http://localhost{{ item }}"
+        url: "http://localhost{{ endpoint }}"
        user: admin
        password: "{{ admin_pw_secret.resources[0].data.password | b64decode }}"
        force_basic_auth: yes
      loop: |
        {{ job_lists.results | map(attribute='json') | map(attribute='results') | flatten | map(attribute='url') }}
+      loop_control:
+        loop_var: endpoint

    - name: Re-emit failure
      vars:
--- a/molecule/requirements.txt
+++ b/molecule/requirements.txt
@@ -2,6 +2,6 @@ molecule
 molecule-docker
 yamllint
 ansible-lint
-openshift
+openshift!=0.13.0
 jmespath
 ansible-core
--- a/roles/installer/defaults/main.yml
+++ b/roles/installer/defaults/main.yml
@@ -36,7 +36,7 @@ ingress_tls_secret: ''

 loadbalancer_protocol: 'http'
 loadbalancer_port: '80'
-loadbalancer_annotations: ''
+service_annotations: ''

 nodeport_port: '30080'
 # The TLS termination mechanism to use to access
@@ -83,6 +83,12 @@ topology_spread_constraints: ''
 #     effect: "NoSchedule"
 tolerations: ''

+# Add annotations to awx pods. Specify as literal block. E.g.:
+# annotations: |
+#   my.annotation/1: value
+#   my.annotation/2: value2
+annotations: ''
+
 admin_user: admin
 admin_email: test@example.com

@@ -216,6 +222,7 @@ postgres_tolerations: ''
 postgres_storage_requirements:
  requests:
    storage: 8Gi
+postgres_init_container_resource_requirements: {}
 postgres_resource_requirements: {}
 postgres_data_path: '/var/lib/postgresql/data/pgdata'

--- a/roles/installer/tasks/database_configuration.yml
+++ b/roles/installer/tasks/database_configuration.yml
@@ -157,6 +157,10 @@
  retries: 60
  when: pg_config['resources'][0]['data']['type'] | default('') | b64decode == 'managed'

+- name: Set database as managed
+  set_fact:
+    managed_database: "{{ pg_config['resources'][0]['data']['type'] | default('') | b64decode == 'managed' }}"
+
 - name: Look up details for this deployment
  k8s_info:
    api_version: "{{ api_version }}"
--- a/roles/installer/tasks/main.yml
+++ b/roles/installer/tasks/main.yml
@@ -36,6 +36,9 @@
 - name: Include broadcast websocket configuration tasks
  include_tasks: broadcast_websocket_configuration.yml

+- name: Include set_images tasks
+  include_tasks: set_images.yml
+
 - name: Include database configuration tasks
  include_tasks: database_configuration.yml

--- a/roles/installer/tasks/resources_configuration.yml
+++ b/roles/installer/tasks/resources_configuration.yml
@@ -47,24 +47,6 @@
  set_fact:
    _image: "{{ _custom_image | default(lookup('env', 'RELATED_IMAGE_AWX')) | default(_default_image, true) }}"

- name: Set default awx init container image
-  set_fact:
-    _default_init_container_image: "{{ _init_container_image }}:{{ _init_container_image_version }}"
-
- name: Set user provided awx init image
-  set_fact:
-    _custom_init_container_image: "{{ init_container_image }}:{{ init_container_image_version }}"
-  when:
-    - init_container_image | default([]) | length
-    - init_container_image_version is defined or init_container_image_version != ''
-
- name: Set Init image URL
-  set_fact:
-    _init_container_image: |
-      {{ _custom_init_container_image |
-         default(lookup('env', 'RELATED_IMAGE_AWX_INIT_CONTAINER')) |
-         default(_default_init_container_image, true) }}
-
 - name: Set default redis image
  set_fact:
    _default_redis_image: "{{ _redis_image }}:{{ _redis_image_version }}"
--- a/roles/installer/tasks/set_images.yml
+++ b/roles/installer/tasks/set_images.yml
@@ -0,0 +1,19 @@
+# For disconnected environments, images must be set based on the values of `RELATED_IMAGE_` variables
+---
+- name: Set default awx init container image
+  set_fact:
+    _default_init_container_image: "{{ _init_container_image }}:{{ _init_container_image_version }}"
+
+- name: Set user provided awx init image
+  set_fact:
+    _custom_init_container_image: "{{ init_container_image }}:{{ init_container_image_version }}"
+  when:
+    - init_container_image | default([]) | length
+    - init_container_image_version is defined or init_container_image_version != ''
+
+- name: Set Init image URL
+  set_fact:
+    _init_container_image: >-
+      {{ _custom_init_container_image |
+         default(lookup('env', 'RELATED_IMAGE_AWX_INIT_CONTAINER')) |
+         default(_default_init_container_image, true) }}
--- a/roles/installer/templates/config.yaml.j2
+++ b/roles/installer/templates/config.yaml.j2
@@ -18,6 +18,7 @@ data:
  settings: |
    import os
    import socket
+    from django_auth_ldap.config import LDAPSearch
    
    def get_secret():
        if os.path.exists("/etc/tower/SECRET_KEY"):
@@ -25,11 +26,22 @@ data:
    
    ADMINS = ()
    STATIC_ROOT = '/var/lib/awx/public/static'
+    STATIC_URL = '{{ (ingress_path + '/static/').replace('//', '/') }}'
    PROJECTS_ROOT = '/var/lib/awx/projects'
    JOBOUTPUT_ROOT = '/var/lib/awx/job_status'

    IS_K8S = True

+    # Set memory available based off of resource request/limit for the task pod
+    memory_limit = '{{ task_resource_requirements["limits"]["memory"] if "limits" in task_resource_requirements and "memory" in task_resource_requirements["limits"] }}'
+    if memory_limit:
+        SYSTEM_TASK_ABS_MEM = memory_limit
+
+    # Set cpu available based off of resource request/limit for the task pod
+    cpu_limit = '{{ task_resource_requirements["limits"]["cpu"] if "limits" in task_resource_requirements and "cpu" in task_resource_requirements["limits"] }}'
+    if cpu_limit:
+        SYSTEM_TASK_ABS_CPU = cpu_limit
+
    SECRET_KEY = get_secret()
    
    ALLOWED_HOSTS = ['*']
@@ -172,15 +184,15 @@ data:
                deny all;
            }
    
-            location /static/ {
+            location {{ (ingress_path + '/static').replace('//', '/') }} {
                alias /var/lib/awx/public/static/;
            }
    
-            location /favicon.ico {
+            location {{ (ingress_path + '/favicon.ico').replace('//', '/') }} {
                alias /var/lib/awx/public/static/media/favicon.ico;
            }
    
-            location /websocket {
+            location {{ (ingress_path + '/websocket').replace('//', '/') }} {
                # Pass request to the upstream alias
                proxy_pass http://daphne;
                # Require http version 1.1 to allow for upgrade requests
@@ -202,7 +214,7 @@ data:
                proxy_set_header Connection $connection_upgrade;
            }
    
-            location / {
+            location {{ ingress_path }} {
                # Add trailing / if missing
                rewrite ^(.*)$http_host(.*[^/])$ $1$http_host$2/ permanent;
                uwsgi_read_timeout 120s;
--- a/roles/installer/templates/deployment.yaml.j2
+++ b/roles/installer/templates/deployment.yaml.j2
@@ -27,14 +27,18 @@ spec:
        app.kubernetes.io/part-of: '{{ ansible_operator_meta.name }}'
        app.kubernetes.io/managed-by: '{{ deployment_type }}-operator'
        app.kubernetes.io/component: '{{ deployment_type }}'
+{% if annotations %}
+      annotations:
+        {{ annotations | indent(width=8) }}
+{% endif %}
    spec:
      serviceAccountName: '{{ ansible_operator_meta.name }}'
 {% if image_pull_secret %}
      imagePullSecrets:
        - name: {{ image_pull_secret }}
 {% endif %}
-{% if bundle_ca_crt or projects_persistence|bool or init_container_extra_commands %}
      initContainers:
+{% if bundle_ca_crt or projects_persistence|bool or init_container_extra_commands %}
        - name: init
          image: '{{ _init_container_image }}'
          imagePullPolicy: '{{ image_pull_policy }}'
@@ -169,6 +173,8 @@ spec:
              valueFrom:
                fieldRef:
                  fieldPath: metadata.namespace
+            - name: UWSGI_MOUNT_PATH
+              value: "{{ ingress_path }}"
 {% if development_mode | bool %}
            - name: AWX_KUBE_DEVEL
              value: "1"
--- a/roles/installer/templates/postgres.yaml.j2
+++ b/roles/installer/templates/postgres.yaml.j2
@@ -37,6 +37,20 @@ spec:
      imagePullSecrets:
        - name: {{ image_pull_secret }}
 {% endif %}
+      initContainers:
+        - name: database-check
+          image: '{{ _init_container_image }}'
+          resources: {{ postgres_init_container_resource_requirements }}
+          imagePullPolicy: '{{ image_pull_policy }}'
+          command:
+            - /bin/sh
+            - -c
+            - |
+              [[ -d /check-db/pgsql/data ]] && rm -rf /check-db/data && mv /check-db/pgsql/data/ /check-db/data/ && rm -rf /check-db/pgsql || exit 0
+          volumeMounts:
+            - name: postgres
+              mountPath: /check-db
+              subPath: ''
      containers:
        - image: '{{ _postgres_image }}'
          imagePullPolicy: '{{ image_pull_policy }}'
--- a/roles/installer/templates/service.yaml.j2
+++ b/roles/installer/templates/service.yaml.j2
@@ -11,9 +11,9 @@ metadata:
    app.kubernetes.io/component: '{{ deployment_type }}'
    app.kubernetes.io/operator-version: '{{ lookup("env", "OPERATOR_VERSION") }}'
    {{ service_labels | indent(width=4) }}
-{% if service_type | lower == 'loadbalancer' and loadbalancer_annotations %}
+{% if service_annotations %}
  annotations:
-    {{ loadbalancer_annotations | indent(width=4) }}
+    {{ service_annotations | indent(width=4) }}
 {% endif %}
 spec:
  ports:
@@ -39,6 +39,12 @@ spec:
      protocol: TCP
      targetPort: 8052
      name: http
+{% elif service_type | lower == "nodeport" %}
+    - port: {{ nodeport_port }}
+      protocol: TCP
+      targetPort: 8052
+      name: http
+  type: NodePort
 {% endif %}
  selector:
    app.kubernetes.io/name: '{{ ansible_operator_meta.name }}'
@@ -46,8 +52,6 @@ spec:
    app.kubernetes.io/component: '{{ deployment_type }}'
 {% if service_type | lower == "loadbalancer" %}
  type: LoadBalancer
-{% elif service_type | lower == "nodeport" %}
-  type: NodePort
 {% else %}
  type: ClusterIP
 {% endif %}
Author	SHA1	Message	Date
Shane McDonald	5375fec77d	Merge pull request #811 from shanemcd/format-readme-tables Reformat markdown tables in README.md	2022-03-05 12:12:25 -05:00
Shane McDonald	9980192d9e	Reformat markdown tables in README.md	2022-03-05 12:02:18 -05:00
Shane McDonald	e2fc5f46c0	Merge pull request #803 from rooftopcellist/sts-db-check Run database-check initContainer on postgres sts instead	2022-03-05 11:59:00 -05:00
Shane McDonald	5b3be06e8d	Allow for customizing postgres init container resources	2022-03-05 11:48:13 -05:00
Shane McDonald	3c2405f304	Merge pull request #807 from MrBones757/devel added support for pod annotations to awx deployment	2022-03-05 10:18:50 -05:00
Christian M. Adams	192611eea8	Run database-check initContainer on postgres sts instead - This avoids issues with multple initContainers trying to mount the postgres pvc at once, as is the case when there are multiple replicas. Signed-off-by: Christian M. Adams <chadams@redhat.com>	2022-03-05 10:07:07 -05:00
MrBones757	9ca14cef93	added support for pod annotations to awx deployment	2022-02-25 09:54:55 +08:00
Shane McDonald	fbc2d3475c	Merge pull request #800 from ggiinnoo/readme-dummy-proof Added namespace warning \| added apply command for missing namespace	2022-02-23 09:30:19 -05:00
Shane McDonald	58f30fb96c	Merge pull request #789 from ubajze/fix-nodeport-port Fix the custom port specification when service type is NodePort	2022-02-23 09:28:42 -05:00
Gino Jansen	c81b78aad6	Added namespace warning \| added apply command for missing namespace	2022-02-18 14:31:29 +01:00
Shane McDonald	c02e05925e	Merge pull request #797 from kdelee/sky-is-the-limit only set mem/cpu setting if limit is set	2022-02-15 15:41:52 -05:00
Elijah DeLee	479c009716	only set mem/cpu setting if limit is set Otherwise, we get the too-low setting of the request, which will be a rough experience for folks who have been using the operator and are used to the experience of having entire underlying node capacity Users can still set the setting via extra_settings to get the experience of having each pod with a individualized capacity, or set a limit.	2022-02-15 15:35:36 -05:00
Shane McDonald	7807bc516e	Merge pull request #791 from kdelee/set_controlpod_mem_cpu set memory setting based on resource settings	2022-02-15 14:12:41 -05:00
Elijah DeLee	3afcd7fd89	set memory and cpu setting based on resource settings This way we can start using this setting in AWX again to help fix https://github.com/ansible/awx/issues/11640	2022-02-15 14:09:21 -05:00
Shane McDonald	7002131dda	Merge pull request #793 from kurokobo/readme Update TOC in README.md	2022-02-12 13:04:17 -05:00
kurokobo	877943cc27	fix: update TOC in README.md	2022-02-12 16:49:17 +09:00
Shane McDonald	b59a0c5b80	Merge pull request #766 from nodje/Makefile-aarch64-patch Take into account `aarch64` architecture return from uname	2022-02-11 17:36:10 -05:00
Shane McDonald	26b1eb6c87	Merge pull request #776 from arrase/feature/service_annotations Allow service annotations not only for LoadBalancer type	2022-02-11 17:30:56 -05:00
Matthias R. Wiora	39437da72b	feat(readme): add k8s cluster setup instructions (#592 ) Add instructions for using with existing kubernetes cluster	2022-02-11 17:25:37 -05:00
Shane McDonald	e1645a2f8d	Merge pull request #593 from kurokobo/upgrading Add steps to upgrade to 0.14.0	2022-02-11 17:24:10 -05:00
Shane McDonald	224dde769a	Merge pull request #536 from siju-vasudevan/patch-1 LDAPSearch Module is missing	2022-02-11 17:20:56 -05:00
Uros Bajzelj	536d7dc842	Fix the NodePort port specification	2022-02-11 10:57:43 +00:00
Shane McDonald	eac2328bd3	Merge pull request #721 from longns1/update-makefile-undeploy update Makefile undeploy	2022-02-10 10:19:10 -05:00
Shane McDonald	3be986c96c	Merge pull request #783 from AlanCoding/loop_control Add some loop control for ansible warnings	2022-02-10 10:18:26 -05:00
Shane McDonald	768bc2f857	Merge pull request #652 from shanemcd/url-prefix-support Support running AWX at non-root path	2022-02-09 10:37:07 -05:00
Alan Rominger	f05faaaaa0	Add some loop control for ansible warnings	2022-02-04 16:12:28 -05:00
Shane McDonald	957566993b	Merge pull request #782 from AlanCoding/not_that_one Avoid broken openshift package	2022-02-04 15:36:33 -05:00
Alan Rominger	c95f3299b0	Avoid broken openshift package	2022-02-04 15:24:49 -05:00
Christian Adams	1a0e3cf410	Merge pull request #772 from rooftopcellist/always-run-pg-initContainer Always run database-check initContainer	2022-02-02 16:16:34 -05:00
Christian Adams	9368b43614	Merge pull request #775 from rooftopcellist/pg-args-advanced Add OLM params for postgres_extra_vars	2022-02-01 17:02:42 -05:00
Juan Ezquerro LLanes	108addc06e	Allow service annotations not only for LoadBalancer	2022-02-01 20:49:37 +01:00
Shane McDonald	3a3260ffb7	Merge pull request #770 from john-westcott-iv/github_meta_changes Adding triage label to any new issue	2022-02-01 13:15:18 -05:00
Christian M. Adams	960d1f8a32	Fix volume mount syntax error * conditionally run database-check init container only for managed db deployments Signed-off-by: Christian M. Adams <chadams@redhat.com>	2022-02-01 10:50:48 -05:00
Christian M. Adams	4d8f84eb74	Add OLM params for postgres_extra_vars * follow-up for https://github.com/ansible/awx-operator/pull/753 Signed-off-by: Christian M. Adams <chadams@redhat.com>	2022-02-01 08:17:11 -05:00
John Westcott IV	1320c9d175	Fixing linting issues	2022-01-31 12:19:31 -05:00
Christian M. Adams	fab71e054e	Always run database-check initContainer	2022-01-31 09:40:19 -05:00
John Westcott IV	3eede3c922	Adding triage label to any new issue	2022-01-30 13:59:22 -05:00
Christian Adams	d27ce3c34d	Merge pull request #755 from rooftopcellist/mv-data-subPath Use an Init Container to move the pg data subPath in the pvc	2022-01-27 19:55:48 -05:00
Shane McDonald	18d17f2485	Merge pull request #763 from sooslaca/devel Fix issue #762	2022-01-27 08:16:33 -05:00
nodje	47d3ef57f2	Take into account `aarch64` architecture return from uname	2022-01-26 09:32:16 +01:00
sooslaca	8f8336b25a	Fix issue #762 Fix https://github.com/ansible/awx-operator/issues/762	2022-01-23 16:17:24 +01:00
Christian M. Adams	5b636bb8ea	Use an Init Container to move the pg data subPath in the pvc	2022-01-13 23:17:33 -05:00
longns1	79152d2417	update to make undeploy in Makefile works correctly when namespace is not awx	2022-01-07 15:57:27 +07:00
Shane McDonald	c843194cbd	Support running AWX at non-root path	2021-11-14 04:26:24 +00:00
kurokobo	b0824acc48	Add steps to upgrade to 0.14.0	2021-10-29 22:01:10 -04:00
siju-vasudevan	38ec4a3b00	LDAPSearch Module is missing Since LDAPSearch Module is missing LDAP authentication is not working if you configure the LDAP configuration via extra_settings.	2021-09-09 10:04:30 +05:30