Skip to content

34 tng operator6 #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

34 tng operator6 #106

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
62ff912
Fixed broken link to clair instructions in basic deploy guide
BillDett Oct 30, 2020
ae25141
Merge branch 'master' of github.com:BillDett/quay-docs
BillDett Dec 8, 2020
10d141d
Merge branch 'master' of github.com:BillDett/quay-docs
BillDett Dec 9, 2020
97b9df6
Updated text with proper secret key name and example showing how to m…
BillDett Dec 9, 2020
95d7429
Changed secret creation example to match other quay docs
BillDett Dec 9, 2020
cb32277
Merge branch 'master' into 34_tng_operator6
BillDett Dec 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions modules/proc_deploy-quay-openshift-operator-tng.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,15 +267,16 @@ When the Quay Operator starts up, it immediately looks for any `QuayRegistries`

=== Ugrading a QuayEcosystem

Upgrades are supported from previous versions of the Operator which used the `QuayEcosystem` API for a limited set of configurations. To ensure that migrations do not happen unexpectedly, a special label needs to be applied to the `QuayEcosystem` for it to be migrated. A new `QuayRegistry` will be created for the Operator to manage, but the old `QuayEcosystem` will remain until manually deleted to ensure that you can roll back and still access Quay in case anything goes wrong. To migrate an existing `QuayEcosystem` to a new `QuayRegistry`, follow these steps:
Upgrades are supported from previous versions of the Operator which used the `QuayEcosystem` API for a limited set of configurations. To ensure that migrations do not happen unexpectedly, a special label needs to be applied to the `QuayEcosystem` for it to be migrated. A new `QuayRegistry` will be created for the Operator to manage, but the old `QuayEcosystem` will remain until manually deleted to ensure that you can roll back and still access Quay in case anything goes wrong. To migrate an existing `QuayEcosystem` to a new `QuayRegistry`, follow these steps.

==== Preparing Managed Database for Migration

If using an Operator-managed database, first ensure that the password is set for the `postgres` root admin user (not set by default). This allows remote access to the database for migration. The Operator looks for this password in the `Secret` referenced by `spec.quay.database.credentialsSecretName` under the `database-root-password` key.
If using an external database not deployed by the Quay Operator, skip this step. Otherwise, ensure that the password is set for the `postgres` root admin user (not set by default). This allows remote access to the database for migration. The Operator looks for this password in the `Secret` referenced by `spec.quay.database.credentialsSecretKey` under the `database-root-password` key.

To set/change the password, use either the OpenShift console or `kubectl` to [open an SSH terminal connection](https://kubernetes.io/docs/tasks/debug-application-cluster/get-shell-running-container/) to the Postgres pod:
```sh
$ kubectl exec -n <namespace> --stdin --tty deployment/<quayecosystem-name>-quay-postgresql -- /bin/bash
$ oc exec -n <namespace> --stdin --tty deployment/<quayecosystem-name>-quay-postgresql -- /bin/bash
```

Execute the following command and follow instructions to change the password:
Expand All @@ -287,7 +288,17 @@ Type "help" for help.
postgres=# \password
```

==== Performing QuayEcosystem Upgrade
To create a `Secret` containing the `postgres` root admin user's password:
```sh
$ oc create secret generic <secret_name> \
--from-literal=database-username=<username> \
--from-literal=database-password=<password> \
--from-literal=database-root-password=<root-password> \
--from-literal=database-name=<database-name>

```

To carry out the actual migration:

. Add `"quay-operator/migrate": "true"` to the `metadata.labels` of the `QuayEcosystem`.

Expand Down