Skip to content

Commit

Permalink
Merge pull request #5962 from EnterpriseDB/release/2024-08-20a
Browse files Browse the repository at this point in the history
Release: 2024-08-20a
  • Loading branch information
gvasquezvargas authored Aug 20, 2024
2 parents 2662d4f + 0e7425f commit a4f5609
Show file tree
Hide file tree
Showing 33 changed files with 525 additions and 267 deletions.
5 changes: 2 additions & 3 deletions advocacy_docs/edb-postgres-ai/console/estate/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,11 @@ Within your Estate are Projects. Projects group your resources and services, all

## Viewing your estate

The Console provides a centralized location to view for managing the lifecycle of EDB Postgres AI Databases and EDB Postgres AI Agents, including provisioning, scaling, and monitoring. It has three view; an overview, a Projects view and an Estate view.
The Console provides a centralized location to view for managing the lifecycle of EDB Postgres AI Databases and EDB Postgres AI Agents, including provisioning, scaling, and monitoring. It has three views; an overview, a Projects view and an Estate view.

The Projects view shows all the projects in your Estate. Selecting a project gives you a view of all resources and services in the project.

The Estate view shows all the resources and services in your Estate. You can filter this view by resource type, project, or status. You The Estate view is a powerful way to see everything that is happening in.

The Estate view shows all the resources and services in your Estate. You can filter this view by resource type, project, or status. The Estate view is a powerful way to see all your resources in a single view.



Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
---
title: "EDB Postgres AI Estate: Cloud-hosted databases"
navTitle: Cloud-hosted databases
description: How to manage cloud-hosted databases in your EDB Postgres AI Estate.
description: How to manage Cloud-hosted databases in your EDB Postgres AI Estate.
---

Cloud-hosted databases are databases such as AWS S3 and RDS which are hosted in the cloud. The EDB Postges AI Console allows you to manage these databases as part of your Estate, so you can see all your databases in one place.
Cloud-hosted databases are databases such as AWS S3 and RDS which are hosted in the cloud. The EDB Postgres AI Console allows you to manage these databases as part of your Estate, so you can see all your Cloud-hosted databases in one place.

The Cloud-hosted databases view currently displays all the AWS S3 buckets and RDS instances that are available in selected AWS accounts.

## Managing access to AWS

The **Manage Access** button first offers you a menu of projects you can manage the AWS access for. The console then takes you through the steps required to enable the Estate to collect this information from AWS. See [Integrating AWS](../../estate/integrating/integrate_aws.mdx) for more details.

## Viewing Cloud-hosted Databases

Selecting any Cloud-hosted database displays the last check-in time for the database, it's name and region.



Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,50 @@ navTitle: EDB Postgres AI Clusters
description: How to manage clusters in your EDB Postgres AI Estate.
---

Clusters are the heart of your EDB Postgres AI Estate. They are the database instances that you create and manage in the EDB Postgres AI Console.
Clusters includes any Postgres cluster created by and managed by EDB Postgres AI Cloud Service. EDB Postgres AI Cloud Service can host these clusters on any supported cloud service provider (AWS, Azure, GCP), or it can host them using your own account on any cloud service provider.

Also included in this view are EDB Postgres AI Lakehouse analytics clusters, managed as part of the Cloud Service.

## Clusters view in the single pane of glass

The single pane of glass view shows a color-coded snapshot of the clusters, along with a textual description of which cloud service providers are in use and how many are Cloud Service Hosted by EDB or Managed but not hosted by EDB.

Selecting **View Estate** takes you to the full estate view.

## Full Clusters view

In the full clusters view, you can see all the clusters in your Estate. The view is similar to the project view but includes an additional **Project** column to show which project the cluster belongs to. You can select a cluster's project to go directly to the project view.

Selecting a clusters name brings up a cluster details view that shows:
* Cluster name
* Performance metrics including memory, CPU, storage, transaction rate and database size
* An overview of the cluster's configuration including:
* Cluster type
* Number of nodes
* Deployment type
* Cloud service provider
* Region
* Postgres type and version
* Provisioned instance type and size
* Provisioned storage volume type and properties
* Backup retention policy
* A psql command to connect to the cluster

Clusters with a green circle are running, those with a red circle are paused and those with a blue circle are recently deleted.

Running clusters have an ellipsis menu button that when selected, provides the following options:

| Option | Description |
|----------------------------------------------|--------------------------------------------------|
Edit Cluster | Edit the cluster details and configuration
Monitoring and Logging | View the latest monitoring and logging information for the cluster

## Creating a new cluster

The **Create New** button allows you to create a new Database cluster or Lakehouse analytics cluster in any of your projects. First, select between creating a Database cluster or a Lakehouse analytics node.

If you only have one project, the creation operation automatically uses it. If you have more than one project, a menu of available projects to create your cluster in pops-up for you to select which project the cluster should appear in.

After selecting the project you are taken to the Cloud Service's [Create Cluster](/edb-postgres-ai/cloud-service/getting_started/creating_cluster/) page where you can configure the cluster.


Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 15 additions & 33 deletions advocacy_docs/edb-postgres-ai/console/using/estate/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,48 +12,30 @@ navigation:

