Skip to content

DOCS-1345 - PGD SiX Essentials functional draft #6679

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.

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

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "{{name.ln}} examples"
navTitle: "{{name.short}}"
navTitle: "{{name.sn}}"
description: "{{name.ln}} v{{version.full}} provides functionality for replacing simple expressions representing product names and versions"
displayBanner: "{{name.ln}} v{{version.full}} is not a real product, but it plays one in the playground"
product: "Expression Replacement"
Expand All @@ -27,15 +27,15 @@ This functionality allows for writing documentation when the future (or current)
| Expression | Replacement | Source |
|---------------------------------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------|
| `\{{name.ln}}` | {{name.ln}} | product definition - `.name` |
| `\{{name.short}}` | {{name.short}} | product definition - `.shortName` |
| `\{{name.sn}}` | {{name.sn}} | product definition - `.shortName` |
| `\{{name.abbr}}` | {{name.abbr}} | product definition - `.abbreviation` |
| `\{{name.ccn}}` | {{name.ccn}} | product definition - `.commonCommandName` |
| `\{{name(pgd).short}}` | {{name(pgd).short}} | PGD product definition - `.shortName` |
| `\{{name(pgd).sn}}` | {{name(pgd).sn}} | PGD product definition - `.shortName` |
| `\{{version.full}}` | {{version.full}} | frontmatter - `version:` |
| `\{{version(pgd).short}}` | {{version(pgd).short}} | filesystem directory version for latest product version |
| `\{{version(pgd).major}}.\{{version(pgd).minor}}` | {{version(pgd).major}}.{{version(pgd).minor}} | frontmatter - `version:` for latest product version. Parsed as semver, truncated at minor version |

## Scope of {{name(Expression Replacement).short}}
## Scope of {{name(Expression Replacement).sn}}

Expressions should be parsed in all Markdown elements containing rendered content, including code blocks and inline code. Frontmatter-sourced version information is not currently available in code.

