internet/awx-operator
3
0
Fork 0
mirror of https://github.com/ansible/awx-operator.git synced 2026-03-26 21:33:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Table of Contents for nested doc files (#1508)

Browse Source
This commit is contained in:
Christian Adams
2023-08-02 16:24:15 -04:00
committed by GitHub
parent 7953d424f0
commit bf3965eac7
4 changed files with 59 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@@ -12,18 +12,20 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w
<!-- gh-md-toc --insert README.md --> <!-- gh-md-toc --insert README.md -->
<!--ts--> <!--ts-->
NOTE: we are in the process of moving this readme into official docs in the /docs folder. Please go there to find additional sections during this interim move phase. **Note**: We are in the process of moving this readme into official docs in the /docs folder. Please go there to find additional sections during this interim move phase.
Table of Contents Table of Contents
================= =================
* [AWX Operator](#awx-operator) - [AWX Operator](#awx-operator)
* [Contributing](#contributing) - [Table of Contents](#table-of-contents)
* [Release Process](#release-process) - [Install and Configuration](#install-and-configuration)
* [Author](#author) - [Contributing](#contributing)
* [Code of Conduct](#code-of-conduct) - [Release Process](#release-process)
* [Get Involved](#get-involved) - [Author](#author)
- [Code of Conduct](#code-of-conduct)
- [Get Involved](#get-involved)
<!-- Created by https://github.com/ekalinin/github-markdown-toc --> <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
@@ -31,6 +33,55 @@ Table of Contents
## Install and Configuration
All of our usage and configuration docs are nested in the `docs/` directory. Below is a Table of Contents for those.
- Introduction
- [Introduction](./docs/introduction.md)
- Contributors Guide
- [Code of Conduct](./docs/code-of-conduct.md)
- [Get Involved](./docs/get-involved.md)
- [Contributing](./docs/contributing.md)
- [Release Process](./docs/release-process.md)
- [Authors](./docs/author.md)
- Installation
- [Basic Install](./docs/basic-install.md)
- [Creating a Minikube cluster for testing](./docs/creating-a-minikube-cluster-for-testing.md)
- [Installation](./docs/installation.md)
- [Helm Install](./docs/helm-install-on-existing-cluster.md)
- [Migration](./docs/migration.md)
- [Uninstall](./docs/uninstall.md)
- User Guide
- [Admin User Configuration](./docs/admin-user-account-configuration.md)
- [Database Configuration](./docs/database-configuration.md)
- [Network and TLS Configuration](./docs/network-and-tls-configuration.md)
- Advanced Configuration
- [No Log](./docs/no-log.md)
- [Deploy a Specific Version of AWX](./docs/deploying-a-specific-version-of-awx.md)
- [Resource Requirements](./docs/containers-resource-requirements.md)
- [Extra Settings](./docs/extra-settings.md)
- [Environment Variables](./docs/exporting-environment-variables-to-containers.md)
- [Custom Labels](./docs/labeling-operator-managed-objects.md)
- [Custom Volumes](./docs/custom-volume-and-volume-mount-options.md)
- [Scaling Deployments](./docs/scaling-the-web-and-task-pods-independently.md)
- [Auto Update Upon Operator Upgrade](./docs/auto-upgrade.md)
- [Termination Grace Period](./docs/pods-termination-grace-period.md)
- [Node Selector for Deployments](./docs/assigning-awx-pods-to-specific-nodes.md)
- [Default EE from Private Registries](./docs/default-execution-environments-from-private-registries.md)
- [CSRF Cookie Secure](./docs/csrf-cookie-secure-setting.md)
- [Disable IPv6](./docs/disable-ipv6.md)
- [LDAP](./docs/enabling-ldap-integration-at-awx-bootstrap.md)
- [Priority Clases](./docs/priority-classes.md)
- [Priveleged Tasks](./docs/privileged-tasks.md)
- [Redis Container Capabilities](./docs/redis-container-capabilities.md)
- [Trusting a Custom Certificate Authority](./docs/trusting-a-custom-certificate-authority.md)
- [Service Account](./docs/service-account.md)
- [Persisting the Projects Directory](./docs/persisting-projects-directory.md)
- Troubleshooting
- [General Debugging](./docs/debugging.md)
## Contributing ## Contributing
Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md). Please visit [our contributing guidelines](https://github.com/ansible/awx-operator/blob/devel/CONTRIBUTING.md).

0
docs/migration.md → docs/migration/migration.md
View File

82
docs/user-guide/advanced-configuration/migration.md
View File

@@ -1,82 +0,0 @@
# Migrating data from an old AWX instance
To migrate data from an older AWX installation, you must provide some information via Secrets.
## Creating Secrets for Migration
### Secret Key
You can find your old secret key in the inventory file you used to deploy AWX in releases prior to version 18.
```yaml
apiVersion: v1
kind: Secret
metadata:
name: <resourcename>-secret-key
namespace: <target-namespace>
stringData:
secret_key: <old-secret-key>
type: Opaque
```
**Note**: `<resourcename>` must match the `name` of the AWX object you are creating. In our example below, it is `awx`.
### Old Database Credentials
The secret should be formatted as follows:
```yaml
---
apiVersion: v1
kind: Secret
metadata:
name: <resourcename>-old-postgres-configuration
namespace: <target namespace>
stringData:
host: <external ip or url resolvable by the cluster>
port: "<external port, this usually defaults to 5432>" # quotes are required
database: <desired database name>
username: <username to connect as>
password: <password to connect with>
type: Opaque
```
> For `host`, a URL resolvable by the cluster could look something like `postgresql.<namespace>.svc.cluster.local`, where `<namespace>` is filled in with the namespace of the AWX deployment you are migrating data from.
If your AWX deployment is already using an external database server or its database is otherwise not managed
by the AWX deployment, you can instead create the same secret as above but omit the `-old-` from the `name`.
In the next section pass it in through `postgres_configuration_secret` instead, omitting the `_old_`
from the key and ensuring the value matches the name of the secret. This will make AWX pick up on the existing
database and apply any pending migrations. It is strongly recommended to backup your database beforehand.
The postgresql pod for the old deployment is used when streaming data to the new postgresql pod. If your postgresql pod has a custom label,
you can pass that via the `postgres_label_selector` variable to make sure the postgresql pod can be found.
## Deploy AWX
When you apply your AWX object, you must specify the name to the database secret you created above:
```yaml
apiVersion: awx.ansible.com/v1beta1
kind: AWX
metadata:
name: awx
spec:
old_postgres_configuration_secret: <resourcename>-old-postgres-configuration
secret_key_secret: <resourcename>-secret-key
...
```
## Important Note
If you intend to put all the above in one file, make sure to separate each block with three dashes like so:
```yaml
---
# Secret key
---
# Database creds
---
# AWX Config
```
Failing to do so will lead to an inoperable setup.

2
docs/user-guide/database-configuration.md
View File

@@ -48,7 +48,7 @@ spec:
#### Migrating data from an old AWX instance #### Migrating data from an old AWX instance
For instructions on how to migrate from an older version of AWX, see [migration.md](/docs/user-guide/advanced-configuration/migration.md). For instructions on how to migrate from an older version of AWX, see [migration.md](/docs/migration/migration.md).
#### Managed PostgreSQL Service #### Managed PostgreSQL Service