Skip to content
Draft
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
1 change: 1 addition & 0 deletions deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@ Test: Use this file to deploy changes to branches that do not require a change t
01/26/2025 - Retrying deployment
02/27/2026 - Publish update.
04/01/2026 - Deployment issue with pgEdge labs build.
04/14/2026 - Cloud updates.
189 changes: 97 additions & 92 deletions docs/cloud/cluster/manage_cluster.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
# Managing a Cluster

You can use the pgEdge Distributed Postgres (Cloud Edition) console to
review cluster information; highlight the name of a cluster in the
`Clusters` menu to access the console for that cluster.
Use the pgEdge Cloud console to review cluster information. Highlight the
name of a cluster in the `Clusters` menu to access the console for that
cluster.

![The cluster console header](../images/cluster_console_header.png)

If you've recently created or modified the cluster, the header displays a
banner showing the cluster state. The console header also displays
If you recently created or modified the cluster, the header displays a
banner showing the cluster state. The console header also displays
information about the selected cluster:

* The cluster name.
* The length of time since the last cluster update.
* The preferred connection type (`Public` or `Private`); this indicates
if the cluster nodes are in a public subnet or not.
* The `Cluster ID` associated with the cluster.
* The name of the cloud provider account on which the cluster resides;
click the name of the account to navigate to the details page for the
account.
* User-defined [resource tags](resource_tag.md) associated with the cluster.
- The cluster name.
- The length of time since the last cluster update.
- The cluster connection type (`Public` or `Private`), which indicates
whether the cluster nodes are in a public subnet.
- The `Cluster ID` associated with the cluster.
- The name of the cloud provider account on which the cluster resides;
click the account name to navigate to the details page for the account.
- User-defined [resource tags](resource_tag.md) associated with the cluster.

Also in the cluster header, a set of informational panes tell you the
state of the cluster at a glance:
The cluster header also displays a set of informational panes that show
the state of the cluster at a glance:

* the total node count
* the number of healthy nodes
* the number of unhealthy nodes
* the number of unresponsive nodes
- the total node count.
- the number of healthy nodes.
- the number of unhealthy nodes.
- the number of unresponsive nodes.


## The Cluster Information Tabs
Expand All @@ -36,64 +35,69 @@ state of the cluster at a glance:
The tabbed browser on the `Cluster` tab provides quick access to
information about the state of your cluster:

