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.6.0
This commit is contained in:
parent
b83e23a260
commit
e19c05e241
9 changed files with 29 additions and 17 deletions
16
README.md
16
README.md
|
|
@ -29,17 +29,17 @@ An example implementation of AWX on single node K3s using AWX Operator, with eas
|
||||||
|
|
||||||
- Tested on:
|
- Tested on:
|
||||||
- CentOS Stream 8 (Minimal)
|
- CentOS Stream 8 (Minimal)
|
||||||
- K3s v1.27.5+k3s1
|
- K3s v1.27.6+k3s1
|
||||||
- Products that will be deployed:
|
- Products that will be deployed:
|
||||||
- AWX Operator 2.5.3
|
- AWX Operator 2.6.0
|
||||||
- AWX 23.1.0
|
- AWX 23.2.0
|
||||||
- PostgreSQL 13
|
- PostgreSQL 13
|
||||||
|
|
||||||
## References
|
## References
|
||||||
|
|
||||||
- [K3s - Lightweight Kubernetes](https://docs.k3s.io/)
|
- [K3s - Lightweight Kubernetes](https://docs.k3s.io/)
|
||||||
- [INSTALL.md on ansible/awx](https://github.com/ansible/awx/blob/23.1.0/INSTALL.md) @23.1.0
|
- [INSTALL.md on ansible/awx](https://github.com/ansible/awx/blob/23.2.0/INSTALL.md) @23.2.0
|
||||||
- [README.md on ansible/awx-operator](https://github.com/ansible/awx-operator/blob/2.5.3/README.md) @2.5.3
|
- [README.md on ansible/awx-operator](https://github.com/ansible/awx-operator/blob/2.6.0/README.md) @2.6.0
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
|
|
@ -88,11 +88,15 @@ 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).
|
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).
|
||||||
|
|
||||||
|
**⚠️Note for 2.6.0⚠️**
|
||||||
|
|
||||||
|
**I recommend to avoid using 2.6.0 because of bugs ([#1570](https://github.com/ansible/awx-operator/issues/1570), [#1572](https://github.com/ansible/awx-operator/issues/1572), and [#14486](https://github.com/ansible/awx/issues/14486)) that causes upgrading and backups to fail.**
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd ~
|
cd ~
|
||||||
git clone https://github.com/kurokobo/awx-on-k3s.git
|
git clone https://github.com/kurokobo/awx-on-k3s.git
|
||||||
cd awx-on-k3s
|
cd awx-on-k3s
|
||||||
git checkout 2.5.3
|
git checkout 2.6.0
|
||||||
```
|
```
|
||||||
|
|
||||||
Then invoke `kubectl apply -k operator` to deploy AWX Operator.
|
Then invoke `kubectl apply -k operator` to deploy AWX Operator.
|
||||||
|
|
|
||||||
|
|
@ -42,7 +42,7 @@ This guide does not provide any information how to configure Azure, other DNS se
|
||||||
Deploy cert-manager first.
|
Deploy cert-manager first.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.13.0/cert-manager.yaml
|
kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.13.1/cert-manager.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
Ensure the pods in `cert-manager` namespace are running.
|
Ensure the pods in `cert-manager` namespace are running.
|
||||||
|
|
|
||||||
|
|
@ -7,6 +7,10 @@ This guide is specifically designed to use with the AWX which deployed using [th
|
||||||
|
|
||||||
You can also refer [the official instructions](https://github.com/ansible/awx-operator/tree/devel/roles/backup) for more information.
|
You can also refer [the official instructions](https://github.com/ansible/awx-operator/tree/devel/roles/backup) for more information.
|
||||||
|
|
||||||
|
**⚠️Note for 2.6.0⚠️**
|
||||||
|
|
||||||
|
**I recommend to avoid using 2.6.0 because of bugs ([#1570](https://github.com/ansible/awx-operator/issues/1570) and [#1572](https://github.com/ansible/awx-operator/issues/1572)) that causes backups to fail.**
|
||||||
|
|
||||||
<!-- omit in toc -->
|
<!-- omit in toc -->
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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_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_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.5.3/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.6.0/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_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` |
|
| `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` |
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,10 @@
|
||||||
apiVersion: awx.ansible.com/v1beta1
|
apiVersion: awx.ansible.com/v1beta1
|
||||||
kind: AWXBackup
|
kind: AWXBackup
|
||||||
metadata:
|
metadata:
|
||||||
name: awxbackup-2021-06-06
|
name: awxbackup-2023-09-29
|
||||||
namespace: awx
|
namespace: awx
|
||||||
spec:
|
spec:
|
||||||
deployment_name: awx
|
deployment_name: awx
|
||||||
backup_pvc: awx-backup-claim
|
|
||||||
|
|
||||||
# Uncomment to reveal "censored" logs
|
# Uncomment to reveal "censored" logs
|
||||||
#no_log: false
|
#no_log: false
|
||||||
|
|
|
||||||
|
|
@ -6,15 +6,15 @@ spec:
|
||||||
# These parameters are designed for use with:
|
# These parameters are designed for use with:
|
||||||
# - Pulp Operator: 1.0.0-beta.1
|
# - Pulp Operator: 1.0.0-beta.1
|
||||||
# https://github.com/pulp/pulp-operator/blob/1.0.0-beta.1/README.md
|
# https://github.com/pulp/pulp-operator/blob/1.0.0-beta.1/README.md
|
||||||
# - Galaxy NG: 4.7.1
|
# - Galaxy NG: 4.8.0
|
||||||
# https://github.com/ansible/galaxy_ng/tree/4.7.1
|
# https://github.com/ansible/galaxy_ng/tree/4.8.0
|
||||||
|
|
||||||
deployment_type: galaxy
|
deployment_type: galaxy
|
||||||
|
|
||||||
image: quay.io/pulp/galaxy
|
image: quay.io/pulp/galaxy
|
||||||
image_version: 4.7.1
|
image_version: 4.8.0
|
||||||
image_web: quay.io/pulp/galaxy-web
|
image_web: quay.io/pulp/galaxy-web
|
||||||
image_web_version: 4.7.1
|
image_web_version: 4.8.0
|
||||||
|
|
||||||
admin_password_secret: galaxy-admin-password
|
admin_password_secret: galaxy-admin-password
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -12,8 +12,8 @@ secretGenerator:
|
||||||
- operator=awx
|
- operator=awx
|
||||||
|
|
||||||
resources:
|
resources:
|
||||||
- github.com/ansible/awx-operator/config/default?ref=2.5.3
|
- github.com/ansible/awx-operator/config/default?ref=2.6.0
|
||||||
|
|
||||||
images:
|
images:
|
||||||
- name: quay.io/ansible/awx-operator
|
- name: quay.io/ansible/awx-operator
|
||||||
newTag: 2.5.3
|
newTag: 2.6.0
|
||||||
|
|
|
||||||
|
|
@ -11,6 +11,10 @@ Note that once you upgrade AWX Operator, your AWX will also be upgraded automati
|
||||||
|
|
||||||
[There is `image_version` parameter for AWX resource to change which image will be used](https://ansible.readthedocs.io/projects/awx-operator/en/latest/user-guide/advanced-configuration/deploying-a-specific-version-of-awx.html), but it appears that using a version of AWX other than the one bundled with the AWX Operator [is currently not supported](https://ansible.readthedocs.io/projects/awx-operator/en/latest/user-guide/advanced-configuration/deploying-a-specific-version-of-awx.html). Conversely, if you want to upgrade AWX, you need to plan to upgrade AWX Operator first.
|
[There is `image_version` parameter for AWX resource to change which image will be used](https://ansible.readthedocs.io/projects/awx-operator/en/latest/user-guide/advanced-configuration/deploying-a-specific-version-of-awx.html), but it appears that using a version of AWX other than the one bundled with the AWX Operator [is currently not supported](https://ansible.readthedocs.io/projects/awx-operator/en/latest/user-guide/advanced-configuration/deploying-a-specific-version-of-awx.html). Conversely, if you want to upgrade AWX, you need to plan to upgrade AWX Operator first.
|
||||||
|
|
||||||
|
**⚠️Note for 2.6.0⚠️**
|
||||||
|
|
||||||
|
**I recommend to avoid using 2.6.0 because of bugs ([#14486](https://github.com/ansible/awx/issues/14486)) that causes upgrading to fail.**
|
||||||
|
|
||||||
<!-- omit in toc -->
|
<!-- omit in toc -->
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
|
|
@ -118,7 +122,7 @@ sudo rm -rf /data/postgres
|
||||||
|
|
||||||
## 📝 Upgrade from `0.13.0` (e.g. from `0.13.0` to `0.14.0`)
|
## 📝 Upgrade from `0.13.0` (e.g. from `0.13.0` to `0.14.0`)
|
||||||
|
|
||||||
If you are using AWX Operator `0.13.0` and want to upgrade to newer version, you should consider the big changes in AWX Operator in `0.14.0`. [As described in the documentation](https://github.com/ansible/awx-operator/blob/2.5.3/docs/upgrade/upgrading.md#v0140), in `0.14.0`, AWX Operator changed from cluster scope to namespace scope. Also, the Operator SDK `1.x` is used.
|
If you are using AWX Operator `0.13.0` and want to upgrade to newer version, you should consider the big changes in AWX Operator in `0.14.0`. [As described in the documentation](https://ansible.readthedocs.io/projects/awx-operator/en/latest/upgrade/upgrading.html#v0140), in `0.14.0`, AWX Operator changed from cluster scope to namespace scope. Also, the Operator SDK `1.x` is used.
|
||||||
|
|
||||||
This means that upgrading from `0.13.0` to `0.14.0` or later requires a bit of finesse, such as cleaning the old AWX Operator. **If you are using `0.12.0` or earlier and want to upgrade to `0.14.0` or later, I recommend you to [upgrade to `0.13.0` first](#-upgrade-from-0120-or-earlier-eg-from-0120-to-0130) and then come back to here to avoid unintended issue.**
|
This means that upgrading from `0.13.0` to `0.14.0` or later requires a bit of finesse, such as cleaning the old AWX Operator. **If you are using `0.12.0` or earlier and want to upgrade to `0.14.0` or later, I recommend you to [upgrade to `0.13.0` first](#-upgrade-from-0120-or-earlier-eg-from-0120-to-0130) and then come back to here to avoid unintended issue.**
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -10,6 +10,7 @@ The table below maps the AWX Operator versions and bundled AWX versions.
|
||||||
|
|
||||||
| AWX Operator | AWX |
|
| AWX Operator | AWX |
|
||||||
| - | - |
|
| - | - |
|
||||||
|
| 2.6.0 | 23.2.0 |
|
||||||
| 2.5.3 | 23.1.0 |
|
| 2.5.3 | 23.1.0 |
|
||||||
| 2.5.2 | 23.0.0 |
|
| 2.5.2 | 23.0.0 |
|
||||||
| 2.5.1 | 22.7.0 |
|
| 2.5.1 | 22.7.0 |
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue