Skip to content

Commit 2a6cda9

Browse files
authored
Update documentation for pgo client setup and cluster clone
Updates the docs for installer to have correct path when using client-setup script This commit updates the docs to provide more info about how a cloned cluster will be created. The newly cloned cluster will be a single primary instance.
1 parent 036fa13 commit 2a6cda9

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

docs/content/installation/postgres-operator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ environmental variables to your environment:
224224

225225
```shell
226226
cat <<EOF >> ~/.bashrc
227-
export PATH="$HOME/.pgo/$PGO_OPERATOR_NAMESPACE/pgo:$PATH"
227+
export PATH="$HOME/.pgo/$PGO_OPERATOR_NAMESPACE:$PATH"
228228
export PGOUSER="$HOME/.pgo/$PGO_OPERATOR_NAMESPACE/pgouser"
229229
export PGO_CA_CERT="$HOME/.pgo/$PGO_OPERATOR_NAMESPACE/client.crt"
230230
export PGO_CLIENT_CERT="$HOME/.pgo/$PGO_OPERATOR_NAMESPACE/client.crt"

docs/content/pgo-client/common-tasks.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -874,9 +874,11 @@ section of the documentation.
874874
## Clone a PostgreSQL Cluster
875875

876876
You can create a copy of an existing PostgreSQL cluster in a new PostgreSQL
877-
cluster by using the [`pgo clone`](/pgo-client/reference/pgo_clone/) command. To
878-
create a new copy of a PostgreSQL cluster, you can execute the following
879-
command:
877+
cluster by using the [`pgo clone`](/pgo-client/reference/pgo_clone/) command.
878+
The command copies the pgBackRest repository from the existing cluster and
879+
creates a new, single instance primary as its own cluster. To
880+
create the new, single instance, copy of a PostgreSQL cluster, you can execute
881+
the following command:
880882

881883
```shell
882884
pgo clone hacluster newhacluster

installers/kubectl/client-setup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ chmod a-rwx,u+rw "${OUTPUT_DIR}/client.crt" "${OUTPUT_DIR}/client.key"
7676

7777

7878
echo "pgo client files have been generated, please add the following to your bashrc"
79-
echo "export PATH=${OUTPUT_DIR}/${BIN_NAME}:\$PATH"
79+
echo "export PATH=${OUTPUT_DIR}:\$PATH"
8080
echo "export PGOUSER=${OUTPUT_DIR}/pgouser"
8181
echo "export PGO_CA_CERT=${OUTPUT_DIR}/client.crt"
8282
echo "export PGO_CLIENT_CERT=${OUTPUT_DIR}/client.crt"

0 commit comments

Comments
 (0)