mirror of
https://github.com/Expand-sys/awx-on-k3s
synced 2025-12-16 05:52:15 +11:00
feat: bump operator version to 2.12.1
This commit is contained in:
kurokobo
parent
10b0bfdec0
commit
d536378763
7 changed files with 54 additions and 56 deletions
13
README.md
13
README.md
|
|
@ -31,15 +31,15 @@ An example implementation of AWX on single node K3s using AWX Operator, with eas
|
|||
- CentOS Stream 8 (Minimal)
|
||||
- K3s v1.28.6+k3s2
|
||||
- Products that will be deployed:
|
||||
- AWX Operator 2.12.0
|
||||
- AWX 23.8.0
|
||||
- AWX Operator 2.12.1
|
||||
- AWX 23.8.1
|
||||
- PostgreSQL 13
|
||||
|
||||
## References
|
||||
|
||||
- [K3s - Lightweight Kubernetes](https://docs.k3s.io/)
|
||||
- [INSTALL.md on ansible/awx](https://github.com/ansible/awx/blob/23.8.0/INSTALL.md) @23.8.0
|
||||
- [README.md on ansible/awx-operator](https://github.com/ansible/awx-operator/blob/2.12.0/README.md) @2.12.0
|
||||
- [INSTALL.md on ansible/awx](https://github.com/ansible/awx/blob/23.8.1/INSTALL.md) @23.8.1
|
||||
- [README.md on ansible/awx-operator](https://github.com/ansible/awx-operator/blob/2.12.1/README.md) @2.12.1
|
||||
|
||||
## Requirements
|
||||
|
||||
|
|
@ -84,9 +84,6 @@ curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION=v1.28.6+k3s2 sh -s - --write-
|
|||
|
||||
### Install AWX Operator
|
||||
|
||||
> [!WARNING]
|
||||
> AWX Operator 2.12.0 and AWX 23.8.0 are marked as NOT RECOMMENDED due to [a known issue](https://github.com/ansible/awx/issues/14876). Refer to the release notes ([for AWX Operator](https://github.com/ansible/awx-operator/releases/tag/2.12.0), [for AWX](https://github.com/ansible/awx/releases/tag/23.8.0)) for details.
|
||||
|
||||
Clone this repository and change directory.
|
||||
|
||||
If you want to use files suitable for the specific version of AWX Operator, [refer tags in this repository](https://github.com/kurokobo/awx-on-k3s/tags) and specify desired tag in `git checkout`. Especially for `0.13.0` or earlier version of AWX Operator, refer to [📝Tips: Deploy older version of AWX Operator](tips/deploy-older-operator.md).
|
||||
|
|
@ -95,7 +92,7 @@ If you want to use files suitable for the specific version of AWX Operator, [ref
|
|||
cd ~
|
||||
git clone https://github.com/kurokobo/awx-on-k3s.git
|
||||
cd awx-on-k3s
|
||||
git checkout 2.12.0
|
||||
git checkout 2.12.1
|
||||
```
|
||||
|
||||
Then invoke `kubectl apply -k operator` to deploy AWX Operator.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ An example simple playbook for Ansible is also provided in this repository. This
|
|||
| - | - | - |
|
||||
| `awxbackup_namespace` | The name of the NameSpace where the `AWXBackup` resource will be created. | `awx` |
|
||||
| `awxbackup_name` | The name of the `AWXBackup` resource. Dynamically generated using execution time by default. | `awxbackup-{{ lookup('pipe', 'date +%Y-%m-%d-%H-%M-%S') }}` |
|
||||
| `awxbackup_spec` | The `spec` of the `AWXBackup` resource. Refer [official documentation](https://github.com/ansible/awx-operator/tree/2.12.0/roles/backup) for acceptable fields. | `deployment_name: awx`<br>`backup_pvc: awx-backup-claim`<br>`clean_backup_on_delete: true` |
|
||||
| `awxbackup_spec` | The `spec` of the `AWXBackup` resource. Refer [official documentation](https://github.com/ansible/awx-operator/tree/2.12.1/roles/backup) for acceptable fields. | `deployment_name: awx`<br>`backup_pvc: awx-backup-claim`<br>`clean_backup_on_delete: true` |
|
||||
| `awxbackup_timeout` | Time to wait for backup to complete, in seconds. If exceeded, the playbook will fail. | `600` |
|
||||
| `awxbackup_keep_days` | Number of days to keep `AWXBackup` resources. `AWXBackup` resources older than this value will be deleted by this playbook. Set `0` to keep forever. | `30` |
|
||||
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ secretGenerator:
|
|||
- operator=awx
|
||||
|
||||
resources:
|
||||
- github.com/ansible/awx-operator/config/default?ref=2.12.0
|
||||
- github.com/ansible/awx-operator/config/default?ref=2.12.1
|
||||
|
||||
images:
|
||||
- name: quay.io/ansible/awx-operator
|
||||
newTag: 2.12.0
|
||||
newTag: 2.12.1
|
||||
|
|
|
|||
|
|
@ -204,6 +204,14 @@ helm repo update
|
|||
helm -n awx upgrade -i awx awx-operator/awx-operator -f base/values.yaml
|
||||
```
|
||||
|
||||
If the upgraded AWX Operator has been released with CRD changes, you may need to run following command to apply the changes.
|
||||
|
||||
```bash
|
||||
# Specify the version of the upgraded AWX Operator
|
||||
VERSION="1.0.1"
|
||||
kubectl apply --server-side --force-conflicts -k github.com/ansible/awx-operator/config/crd?ref=${VERSION}
|
||||
```
|
||||
|
||||
#### Gather history of upgrades
|
||||
|
||||
The history of the upgrades for the release can be listed with `history` command.
|
||||
|
|
|
|||
|
|
@ -16,7 +16,6 @@ For example, some resources deployed with the following command;
|
|||
|
||||
```bash
|
||||
$ kubectl apply -k base
|
||||
namespace/awx created
|
||||
secret/awx-admin-password created
|
||||
secret/awx-postgres-configuration created
|
||||
secret/awx-secret-tls created
|
||||
|
|
@ -26,11 +25,11 @@ persistentvolumeclaim/awx-projects-claim created
|
|||
awx.awx.ansible.com/awx created
|
||||
```
|
||||
|
||||
can be deleted with the following command with same manifest files.
|
||||
can be deleted with the following command with same manifest files. Note that PVC for PostgreSQL should be removed manually since this PVC was created by not `kubectl apply -k` but AWX Operator.
|
||||
|
||||
```bash
|
||||
$ kubectl -n awx delete pvc postgres-13-awx-postgres-13-0 --wait=false
|
||||
$ kubectl delete -k base
|
||||
namespace "awx" deleted
|
||||
secret "awx-admin-password" deleted
|
||||
secret "awx-postgres-configuration" deleted
|
||||
secret "awx-secret-tls" deleted
|
||||
|
|
|
|||
|
|
@ -16,8 +16,6 @@ Note that once you upgrade AWX Operator, your AWX will also be upgraded automati
|
|||
|
||||
- [✅ Take a backup of the old AWX instance](#-take-a-backup-of-the-old-awx-instance)
|
||||
- [📝 Upgrade from `0.14.0` or later (e.g. from `0.14.0` to `0.15.0`)](#-upgrade-from-0140-or-later-eg-from-0140-to-0150)
|
||||
- [⚠️ Note for upgrading from `2.0.0` to `2.0.1` or later](#️-note-for-upgrading-from-200-to-201-or-later)
|
||||
- [⚠️ Note for upgrading from `0.25.0` or earlier to `0.26.0` or later](#️-note-for-upgrading-from-0250-or-earlier-to-0260-or-later)
|
||||
- [📝 Procedure](#-procedure)
|
||||
- [📝 Upgrade from `0.13.0` (e.g. from `0.13.0` to `0.14.0`)](#-upgrade-from-0130-eg-from-0130-to-0140)
|
||||
- [📝 Procedure](#-procedure-1)
|
||||
|
|
@ -36,47 +34,42 @@ Refer [📝README: Backing up using AWX Operator](../README.md#backing-up-using-
|
|||
If you are using AWX Operator `0.14.0` or later and want to upgrade to newer version, basically upgrade is done by deploying the new version of AWX Operator to the same namespace where the old AWX Operator is running.
|
||||
|
||||
> [!WARNING]
|
||||
> AWX Operator 2.12.0 and AWX 23.8.0 are marked as NOT RECOMMENDED due to [a known issue](https://github.com/ansible/awx/issues/14876). Refer to the release notes ([for AWX Operator](https://github.com/ansible/awx-operator/releases/tag/2.12.0), [for AWX](https://github.com/ansible/awx/releases/tag/23.8.0)) for details.
|
||||
> If you are planning to upgrade AWX Operator **from `2.0.0` to `2.0.1` or later**, note that [the `extra_volumes` and `extra_volumes` in `base/awx.yaml` for `2.0.0` as a workaround for specific issue](https://github.com/kurokobo/awx-on-k3s/blob/2.0.0/base/awx.yaml#L42-L51) causes failure of upgrading.
|
||||
>
|
||||
> To avoid this, follow these steps before upgrading AWX Operator. Steps 1 and 2 can also be achieved by `kubectl -n awx edit awx awx`.
|
||||
>
|
||||
> 1. Remove the definition of the volume and volume mount that named `awx-projects-web` in `extra_volumes` and `web_extra_volume_mounts` in your `base/awx.yaml`.
|
||||
> - If there are no other volumes or volume mounts, you can remove whole `extra_volumes` and `web_extra_volume_mounts`.
|
||||
> 2. Apply modified `base/awx.yaml` by `kubectl apply -k base`
|
||||
> 3. Wait for deployment for AWX to be completed
|
||||
>
|
||||
> Once your AWX has been deployed without volume `awx-projects-web`, your AWX can be safely upgraded. Proceed to [the next step](#-procedure).
|
||||
|
||||
### ⚠️ Note for upgrading from `2.0.0` to `2.0.1` or later
|
||||
|
||||
Note that only when upgrading **from `2.0.0` that deployed using this repository to `2.0.1` or later**, [the `extra_volumes` and `extra_volumes` in `base/awx.yaml` for `2.0.0` as a workaround for specific issue](https://github.com/kurokobo/awx-on-k3s/blob/2.0.0/base/awx.yaml#L42-L51) causes failure of upgrading.
|
||||
|
||||
To avoid this, follow these steps before upgrading AWX Operator. Steps 1 and 2 can also be achieved by `kubectl -n awx edit awx awx`.
|
||||
|
||||
1. Remove the definition of the volume and volume mount that named `awx-projects-web` in `extra_volumes` and `web_extra_volume_mounts` in your `base/awx.yaml`.
|
||||
- If there are no other volumes or volume mounts, you can remove whole `extra_volumes` and `web_extra_volume_mounts`.
|
||||
2. Apply modified `base/awx.yaml` by `kubectl apply -k base`
|
||||
3. Wait for deployment for AWX to be completed
|
||||
|
||||
Once your AWX has been deployed without volume `awx-projects-web`, your AWX can be safely upgraded. Proceed to [the next step](#-procedure).
|
||||
|
||||
### ⚠️ Note for upgrading from `0.25.0` or earlier to `0.26.0` or later
|
||||
|
||||
Note that only when upgrading **from `0.25.0` or earlier to `0.26.0` or later**, since the bundled PostgreSQL version will be changed to 13, so the following additional tasks are required.
|
||||
|
||||
```bash
|
||||
# Required only when upgrading from 0.25.0 or earlier to 0.26.0 or later
|
||||
sudo mkdir -p /data/postgres-13
|
||||
sudo chmod 755 /data/postgres-13
|
||||
cat <<EOF > pv-postgres-13.yaml
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: PersistentVolume
|
||||
metadata:
|
||||
name: awx-postgres-13-volume
|
||||
spec:
|
||||
accessModes:
|
||||
- ReadWriteOnce
|
||||
persistentVolumeReclaimPolicy: Retain
|
||||
capacity:
|
||||
storage: 8Gi
|
||||
storageClassName: awx-postgres-volume
|
||||
hostPath:
|
||||
path: /data/postgres-13
|
||||
EOF
|
||||
kubectl apply -f pv-postgres-13.yaml
|
||||
```
|
||||
> [!WARNING]
|
||||
> If you are planning to upgrade AWX Operator **from `0.25.0` or earlier to `0.26.0` or later**, note that since the bundled PostgreSQL version will be changed to 13, so the following additional tasks are required.
|
||||
>
|
||||
> ```bash
|
||||
> # Required only when upgrading from 0.25.0 or earlier to 0.26.0 or later
|
||||
> sudo mkdir -p /data/postgres-13
|
||||
> sudo chmod 755 /data/postgres-13
|
||||
> cat <<EOF > pv-postgres-13.yaml
|
||||
> ---
|
||||
> apiVersion: v1
|
||||
> kind: PersistentVolume
|
||||
> metadata:
|
||||
> name: awx-postgres-13-volume
|
||||
> spec:
|
||||
> accessModes:
|
||||
> - ReadWriteOnce
|
||||
> persistentVolumeReclaimPolicy: Retain
|
||||
> capacity:
|
||||
> storage: 8Gi
|
||||
> storageClassName: awx-postgres-volume
|
||||
> hostPath:
|
||||
> path: /data/postgres-13
|
||||
> EOF
|
||||
> kubectl apply -f pv-postgres-13.yaml
|
||||
> ```
|
||||
|
||||
### 📝 Procedure
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ The table below maps the AWX Operator versions and bundled AWX versions.
|
|||
|
||||
| AWX Operator | AWX |
|
||||
| - | - |
|
||||
| 2.12.1 | 23.8.1 |
|
||||
| 2.12.0 | 23.8.0 |
|
||||
| 2.11.0 | 23.7.0 |
|
||||
| 2.10.0 | 23.6.0 |
|
||||
|
|
|
|||
Loading…
Reference in a new issue