expand/awx-on-k3s
1
0
Fork 0
mirror of https://github.com/Expand-sys/awx-on-k3s synced 2026-03-22 19:17:08 +11:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: use kustomize to deploy operator instead of make

Browse source
This commit is contained in:
kurokobo 2023-07-08 16:20:53 +09:00
parent f92da77206
commit ef1c9c4a12
3 changed files with 37 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -20,7 +20,7 @@ An example implementation of AWX on single node K3s using AWX Operator, with eas
- [Prepare CentOS Stream 8 host](#prepare-centos-stream-8-host) - [Prepare CentOS Stream 8 host](#prepare-centos-stream-8-host)
- [Install K3s](#install-k3s) - [Install K3s](#install-k3s)
- [Install AWX Operator](#install-awx-operator) - [Install AWX Operator](#install-awx-operator)
- [Prepare required files](#prepare-required-files) - [Prepare required files to deploy AWX](#prepare-required-files-to-deploy-awx)
- [Deploy AWX](#deploy-awx) - [Deploy AWX](#deploy-awx)
- [Back up and Restore AWX using AWX Operator](#back-up-and-restore-awx-using-awx-operator) - [Back up and Restore AWX using AWX Operator](#back-up-and-restore-awx-using-awx-operator)
- [Additional Guides](#additional-guides) - [Additional Guides](#additional-guides)
@ -71,7 +71,7 @@ sudo reboot
Install required packages to deploy AWX Operator and AWX. Install required packages to deploy AWX Operator and AWX.
```bash ```bash
sudo dnf install -y git make curl tar sudo dnf install -y git curl
``` ```
### Install K3s ### Install K3s
@ -84,23 +84,24 @@ curl -sfL https://get.k3s.io | sh -s - --write-kubeconfig-mode 644
### Install AWX Operator ### Install AWX Operator
Install specified version of AWX Operator. Note that this procedure is applicable only for AWX Operator `0.14.0` or later. If you want to deploy `0.13.0` or earlier version of AWX Operator, refer [📝Tips: Deploy older version of AWX Operator](tips/deploy-older-operator.md). 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).
```bash ```bash
cd ~ cd ~
git clone https://github.com/ansible/awx-operator.git git clone https://github.com/kurokobo/awx-on-k3s.git
cd awx-operator cd awx-on-k3s
git checkout 2.3.0 git checkout 2.3.0
``` ```
Export the name of the namespace where you want to deploy AWX Operator as the environment variable `NAMESPACE` and run `make deploy`. The default namespace is `awx`. Then invoke `kubectl apply -k operator` to deploy AWX Operator.
```bash ```bash
export NAMESPACE=awx kubectl apply -k operator
make deploy
``` ```
The AWX Operator will be deployed to the namespace you specified. The AWX Operator will be deployed to the namespace `awx`.
```bash ```bash
$ kubectl -n awx get all $ kubectl -n awx get all
@ -117,18 +118,7 @@ NAME DESIRED CURRENT
replicaset.apps/awx-operator-controller-manager-68d787cfbd 1 1 1 16s replicaset.apps/awx-operator-controller-manager-68d787cfbd 1 1 1 16s
``` ```
### Prepare required files ### Prepare required files to deploy AWX
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`.
```bash
cd ~
git clone https://github.com/kurokobo/awx-on-k3s.git
cd awx-on-k3s
git checkout 2.3.0
```
Generate a Self-Signed certificate. Note that IP address can't be specified. If you want to use a certificate from public ACME CA such as Let's Encrypt or ZeroSSL instead of Self-Signed certificate, follow the guide on [📁 **Use SSL Certificate from Public ACME CA**](acme) first and come back to this step when done. Generate a Self-Signed certificate. Note that IP address can't be specified. If you want to use a certificate from public ACME CA such as Let's Encrypt or ZeroSSL instead of Self-Signed certificate, follow the guide on [📁 **Use SSL Certificate from Public ACME CA**](acme) first and come back to this step when done.
@ -238,10 +228,10 @@ NAME CLASS HOSTS ADDRESS
ingress.networking.k8s.io/awx-ingress traefik awx.example.com 192.168.0.219 80, 443 5m27s ingress.networking.k8s.io/awx-ingress traefik awx.example.com 192.168.0.219 80, 443 5m27s
NAME TYPE DATA AGE NAME TYPE DATA AGE
secret/redhat-operators-pull-secret Opaque 1 7m11s
secret/awx-admin-password Opaque 1 6m15s secret/awx-admin-password Opaque 1 6m15s
secret/awx-postgres-configuration Opaque 6 6m15s secret/awx-postgres-configuration Opaque 6 6m15s
secret/awx-secret-tls kubernetes.io/tls 2 6m15s secret/awx-secret-tls kubernetes.io/tls 2 6m15s
secret/redhat-operators-pull-secret Opaque 1 6m11s
secret/awx-app-credentials Opaque 3 5m30s secret/awx-app-credentials Opaque 3 5m30s
secret/awx-secret-key Opaque 1 6m6s secret/awx-secret-key Opaque 1 6m6s
secret/awx-broadcast-websocket Opaque 1 6m2s secret/awx-broadcast-websocket Opaque 1 6m2s

19
operator/kustomization.yaml Normal file
View file

@ -0,0 +1,19 @@
---
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
namespace: awx
generatorOptions:
disableNameSuffixHash: true
secretGenerator:
- name: redhat-operators-pull-secret
literals:
- operator=awx
resources:
- github.com/ansible/awx-operator/config/default?ref=2.3.0
images:
- name: quay.io/ansible/awx-operator
newTag: 2.3.0

13
tips/upgrade-operator.md
View file

@ -37,7 +37,7 @@ If you are using AWX Operator `0.14.0` or later and want to upgrade to newer ver
### ⚠️ Note for upgrading from `2.0.0` to `2.0.1` or later ### ⚠️ Note for upgrading from `2.0.0` to `2.0.1` or later
Note that only when upgrading **from `2.0.0` 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. 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`. 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`.
@ -77,18 +77,17 @@ kubectl apply -f pv-postgres-13.yaml
### 📝 Procedure ### 📝 Procedure
To upgrade your AWX Operator, perform following steps. To upgrade your AWX Operator, perform following steps. If your target version is earlier than 2.3.0, switch this page to the desired tag instead of the `main` branch.
```bash ```bash
# Prepare required files # Prepare required files
cd ~ cd ~
git clone https://github.com/ansible/awx-operator.git git clone https://github.com/kurokobo/awx-on-k3s.git
cd awx-operator cd awx-on-k3s
git checkout 0.15.0 # Checkout the version to upgrade to git checkout 2.3.0 # Checkout the version to upgrade to
# Deploy AWX Operator # Deploy AWX Operator
export NAMESPACE=awx # Specify the namespace where the old AWX Operator exists kubectl apply -k operator
make deploy
``` ```
This will upgrade the AWX Operator first, after that, AWX will be also upgraded as well. This will upgrade the AWX Operator first, after that, AWX will be also upgraded as well.