Expand Down
1 change: 1 addition & 0 deletions gatsby-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ const sourceToPluginConfig = {
efm: { name: "efm", path: "product_docs/docs/efm" },
epas: { name: "epas", path: "product_docs/docs/epas" },
pgd: { name: "pgd", path: "product_docs/docs/pgd" },
pgds: { name: "pgds", path: "product_docs/docs/pgds" },
pge: { name: "pge", path: "product_docs/docs/pge" },
eprs: { name: "eprs", path: "product_docs/docs/eprs" },
hadoop_data_adapter: {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Basic Installation for {{name.ln}}"
description: "How to do a basic install {{name.ln}} on Linux"
navTitle: "Basic Installation"
---

Preparing to use {{name.ln}} is easy. You can get started in a few minutes. This guide will walk you through the steps to set up your environment and start using {{name.ln}}.

If you are looking for a quick start, you can use the [{{name.ln}} Quickstart](../quickstart/) guide which will shows how to bring up a {{name.sn}} cluster locally, using Docker, for development and testing purposes. This is a great way to get started with {{name.sn}} and see how it works.

Here we will show you how to install {{name.ln}} on a Linux system. This is a more traditional installation method and is the basis for for production use installations.

This guide will help you get up and running quickly with {{name.ln}} on multiple nodes.

## Prerequisites

## Installing the {{name(pgds).sn}} repositories

## Installing the {{name(pgds).sn}} packages

## Initializing each {{name(pgds).sn}} node

## Starting the {{name(pgds).sn}} nodes

...
14 changes: 14 additions & 0 deletions product_docs/docs/pgds/6/getting_started/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "Getting started with {{name.ln}}"
description: "How to get started with {{name.ln}}"
navTitle: "Getting started"
nav:
- quickstart
- basic-installing
- other-installations
---

* [Quick Start](quickstart) - In a hurry to learn more? Follow this track to get {{name.sn}} running locally using Docker Compose.
* [Basic Installing](basic-installing) - Want something more permanent, this track will help you deploy {{name.sn}} on three physical machines (or virtual machines) for a realistic experience.
* [Other Installations](other-installations) - Want to use Kubernetes or HCP? This track will help you get started with those options.

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Other ways to install {{name.ln}}
navTitle: Other Installations
description: Installing {{name.ln}} with Kubernetes, deploying on HCP and other routes to bring up a {{name.sn}} cluster.
---

## Installing with Kubernetes


## Deploying on HCP


## Using TPA to automate the installation

10 changes: 10 additions & 0 deletions product_docs/docs/pgds/6/getting_started/quickstart/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Quickstart {{name.ln}}
description: How to get started quickly with {{name.ln}}
navTitle: Quickstart
---

This section will help you get up and running quickly with {{name.ln}} ready. In this section, you will learn how to set up a {{name.sn}} cluster using Docker. This is a great way to get started with {{name.ln}} and see how it works. You can use this setup for development and testing purposes.

We'll be bringing up a 3 node cluster for local high availability.

17 changes: 17 additions & 0 deletions product_docs/docs/pgds/6/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "{{name.ln}}"
navigation:
- overview
- getting_started
---

{{name.ln}} is the essential availability and disaster recovery solution for EDB Postgres Advanced Server and EDB Postgres Extended.
It provides a comprehensive set of features to ensure that your database is always available, even in the event of a disaster.

{{name.ln}} is designed to deliver {{name(pgd).sn}} functionality in an easy-to-use package, with a focus on simplicity and reliability.
It is the perfect solution for organizations that need to ensure the availability of their databases, without the often unnecessary complexity of other configurations.

As part of the {{name.fam}} family, {{name.ln}} it is also possible to move beyond {{name.sn}} best practices and opinionated configurations with {{name(pgdx).sn}} enabling you to use the extensive toolkit of powerful additional replication, durability, and consistency options to the full.

{{name.ln}} is designed to be easy to use and configure, with a focus on simplicity and reliability. It is the perfect solution for organizations that need to ensure the availability of their databases, without the often unnecessary complexity of other configurations.

16 changes: 16 additions & 0 deletions product_docs/docs/pgds/6/overview/configurations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Available configurations of {{name.ln}}"
description: "How to select a configuration of {{name.ln}}"
navTitle: "Configurations"
---

{{name.ln}} is designed to support the two most common configurations of highly available or disaster recovery enabled clusters. These configurations are:

- **Local HA**: This configuration uses three nodes in a single data center. The nodes will be replicating each other and any connection into a node will be routed to an appropriately active node in the cluster.

This configuration is designed to support high availability. If one of the nodes fails, the other nodes will continue to operate and the failed node can be repaired and reintroduced into the cluster.

- **HA with Remote DR**: This configuration uses three nodes in two data centers. The nodes will be replicating each other and any connection into a node will be routed to an appropriately active node in the cluster. If a node fails, the other nodes will continue to operate and the failed node can be repaired and reintroduced into the cluster. In this configuration, one of the nodes is in a different data center than the other two nodes.

This configuration is designed to support disaster recovery. If one of the data centers fails, the other data center will continue to operate and the failed data center can be repaired and reintroduced into the cluster.

14 changes: 14 additions & 0 deletions product_docs/docs/pgds/6/overview/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "{{name.ln}}"
description: "Overview of {{name.ln}}"
navTitle: "Overview"
---

## Why you need High Availability

High Availability is about ensuring that your database is always available, while its in use, when its being maintained, and during unexpected failures and outages.

## High Availability and {{name(pgds).sn}}

{{name.ln}} is the essential availability and disaster recovery solution for EDB Postgres Advanced Server and EDB Postgres Extended.

9 changes: 5 additions & 4 deletions src/constants/expression-replacement.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ import semver from "semver";
export const expressionRE =
/(?<!\\)\{\{(?<command>\w+)(?:\((?<product>[^)]+)\)){0,1}\.(?<type>[^}]+)\}\}/;
const nameCodes = {
ln: "name",
short: "shortName",
abbr: "abbreviation",
ccn: "commonCommandName",
"ln": "name",
"sn": "shortName",
"abbr": "abbreviation",
"ccn": "commonCommandName",
"fam": "productFamily",
};

export default function expressionReplacement({
Expand Down
13 changes: 13 additions & 0 deletions src/constants/products.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,19 @@ const products = {
abbreviation: "PGD",
iconName: IconNames.HIGH_AVAILABILITY,
},
pgdx: {
name: "EDB Postgres Distributed Expanded",
shortName: "PGD Expanded",
abbreviation: "PGDX",
iconName: IconNames.HIGH_AVAILABILITY,
},
pgds: {
name: "EDB Postgres Distributed Essentials",
shortName: "PGD Essentials",
abbreviation: "PGDS",
productFamily: "Postgres Distributed",
iconName: IconNames.HIGH_AVAILABILITY,
},
pge: { name: "EDB Postgres Extended Server", iconName: IconNames.POSTGRESQL },
"EDB Postgres Tuner": { name: "EDB Postgres Tuner" },

Expand Down
5 changes: 4 additions & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,10 @@ const Page = () => {
EDB Postgres Extended Server
</BannerCardLink>
<BannerCardLink to="/pgd/latest">
EDB Postgres Distributed (PGD)
EDB Postgres Distributed Expanded
</BannerCardLink>
<BannerCardLink to="/pgds/latest">
EDB Postgres Distributed Essentials
</BannerCardLink>
<BannerCardLink to="/supported-open-source/postgresql/">
PostgreSQL
Expand Down
Loading