Skip to content

Commit e85901b

Browse files
author
Jonathan S. Katz
committed
Updated README and documentation root URLs
This should make it easier for find out about a host of cool topics that the PostgreSQL Operator can help with.
1 parent 7d3218a commit e85901b

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@
66

77
# Run your own production-grade PostgreSQL-as-a-Service on Kubernetes!
88

9-
The Crunchy PostgreSQL Operator automates and simplifies deploying and managing open source PostgreSQL clusters on Kubernetes and other Kubernetes-enabled Platforms by providing the essential features you need to keep your PostgreSQL clusters up and running, including:
9+
The [Crunchy PostgreSQL Operator](https://access.crunchydata.com/documentation/postgres-operator/) automates and simplifies deploying and managing open source PostgreSQL clusters on Kubernetes and other Kubernetes-enabled Platforms by providing the essential features you need to keep your PostgreSQL clusters up and running, including:
1010

1111
#### PostgreSQL Cluster Provisioning
1212

13-
Create, Scale, & Delete PostgreSQL clusters with ease, while fully customizing your Pods and PostgreSQL configuration!
13+
[Create, Scale, & Delete PostgreSQL clusters with ease](https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/provisioning/), while fully customizing your Pods and PostgreSQL configuration!
1414

1515
#### High-Availability
1616

17-
Safe, automated failover backed by a distributed consensus based HA solution. Uses [Pod Anti-Affinity](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#inter-pod-affinity-and-anti-affinity) to help resiliency; you can configure how aggressive this can be! Failed primaries automatically heal, allowing for faster recovery time.
17+
Safe, automated failover backed by a [distributed consensus based high-availability solution](https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/high-availability/). Uses [Pod Anti-Affinity](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#inter-pod-affinity-and-anti-affinity) to help resiliency; you can configure how aggressive this can be! Failed primaries automatically heal, allowing for faster recovery time.
1818

1919
#### Disaster Recovery
2020

21-
Backups and restores leverage the open source [pgBackRest](https://www.pgbackrest.org) utility and includes support for full, incremental, and differential backups as well as efficient delta restores. Set how long you want your backups retained for. Works great with very large databases!
21+
Backups and restores leverage the open source [pgBackRest](https://www.pgbackrest.org) utility and [includes support for full, incremental, and differential backups as well as efficient delta restores](https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/disaster-recovery/). Set how long you want your backups retained for. Works great with very large databases!
2222

2323
#### Monitoring
2424

@@ -34,27 +34,27 @@ Safely apply PostgreSQL updates with minimal availability impact to your Postgre
3434

3535
#### Advanced Replication Support
3636

37-
Choose between asynchronous replication and, for workloads that are sensitive to losing transactions, synchronous replication
37+
Choose between [asynchronous replication](https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/high-availability/) and [synchronous replication](https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/high-availability/#synchronous-replication-guarding-against-transactions-loss) for workloads that are sensitive to losing transactions.
3838

3939
#### Clone
4040

41-
Create new clusters from your existing clusters with a simple `pgo clone` command.
41+
Create new clusters from your existing clusters with a simple [`pgo clone`](https://access.crunchydata.com/documentation/postgres-operator/latest/pgo-client/reference/pgo_clone/) command.
4242

4343
#### Connection Pooling
4444

45-
Use [pgBouncer](https://access.crunchydata.com/documentation/pgbouncer/) for connection pooling
45+
Use [pgBouncer](https://access.crunchydata.com/documentation/pgbouncer/) for connection pooling
4646

4747
#### Node Affinity
4848

4949
Have your PostgreSQL clusters deployed to [Kubernetes Nodes](https://kubernetes.io/docs/concepts/architecture/nodes/) of your preference
5050

5151
#### Scheduled Backups
5252

53-
Choose the type of backup (full, incremental, differential) and how frequently you want it to occur on each PostgreSQL cluster.
53+
Choose the type of backup (full, incremental, differential) and [how frequently you want it to occur](https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/disaster-recovery/#scheduling-backups) on each PostgreSQL cluster.
5454

5555
#### Backup to S3
5656

57-
Store your backups in Amazon S3 or any object storage system that supports the S3 protocol. The PostgreSQL Operator can backup, restore, and create new clusters from these backups.
57+
[Store your backups in Amazon S3](https://access.crunchydata.com/documentation/postgres-operator/latest/architecture/disaster-recovery/#using-s3) or any object storage system that supports the S3 protocol. The PostgreSQL Operator can backup, restore, and create new clusters from these backups.
5858

5959
#### Multi-Namespace Support
6060

@@ -139,16 +139,16 @@ For a quick start deployment to Google Kubernetes Engine (GKE), please see instr
139139

140140
If you have the PostgreSQL Operator installed in your environment, and are interested in installation of the client interface, please start here:
141141

142-
- [PGO Client Install](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/install-pgo-client/)
142+
- [pgo Client Install](https://access.crunchydata.com/documentation/postgres-operator/latest/installation/install-pgo-client/)
143143

144144
There is also a `pgo-client` container if you wish to deploy the client directly to your Kubernetes environment.
145145

146146
### Using the PostgreSQL Operator
147147

148148
If you have the PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:
149149

150-
- [PGO CLI Overview](https://access.crunchydata.com/documentation/postgres-operator/)
151-
150+
- [PostgreSQL Operator Documentation](https://access.crunchydata.com/documentation/postgres-operator/)
151+
- [pgo Client User Guide](https://access.crunchydata.com/documentation/postgres-operator/latest/pgo-client/)
152152

153153
## Contributing to the Project
154154

hugo/content/_index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ The Crunchy PostgreSQL Operator automates and simplifies deploying and managing
1616

1717
#### PostgreSQL Cluster Provisioning
1818

19-
Create, Scale, & Delete PostgreSQL clusters with ease, while fully customizing your Pods and PostgreSQL configuration!
19+
[Create, Scale, & Delete PostgreSQL clusters with ease](/architecture/provisioning/), while fully customizing your Pods and PostgreSQL configuration!
2020

2121
#### High-Availability
2222

23-
Safe, automated failover backed by a distributed consensus based HA solution. Uses [Pod Anti-Affinity](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#inter-pod-affinity-and-anti-affinity) to help resiliency; you can configure how aggressive this can be! Failed primaries automatically heal, allowing for faster recovery time.
23+
Safe, automated failover backed by a [distributed consensus based high-availability solution](/architecture/high-availability/). Uses [Pod Anti-Affinity](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#inter-pod-affinity-and-anti-affinity) to help resiliency; you can configure how aggressive this can be! Failed primaries automatically heal, allowing for faster recovery time.
2424

2525
#### Disaster Recovery
2626

27-
Backups and restores leverage the open source [pgBackRest](https://www.pgbackrest.org) utility and includes support for full, incremental, and differential backups as well as efficient delta restores. Set how long you want your backups retained for. Works great with very large databases!
27+
Backups and restores leverage the open source [pgBackRest](https://www.pgbackrest.org) utility and [includes support for full, incremental, and differential backups as well as efficient delta restores](/architecture/disaster-recovery/). Set how long you want your backups retained for. Works great with very large databases!
2828

2929
#### Monitoring
3030

@@ -40,11 +40,11 @@ Safely apply PostgreSQL updates with minimal availability impact to your Postgre
4040

4141
#### Advanced Replication Support
4242

43-
Choose between asynchronous replication and, for workloads that are sensitive to losing transactions, synchronous replication
43+
Choose between [asynchronous replication](/architecture/high-availability/) and [synchronous replication](/architecture/high-availability/#synchronous-replication-guarding-against-transactions-loss) for workloads that are sensitive to losing transactions.
4444

4545
#### Clone
4646

47-
Create new clusters from your existing clusters with a simple `pgo clone` command.
47+
Create new clusters from your existing clusters with a simple [`pgo clone`](/pgo-client/reference/pgo_clone/) command.
4848

4949
#### Connection Pooling
5050

@@ -56,11 +56,11 @@ Have your PostgreSQL clusters deployed to [Kubernetes Nodes](https://kubernetes.
5656

5757
#### Scheduled Backups
5858

59-
Choose the type of backup (full, incremental, differential) and how frequently you want it to occur on each PostgreSQL cluster.
59+
Choose the type of backup (full, incremental, differential) and [how frequently you want it to occur](/architecture/disaster-recovery/#scheduling-backups) on each PostgreSQL cluster.
6060

6161
#### Backup to S3
6262

63-
Store your backups in Amazon S3 or any object storage system that supports the S3 protocol. The PostgreSQL Operator can backup, restore, and create new clusters from these backups.
63+
[Store your backups in Amazon S3](/architecture/disaster-recovery/#using-s3) or any object storage system that supports the S3 protocol. The PostgreSQL Operator can backup, restore, and create new clusters from these backups.
6464

6565
#### Multi-Namespace Support
6666

0 commit comments

Comments
 (0)