The Estate view is your everything view of every resource - clusters, hosted, and managed, self-managed, analytics lakehouses, and managed storage locations - in every project. It cuts through the [Projects](../projects/) demarcation to give a single unified view of all your resources.

Rather than grouped into projects, the Estate overview grouped into types of resources.
## Estate view in the single pane of glass

Each resource shows its type, the number of instances of that resource and, on the right of the pane, a graphical representation or breakdown of those instances.
The first view you see when you log into the EDB Postgres AI Console is the single pane of glass view of your Projects and Estate. The Estate part of this view shows you a summary of all the resources in your Estate. Each resource shows its type, the number of instances of that resource and, on the right of the pane, a graphical representation or breakdown of those instances.

## EDB Postgres AI Clusters
Selecting **View Estate** takes you to the full Estate overview.

This is any Postgres cluster created by and managed by EDB Postgres AI. EDB Postgres AI can host these clusters on any supported cloud service provider (AWS, Azure, GCP), or it can host them using by your own account on any cloud service provider.
## Estate View

Also included in this view are EDB Postgres AI Lakehouse analytics clusters.
Rather than being grouped into projects, the Estate overview groups resources by type of resource. The views are similar to their counterparts in the project overviews and views but include an additional **Project** column to show which project the resource belongs to. You can select a resources project to go directly to the project view.

The graphical view shows a color coded snapshot of the clusters, along with a textual description of which cloud service providers are in use and how many are Cloud Service Hosted by EDB or Managed but not hosted by EDB.
<div style="border:1px solid">

The **Create New** button allows you to create a new Database cluster or Lakehouse analytics cluster in any of your projects. First, select between creating a Database cluster or a Lakehouse analytics node. If you only have one project, the creation operation automatically uses it. If you have more than one project, a menu of available projects to create your cluster in pops-up for you to select which project the cluster should appear in.
![Estate Overview](images/estateview.png)

Selecting the **EDB Postgres AI Clusters** title takes you to the __EDB Postgres AI Cluster__ pane of the full Estate view.
</div>

Read more about viewing and managing [EDB Postgres AI Clusters](edb-postgres-ai-clusters) in the Console.

## Self Managed Postgres
## Estate View Resources

Using an agent you can include self-managed Postgres clusters installed both on-premises and in the cloud as part of your EDB Estate view by using an agent. The agent collects metrics from an associated cluster and feed it to the EDB Estate. It’s in this pane that the information appears.
The Estate view covers the following resources:

The **Configure Agent** button takes you through the steps needed to configure the Estate to receive data from an agent. See the [Agent](../../estate/agent/) documentation for more details and in particular [Install Agent](../../estate/agent/install-agent/) on how to install the agent on your platform.
* [EDB Postgres AI Clusters](edb-postgres-ai-clusters): This is any Postgres cluster created by and managed by EDB Postgres AI. This also includes EDB Postgres AI Lakehouse analytics clusters.
* [Self Managed Postgres](self-managed-postgres): This is any Postgres deployment that you have installed and manage on your own infrastructure and monitor with the [EDB Postgres AI Agent](../../estate/agent/).
* [Cloud Hosted Databases](cloud-hosted-databases): This is a view of all the AWS S3 buckets and RDS instances that are available in selected AWS accounts.
* [Storage Locations](storage-locations): These are data repositories for EDB Postgres AI Analytics.

Selecting the **Self Managed Postgres** title takes you to the __Self Managed Postgres__ pane of the full Estate view.

Read more about viewing and managing [Self Managed Postgres](self-managed-postgres) in the Console.

## Cloud Hosted Databases

Cloud Hosted Databases currently displays all the AWS S3 buckets and RDS instances that are available in selected AWS accounts.

The **Manage Access** button takes you through the steps required to enable the Estate to collect this information from AWS. See [Integrating AWS](../../estate/integrating/integrate_aws.mdx) for more details.

Selecting the **Cloud Hosted Databases** title takes you to the __Cloud Hosted Databases__ pane of the full Estate view.

Read more about [Cloud Hosted Databases](cloud-hosted-databases) in the Console.

## Storage Locations

Storage Locations, also known as Managed Storage Locations, are data repositories for EDB Postgres AI Analytics. You sync and migrate data to these locations for analysis from Postgres databases or S3 storage. The data is then optimized for fast query, aggregation, and analysis.

The **Manage Locations** button takes you the __Storage Locations__ view where you can search for, view, and add storage locations.

Selecting the **Storage Locations** title take you to the __Storage Locations__ pane of the full Estate view.
Each one of these views is a separate pane customized for the particular resource type.
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,12 @@ navTitle: "Self-managed Postgres"
description: How to view self-managed Postgres clusters in your EDB Postgres AI Estate.
---

Monitoring your database assets that you manage on your own infrastructure is a key part of managing your EDB Postgres AI Estate. The EDB Postgres AI Console provides a number of tools to help you, including a view of Self-managed Postgres clusters.
Monitoring the database assets that you manage on your own infrastructure is a key part of managing your EDB Postgres AI Estate.

