Skip to content
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

Doc-919 add databasePort to database options #1644

Merged
merged 4 commits into from
Nov 4, 2021
Merged

Doc-919 add databasePort to database options #1644

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4af64b9
add databasePort
kaitlynmichael Nov 2, 2021
2a8595f
add error messages
kaitlynmichael Nov 2, 2021
79dc3e8
Update content/kubernetes/reference/db-options.md
kaitlynmichael Nov 3, 2021
9de60ca
review feedback
kaitlynmichael Nov 3, 2021
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
9 changes: 9 additions & 0 deletions content/kubernetes/reference/db-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ aliases: [
The database options are specified in the `spec` section of the database custom resource.
These options include options that you can change and options that are created by the controller for applications or developers. For example, the database connection information is stored in a secret.

### `databasePort`

Manually sets the TCP port on which the database is available. If the port number is not specified, it will be automatically generated.

<warning> If you use `databasePort` in your REDB spec, the port number cannot be changed after database creation.</warning>
kaitlynmichael marked this conversation as resolved.
Show resolved Hide resolved

If the port is not available, you'll get an error for "port is unavailable."
If the port is not valid, you'll get an error for "change databasePort is not allowed."

### `databaseSecretName`

A string containing the name of a secret that contains the desired database password.
Expand Down