OperatorHub

Installing Crunchy Postgres for Kubernetes Using OperatorHub on OpenShift

Crunchy Postgres for Kubernetes can be installed on OpenShift through the OperatorHub point-and-click experience. Under Operators > OperatorHub, search for Crunchy and you’ll find Marketplace, Certified and Community installers. Choose the installer that fits your needs and consider installing in a specific namespace.

Marketplace and Certified installers come with a registration requirement. Users who register their installations will experience uninterrupted Crunchy Postgres for Kubernetes service during operator upgrades. Registration is free and easy. Visit our token creation page and sign up to receive a token.

Registration

To register your installation of Crunchy Postgres for Kubernetes, go to the token creation page. If you already have a Crunchy Account, log in. If you do not, create an account. You will then be able to create a new token and manage your existing tokens.

Once you have your token, create a file called cpk_token and paste the token into the file. Use cpk_token to create a Secret, and then restart the Crunchy Postgres for Kubernetes Deployment.

oc create secret generic cpk-registration --from-file=cpk_token -n $NAMESPACE
oc rollout restart deployment pgo -n $NAMESPACE

And that's it! Your installation is now fully enabled.

How Registration Affects Your Installation

Marketplace and Certified installers require a registration token to upgrade from the installed version. Once you apply a token to your installation, the token will be internally validated by the operator. Token validation does not require an internet connection.

Without a token, existing Postgres clusters will continue running uninterrupted. You will be able to create and destroy them, but you won’t be able to update existing Postgres clusters until you complete the registration process.

Registration Events

If your Crunchy Postgres for Kubernetes installation is properly registered, you will not see any registration-related events. However, if you have not yet registered, certain events may be generated for each PostgresCluster.

For instance, an event such as the following will be generated for any PostgresCluster managed by an unregistered installation:

Crunchy Postgres for Kubernetes now requires registration for operator upgrades. Register now to be ready for your next upgrade. See https://access.crunchydata.com/register-cpk for details.

This warning event simply indicates that registration will be required when upgrading the operator.

If Crunchy Postgres for Kubernetes is then upgraded without registering, a warning event will be generated for each PostgresCluster indicating that registration is now required. For instance, you will see the following for a PostgresCluster named hippo:

Registration required for Crunchy Postgres for Kubernetes to modify hippo.  See https://access.crunchydata.com/register-cpk for details.

If you are seeing either of these events, please be sure to register your installation as soon as possible according to the instructions provided on this page.

Additional events will then be generated indicating successful (or unsuccessful) registration. For instance, the following informational event will be generated once you have successfully registered your installation:

Thank you for registering your installation of Crunchy Postgres for Kubernetes.

FAQ

Q: What OperatorHub installers require a registration token?

A: Certified and Marketplace installers currently require a registration token.

Q: Do other installation methods require a registration token?

A: No.

Q: What happens if I don't install a token?

A: A valid token is required to be able to perform any upgrades after Crunchy Postgres for Kubernetes is installed. Your running Postgres instances will remain unaffected. New installs are also unaffected.

Q: What if my Crunchy Postgres for Kubernetes clusters can't establish an internet connection?

A: The token's validation is processed internally within Crunchy Postgres for Kubernetes. An active internet connection isn't needed for this verification process.

Q: How do I get a token?

A: To obtain a token, head to the Crunchy Data Token Portal at https://tokens.crunchydata.com. You'll be prompted to either log in via your Crunchy Data Customer Access Portal credentials or initiate an account request. You can also manage and view your existing tokens at this site.

Q: Do I need a token to install from the Red Hat Marketplace?

A: The token is only required to upgrade a running instance of the Crunchy Postgres for Kubernetes operator, PGO. Installs do not currently require a token. However, obtaining one as part of the install process is advised, so you do not need to worry about it when it's time to upgrade.

Q: What kinds of upgrades require a token?

A: Postgres introduces new features in a new major version once each year. With Crunchy Postgres for Kubernetes, you choose when to apply these upgrades, and they do not require a token. Bug fixes and minor version upgrades for Postgres happen automatically when upgrading the operator, which does require a token. You won't be able to perform minor version upgrades without a token.

Q: Will I need a new token for each upgrade?

A: No. A token simply unlocks the ability to upgrade, and is not tied to a specific version of Crunchy Postgres for Kubernetes.

Q: When does this take effect?

A: The token system and website have been launched alongside the release of Crunchy Postgres for Kubernetes version 5.5. It's important to note that to upgrade beyond version 5.5, you will require a token. For instance, if you have Crunchy Postgres for Kubernetes version 5.5 installed, you will need a token when upgrading to version 5.5.1 or version 5.6.