Skip to content

Commit aa646be

Browse files
authored
Document DEPLOY_ACTION in pgo-deployer
This commit adds a section to the docs to explain how DEPLOY_ACTION works, particularly around it's other actions (e.g. uninstall)
1 parent eb6b893 commit aa646be

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

docs/content/installation/postgres-operator.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,17 @@ for deploying the PostgreSQL Operator. The [example file](https://github.com/Cru
108108
contains defaults that should work in most Kubernetes environments, but it may
109109
require some customization.
110110

111-
For the [full reference]("#") for how these configuration parameters work,
112-
please read the [PostgreSQL Operator Installer Configuration Reference]("#")
111+
For a detailed description of each configuration parameter, please read the
112+
[PostgreSQL Operator Installer Configuration Reference](<{{< relref "/installation/configuration.md">}}>)
113+
114+
#### Configuring to Update and Uninstall
115+
116+
The deploy job can be used to perform different deployment actions for the
117+
PostgreSQL Operator. When you run the job it will install the operator by
118+
default but you can change the deployment action to uninstall or update. The
119+
`DEPLOY_ACTION` environment variable in the `postgres-operator.yml` file can be
120+
set to `install`, `update`, and `uninstall`.
121+
113122

114123
### Image Pull Secrets
115124

@@ -157,16 +166,6 @@ command:
157166
kubectl apply -f /path/to/postgres-operator.yml
158167
```
159168

160-
<!--
161-
### Deploying
162-
163-
The deploy job can be used to perform different deployment actions for the
164-
PostgreSQL Operator. If you run the job it will install the operator but you can
165-
change the deployment action by updating the `DEPLOY_ACTION` environment
166-
variable in the `postgres-operator.yml` file. This variable can be set to
167-
`install`, `update`, and `uninstall`. Each time a job is run you will need to
168-
cleanup the job using the command from the **Cleanup** section. -->
169-
170169
### Install the [`pgo` Client]({{< relref "/installation/pgo-client" >}})
171170

172171
To use the [`pgo` Client]({{< relref "/installation/pgo-client" >}}),

0 commit comments

Comments
 (0)