diff --git a/docs/README.md b/docs/README.md index acae2a726..dd37160d2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,9 +2,15 @@ To build the AWX Operator docs locally: -1. Clone the AWX operator repository. -2. From the root directory: - a. pip install --user -r docs/requirements.txt - b. mkdocs build +1. Clone the AWX operator repository. +1. Preferrably, create a virtual environment for installing the dependencies. + a. `python3 -m venv venv` + b. `source venv/bin/activate` +1. From the root directory: + a. `pip install -r docs/requirements.txt` + b. `mkdocs build` +1. View the docs in your browser: + a. `mkdocs serve` + b. Open your browser and navigate to `http://127.0.0.1:8000/` -This will create a new directory called `site/` in the root of your clone containing the index.html and static files. To view the docs in your browser, navigate there in your file explorer and double-click on the `index.html` file. This should open the docs site in your browser. \ No newline at end of file +This will create a new directory called `site/` in the root of your clone containing the index.html and static files. diff --git a/docs/upgrade/upgrading.md b/docs/upgrade/upgrading.md index 0bf61c81e..cde0e7918 100644 --- a/docs/upgrade/upgrading.md +++ b/docs/upgrade/upgrading.md @@ -1,6 +1,7 @@ ### Upgrading -To upgrade AWX, it is recommended to upgrade the awx-operator to the version that maps to the desired version of AWX. To find the version of AWX that will be installed by the awx-operator by default, check the version specified in the `DEFAULT_AWX_VERSION` variable for that particular release. You can do so by running the following command +To upgrade AWX, it is recommended to upgrade the awx-operator to the version that maps to the desired version of AWX. To find the version of AWX that will be installed by the awx-operator by default, check the version specified in the `DEFAULT_AWX_VERSION` variable for that particular release. You can do so by running the following command + ```shell AWX_OPERATOR_VERSION=2.8.0 docker run --entrypoint="" quay.io/ansible/awx-operator:$AWX_OPERATOR_VERSION bash -c "env | grep DEFAULT_AWX_VERSION" @@ -12,26 +13,23 @@ Apply the awx-operator.yml for that release to upgrade the operator, and in turn The first part of any upgrade should be a backup. Note, there are secrets in the pod which work in conjunction with the database. Having just a database backup without the required secrets will not be sufficient for recovering from an issue when upgrading to a new version. See the [backup role documentation](https://github.com/ansible/awx-operator/tree/devel/roles/backup) for information on how to backup your database and secrets. -In the event you need to recover the backup see the [restore role documentation](https://github.com/ansible/awx-operator/tree/devel/roles/restore). *Before Restoring from a backup*, be sure to: -* delete the old existing AWX CR -* delete the persistent volume claim (PVC) for the database from the old deployment, which has a name like `postgres-15--postgres-15-0` +In the event you need to recover the backup see the [restore role documentation](https://github.com/ansible/awx-operator/tree/devel/roles/restore). _Before Restoring from a backup_, be sure to: -**Note**: Do not delete the namespace/project, as that will delete the backup and the backup's PVC as well. +- delete the old existing AWX CR +- delete the persistent volume claim (PVC) for the database from the old deployment, which has a name like `postgres-15--postgres-15-0` +**Note**: Do not delete the namespace/project, as that will delete the backup and the backup's PVC as well. #### PostgreSQL Upgrade Considerations If there is a PostgreSQL major version upgrade, after the data directory on the PVC is migrated to the new version, the old PVC is kept by default. -This provides the ability to roll back if needed, but can take up extra storage space in your cluster unnecessarily. You can configure it to be deleted automatically -after a successful upgrade by setting the following variable on the AWX spec. - +This provides the ability to roll back if needed, but can take up extra storage space in your cluster unnecessarily. You can configure it to be deleted automatically after a successful upgrade by setting the following variable on the AWX spec. ```yaml - spec: - postgres_keep_pvc_after_upgrade: False +spec: + postgres_keep_pvc_after_upgrade: False ``` - #### v0.14.0 ##### Cluster-scope to Namespace-scope considerations