You can include self-managed Postgres clusters installed both on-premises and in the cloud as part of your EDB Estate view by using an agent. The agent collects metrics from an associated cluster and feeds it to the EDB Estate. It’s in this pane that the information appears.

## Configuring Self-managed Postgres

The **Configure Agent** button takes you through the steps needed to configure the Estate to receive data from an agent. See the [Agent](../../estate/agent/) documentation for more details and in particular [Install Agent](../../estate/agent/install-agent/) on how to install the agent on your platform.


Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,24 @@ navTitle: Storage locations
description: How to manage storage locations in your EDB Postgres AI Estate.
---

Storage locations are the places where your analytical databases store their data. You can manage storage locations in the EDB Postgres AI Console's Storage Locations view.
Storage Locations, also known as Managed Storage Locations, are data repositories for EDB Postgres AI Analytics. You sync and migrate data to these locations for analysis from Postgres databases or S3 storage. The data is then optimized for fast query, aggregation, and analysis.

The **Manage Locations** button will ask you to select a project and then take you the __Storage Locations__ view of that project where you can search for, view, and add storage locations.

![Storage Locations](images/managedstoragelocations.png)

The map shows the locations of the storage locations in your project. The darker a region is, the more storage locations it has.

Below the map, you can see the following information for each storage location:
* Cloud provider
* Region
* Deployment type
* Number of locations

Clicking on the > symbol expands the list to show all the storage locations in that region, with their prefix and their tags. You can also add tags to a storage location in the expanded list.

!!! Note
Currently it's not possible to delete a storage location.
!!!

## Viewing storage locations

Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ You need a verified domain so your users can have a streamlined login experience
Domains can take up to 48 hours for the change of the domain record by the DNS provider to propagate before you can verify it.

4. If your domain hasn't verified after a day, you can debug whether your domain has the matching verification text field.
o check the exact value of the required TXT field, select **Verify** next to the domain at `/settings/domains`.
To check the exact value of the required TXT field, select **Verify** next to the domain at `/settings/domains`.
Query your domain directly with DNS tools, such as nslookup, to check if you have an exact match for a text = "verification" field.
Domains can have many TXT fields. As long as one matches, it should verify.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ description: How to manage clusters in an EDB Postgres AI project

Displays all the clusters in the project in a table format. The clusters view shows the cluster name, creation time (or for a paused cluster, when it was paused and when it will resume), the Postgres version, the cloud service provider, the region, the type of cluster, the provisioned instance type and provisioned storage.

In the top right, is a **Create New** button that allows you to create a new cluster in the project. Selecting this will take you to the Cloud Service's [Create Cluster](/edb-postgres-ai/cloud-service/getting_started/creating_cluster/) page where you can configure a new cluster.

## Cluster actions

To the right of the cluster's information is are a lock icon, a pen icon and an ellipsis menu button. The lock shows the credential information for the cluster, the pen icon takes you to the appropriate edit cluster page, and the ellipsis menu button which when selected provides the following options:

| Option | Description |
Expand All @@ -16,19 +20,19 @@ To the right of the cluster's information is are a lock icon, a pen icon and an
| [Delete Cluster](#delete-cluster) | Deletes the selected cluster |


## Create Replica
### Create Replica

Selecting **Create Replica** opens a dialog where you can select the cloud provider and region for the replica. Select **Create Replica** to create the replica.

## Change Password
### Change Password

Selecting **Change Password** opens a dialog where you can enter a new password for the cluster. Select **Change Password** to change the password.

## Pause/Resume Cluster
### Pause/Resume Cluster

Selecting **Pause/Resume Cluster** pauses or resumes the cluster. When you pause a cluster, the cluster stops and you aren't billed for the cluster. When you resume a cluster, the cluster restarts and you billing resumes for the cluster.

## Delete Cluster
### Delete Cluster

Selecting **Delete Cluster** opens a dialog asking you to confirm the deletion. Enter "delete cluster" in the text field and select **Delete Cluster** to permanently delete the cluster.

Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ To the right of the cluster's information is an ellipsis menu button, which when

**Edit Cluster** takes you to the appropriate page to edit the cluster details, depending on the type of cluster, database or Lakehouse. The page you go to is similar to the Create page used to create that type of cluster.

The **Credential Information** option shows you the connection details for the cluster, including the connection URL, userbane, and the database name. You can use these details to connect to the cluster from a Postgres client. Passwords are not shown in the UI, but you can reset the password if you need to.
The **Credential Information** option shows you the connection details for the cluster, including the connection URL, username, and the database name. You can use these details to connect to the cluster from a Postgres client. Passwords aren't shown in the UI, but you can reset the password if you need to.


Loading

2 comments on commit a4f5609

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸŽ‰ Published on https://edb-docs.netlify.app as production
πŸš€ Deployed on https://66c4a26a96c5a3297f40fe58--edb-docs.netlify.app

Please sign in to comment.