* Select the [`Overview`](#the-overview-tab) tab to view information
about the cluster, and the databases currently deployed on the cluster.
Detailed information about the cluster's nodes is displayed below. Click
on an icon in the `Database` pane to navigate to detailed information
about the selected database.
* Select the [`Metrics`](#reviewing-cluster-metrics) tab to view details
about cluster resource use.
* Select the `Logs` tab to review cluster log files.
- Select the [`Overview`](#the-overview-tab) tab to view information
about the cluster and the databases currently deployed on the cluster.
Detailed information about the cluster nodes displays below. Click an
icon in the `Database` pane to navigate to detailed information about
the selected database.
- Select the [`Metrics`](#reviewing-cluster-metrics) tab to view
details about cluster resource use.
- Select the [`Logs`](#reviewing-cluster-log-files) tab to review
cluster log files.

### The Overview Tab

Select the `Overview` tab to review information about the cluster. Panes
on the `Overview` tab contain links to cluster artifacts:
Select the `Overview` tab to review information about the cluster.
Panes on the `Overview` tab contain links to cluster artifacts:

* Select a database name in the `Databases` pane to navigate to the
information page for that database.
* Select a backup store name in the `Backup Store` pane to navigate to
the information page for the store.
- Select a database name in the `Databases` pane to navigate to the
information page for that database.
- Select a backup store name in the `Backup Store` pane to navigate to
the information page for the store.

![The cluster overview](../images/cluster_overview_details.png)

The `Nodes` pane contains general node information. Use the tabbed browser
to select a node to review information that node:
The `Nodes` pane contains general node information. Use the tabbed
browser to select a node and review information about that node:

* The `Availability Zone` lists the provider region in which the node
- The `Availability Zone` lists the provider region in which the node
is deployed.
* Use the `External IP Address` when making ssh connections to the node.
* Use the `Internal IP Address` when configuring VPN connections to
the node.
* The `Instance Type` and `Volume Size` fields provide node size information.
* The `Instance ID` identifies the node and associated resources in the
- Use the `External IP Address` when making SSH connections to the node.
- Use the `Internal IP Address` when configuring VPN connections to the
node.
- The `Instance Type` and `Volume Size` fields provide node size information.
- The `Instance ID` identifies the node and associated resources in the
cloud provider console.
* The `UUID` is a unique identifier for cluster resources outside of
- The `UUID` is a unique identifier for cluster resources outside of
the cloud provider console; use the UUID when making API calls.

**Cluster Nodes Map**

When the `Overview` tab is selected, a map displays the locations of
the cluster's nodes. Hover over a mapped node to display the name and
the cluster nodes. Hover over a mapped node to display the name and
city in which the node resides.

![The cluster console Map tab](../images/cluster_map_tab.png)

**Review Firewall Configuration**

The `Overview` tab displays the currently defined [Firewall Rules]
(firewall.md).
The `Overview` tab also displays the currently defined
[Firewall Rules](firewall.md).

![The cluster's firewall rules](../images/overview_firewall_rule.png)

Select the `Manage Firewall Rules` button to open a dialog that allows you to
[modify or create rules](firewall.md) for the cluster.
Select the `Manage Firewall Rules` button to open a dialog that allows
you to [modify or create rules](firewall.md) for the cluster.

The `Overview` tab also displays the current [VPC Associations](vpc_assoc.md):

![The cluster's VPC associations](../images/overview_vpc_assoc.png)

**VPC Associations**
Select the `+ Add VPC Association` button to add a new association.

The Overview tab also displays the current [VPC Associations](vpc_assoc.md):
The `Overview` tab also displays a list of the current public ingresses:

![The cluster's VPC associations ](../images/overview_vpc_assoc.png)
![Accessing a public ingress](../images/ingress_list.png)

Select the `+ Add Ingress` button to
[create a public ingress](../services.md#creating-a-public-ingress)
for a cluster without a public-facing IP address.


### Reviewing Cluster Metrics
Expand All @@ -103,21 +107,20 @@ the cluster.

![The cluster metrics](../images/cluster_metrics_details.png)

Select from tabs across the top to review a graph containing:
Select from the tabs across the top to review graphs containing:

* Metrics for `All nodes` in your cluster.
* Metrics for a specific node in your cluster.
- metrics for all nodes in your cluster.
- metrics for a specific node in your cluster.

Use the drop-down at the top of the `Metrics` pane allows you to
specify the length of time displayed by each graph.
The drop-down at the top of the `Metrics` pane allows you to specify
the length of time displayed by each graph.

Select a point on a graph to display information about the graphed event
that occurred on your cluster:
Select a point on a graph to display information about the graphed
event that occurred on your cluster:

![A point-in-time selected in the cluster metrics graph]
(../images/cluster_metrics_PIT.png)
![A point-in-time in the cluster metrics graph](../images/cluster_metrics_PIT.png)

The graphs display metrics about:
The following table describes the available graphs:

| Graph Name | Description |
|------------|-------------|
Expand All @@ -128,49 +131,51 @@ The graphs display metrics about:
| Network Receive | The amount of data received by the instance |
| Network Send | The amount of data transmitted from the instance |


### Reviewing Cluster Log Files

Select the `Logs` tab to review log files for the cluster.

![The cluster log files](../images/cluster_log_details.png)

Use the tabs across the top to select the node(s) for which you'd like to
review the log files. Then:
Use the tabs across the top to select the nodes for which you want to
review log files. Then select one of the following log types:

* select `System logs` to review the system commands performed to
manage your cluster.
* select `Docker logs` to review the Docker-specific commands executed
to manage the container in which your cluster is running.
* select `SSH logs` to review details about ssh connections made to
your cluster.
- `System logs` to review the system commands performed to manage your
cluster.
- `Docker logs` to review the Docker-specific commands executed to
manage the container in which your cluster is running.
- `SSH logs` to review details about SSH connections made to your
cluster.

Use the `Auto refresh`/`Manual refresh` drop-down to specify if the log
entries should update automatically (`Auto refresh`), or to pause updating
(`Manual refresh`) for easier viewing. To manually refresh the log
Use the `Auto refresh`/`Manual refresh` drop-down to specify whether
log entries update automatically (`Auto refresh`) or pause updating
(`Manual refresh`) for easier viewing. To manually refresh the log
table's content, select the refresh button to the right of the drop-down.

Use controls in the table header to sort or search the selected log file:
Use the controls in the table header to sort or search the selected log file:

* Select a column heading to sort alphabetically by the column value;
click a second time to reverse the sort order.
* Click the filter icon to the right of the `Level` heading to select a
status from the drop-down; all rows assigned the selected status will be
filtered to the top of the result set.
- Select a column heading to sort alphabetically by the column value;
select a second time to reverse the sort order.
- Click the filter icon to the right of the `Level` heading to select a
status from the drop-down; all rows assigned the selected status will
be filtered to the top of the result set.

![Filtering the cluster log](../images/cluster_log_filter.png)

* Use the search box to the right of the `Message` label to enter a
- Use the search box to the right of the `Message` label to enter a
search string; the search term will be highlighted in the log file
entries. Use the navigation arrows to move to the next/previous
entries. Use the navigation arrows to move to the next or previous
occurrence of the search term.

![Searching the cluster log](../images/cluster_log_message.png)

## pgEdge Distributed PostgreSQL: Cloud Edition Resources
## Cluster Administration Links

Use the links at the end of the navigation pane to access pgEdge
Distributed PostgreSQL: Cloud Edition resources:
Use the links at the end of the navigation pane to access pgEdge Cloud resources:

* For an invitation to the pgEdge Discord server, select the
`Community` link.
* To review the documentation, select the `Docs` link.
* To manage account details, select the `Settings` link.
* Select the `Team Management` link to manage account membership.
- To manage account details, select the [`Settings`](../settings.md) link.
- Select the [`Team Management`](../teams.md) link to manage account membership.
- For an invitation to the pgEdge Discord server, select the `Community` link.
- To review the documentation, select the
[`Docs`](https://docs.pgedge.com/) link.
32 changes: 30 additions & 2 deletions docs/cloud/database/create_db.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,39 @@ database is provisioned:

![Selecting database options](../images/create_db_options.png)

* Use the toggle switch next to `Install Northwind Database` to install the
Northwind sample database and schema objects.
* Use the toggle switch next to `Enable AWS CloudWatch Metrics` to share
metrics with [AWS CloudWatch](https://aws.amazon.com/cloudwatch/).

Use the `Services` section to add an [MCP server](https://docs.pgedge.com/pgedge-postgres-mcp-server/v1-0-0/) to your installation. Currently, MCP server functionality is supported only on private clusters with a defined ingress.

![Selecting database services](../images/create_db_services.png)

Select the button labeled `+ MCP Server` to add MCP server details for your database; for more information about adding or managing a service in the cloud, see [Adding pgEdge AI Tookit Functionality(../services.md)].

Select the Add MCP Server button to access the Add MCP Server popup and define an MCP server, and optionally enable an associated LLM.

![Adding an MCP Server](../images/add_mcp_server.png)

Use fields on the `Add MCP Server` popup to describe the server and optionally, the LLM:

* Click the `Select Host` field to select the node that the MCP server will be provisioned on; you can deploy the MCP server on each node of your cluster, but each MCP server deployment must be individually defined.

* Use the `API Token` field to provide the string used to authenticate with your MCP server; this is a user-created value.

* Slide the `LLM Enabled?` toggle switch to enable the LLM detail fields.

* Use the LLM Provider drop-down to select your AI provider; currently, Cloud supports the following AI providers:

* Anthropic AI (Claude)
* OpenAI (ChatGPT)
* Ollama

* Enter the model name of the LLM provider; this field is not validated, but must match the name of an available model. For example, the following models are supported:

* claude-sonnet-4-6
* gpt-4o
* llama3.1

After making your selections, click `Create Database` to initialize a
Postgres database and start replicating data between the nodes in the
cluster. Your new database is added to the list of databases in the left pane
Expand Down
14 changes: 13 additions & 1 deletion docs/cloud/database/manage_db.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,16 @@ The database header tells you:
* The Postgres database version.
* The version of the Spock extension in use by the database.

### Changing the Display Name of a Database

To change the name of a database that is displayed in the navigation pane, highlight the database name and select `Edit Display Name` from the `Actions` menu.

![pgEdge Database Console](../images/actions_database.png)

When the `Change Display Name` popup opens, enter the new database name in the `Display Name` field and select `Apply`.

![pgEdge Database Console](../images/edit_display_name.png)


## The Get Started Pane

Expand Down Expand Up @@ -79,7 +89,9 @@ access the password associated with one of the identities (`app`,

![Password management options](../images/password.png)

Then, use options in the `Password` field to manage the password
### Password Management

You can use options in the `Password` field to manage the password
assigned to the `app` user:

* Select `show` to display the password in unobscured form; select `hide`
Expand Down
30 changes: 0 additions & 30 deletions docs/cloud/database_admin/extensions.md

This file was deleted.

Loading