Skip to content

Commit d8f96b9

Browse files
author
jmccormick2001
committed
update docs
1 parent 1361657 commit d8f96b9

File tree

2 files changed

+47
-3
lines changed

2 files changed

+47
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ in the [Design](https://crunchydata.github.io/postgres-operator/stable/design/).
3232
The Operator is developed and tested on CentOS and RHEL linux platforms but is known to run on other Linux variants.
3333

3434
## Documentation
35-
The following documentation is provided:
3635

36+
- [Getting Started](https://crunchydata.github.io/postgres-operator/stable/gettingstarted/)
3737
- [pgo CLI Syntax and Examples](https://crunchydata.github.io/postgres-operator/stable/operator-cli/)
3838
- [Installation](https://crunchydata.github.io/postgres-operator/stable/installation/)
3939
- [Configuration](https://crunchydata.github.io/postgres-operator/stable/configuration/configuration/)
4040
- [pgo.yaml Description](https://crunchydata.github.io/postgres-operator/stable/configuration/pgo-yaml-configuration/)
4141
- [Security](https://crunchydata.github.io/postgres-operator/stable/security/)
42-
- [Design Overview](https://crunchydata.github.io/postgres-operator/stable/design/)
42+
- [Design](https://crunchydata.github.io/postgres-operator/stable/design/)
4343
- [Developing](https://crunchydata.github.io/postgres-operator/stable/developer-setup/)
4444
- [Upgrading the Operator](https://crunchydata.github.io/postgres-operator/stable/upgrade/)

hugo/content/gettingstarted/_index.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,48 @@ title: "Getting Started"
33
date:
44
draft: false
55
weight: 2
6-
---
6+
---
7+
8+
Operator users typically will just need to install the *pgo* client
9+
in order to work with an already deployed Postgres Operator.
10+
11+
For installing the Operator on the Kubernetes server, see
12+
the [Installation Guide](https://crunchydata.github.io/postgres-operator/stable/installation/).
13+
14+
### pgo Client Installation
15+
16+
The *pgo* binary is pre-compiled and available to download from the projects
17+
github repository [Releases](https://github.com/crunchydata/postgres-operator) page.
18+
19+
Add the *pgo* binary to your PATH and make it executable.
20+
21+
Next, create a *.pgouser* file in your $HOME directory or
22+
set the PGOUSER environment variable to point to a *.pgouser*
23+
file location:
24+
25+
export PGOUSER=/somepath/.pgouser
26+
27+
Alternatively, if you create a *.pgouser* file in your $HOME, the *pgo*
28+
client will find the file there.
29+
30+
Set the name of the Kubernetes namespace that you want to
31+
access, on a Linux host you would enter:
32+
33+
export PGO_NAMESPACE=pgouser1
34+
35+
Set the URL of the Operator REST API, in this example the Operator is running
36+
on a host with IP address 192.168.0.120, see your administrator for
37+
the correct IP address, on a Linux host you would enter:
38+
39+
export PGO_APISERVER_URL=https://192.168.0.120:8443
40+
41+
Next, add the TLS keys required for the *pgo* client to connect to the
42+
Operator REST API, see your administrator for access to these keys, on a Linux host you would enter:
43+
44+
export PGO_CA_CERT=/somepath/someserver.crt
45+
export PGO_CLIENT_CERT=/somepath/someserver.crt
46+
export PGO_CLIENT_KEY=/somepath/someserver.key
47+
48+
Lastly, test out the connection:
49+
50+
pgo version

0 commit comments

Comments
 (0)