diff --git a/README.md b/README.md index dcc5b4bb..560b326b 100644 --- a/README.md +++ b/README.md @@ -181,28 +181,7 @@ type: Opaque #### Migrating data from an old AWX instance -To migrate data from an older AWX installation, the Custom Resource needs to know about the connection details. Those connection details should be stored as a secret and specified as `tower_old_postgres_configuration_secret` at the CR spec level. - - -The secret should be formatted as follows: - -```yaml ---- -apiVersion: v1 -kind: Secret -metadata: - name: -old-postgres-configuration - namespace: -stringData: - host: - port: - database: - username: - password: -type: Opaque -``` - -> For `host`, a URL resolvable by the cluster could look something like `postgresql..svc.cluster.local`, where `` is filled in with the namespace of the AWX deployment you are migrating data from. +For instructions on how to migrate from an older version of AWX, see [migration.md](./docs/migration.md). #### Managed PostgreSQL Service diff --git a/docs/migration.md b/docs/migration.md new file mode 100644 index 00000000..5431c51c --- /dev/null +++ b/docs/migration.md @@ -0,0 +1,58 @@ +# 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: -secret-key + namespace: +stringData: + secret_key: +type: Opaque +``` + +**Note**: `` must match the `name` of the AWX object you are creating. In our example below, it is `awx`. + +### Old Databse Credentials + +The secret should be formatted as follows: + +```yaml +--- +apiVersion: v1 +kind: Secret +metadata: + name: -old-postgres-configuration + namespace: +stringData: + host: + port: + database: + username: + password: +type: Opaque +``` + +> For `host`, a URL resolvable by the cluster could look something like `postgresql..svc.cluster.local`, where `` is filled in with the namespace of the AWX deployment you are migrating data from. + +## 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: + tower_old_postgres_configuration_secret: -old-postgres-configuration + ... +```