From 2719ca5322566d300264b6c845ad0afd215c5ffa Mon Sep 17 00:00:00 2001 From: Tara Charter Date: Wed, 23 Oct 2024 18:51:41 -0500 Subject: [PATCH] docs: Update postgres aurora info Update instances of "postgresql <14", add note about Aurora v1 --- docs/setup-cluster/aws/aws-spot.rst | 2 +- docs/setup-cluster/aws/install-on-aws.rst | 12 +++++++++--- docs/setup-cluster/checklists/postgresql.rst | 8 ++++---- docs/setup-cluster/on-prem/options/docker.rst | 2 +- .../setup-cluster/on-prem/options/linux-packages.rst | 4 ++-- .../slurm/hpc-environment-requirements.rst | 2 +- 6 files changed, 18 insertions(+), 12 deletions(-) diff --git a/docs/setup-cluster/aws/aws-spot.rst b/docs/setup-cluster/aws/aws-spot.rst index 6ab280fc7aa2..da329bc81034 100644 --- a/docs/setup-cluster/aws/aws-spot.rst +++ b/docs/setup-cluster/aws/aws-spot.rst @@ -4,7 +4,7 @@ Use Spot Instances #################### -This document describes how to use AWS spot instances with Determined. Spot instances can be much +This guide describes how to use AWS spot instances with Determined. Spot instances can be much cheaper than on-demand instances (up to 90% cheaper, but more often 70-80%) but they are unreliable, so software that runs on spot instances must be fault tolerant. Unfortunately, deep learning code is often not written with fault tolerance in mind, preventing many practitioners from using spot diff --git a/docs/setup-cluster/aws/install-on-aws.rst b/docs/setup-cluster/aws/install-on-aws.rst index d8bc70387565..74c1f92da849 100644 --- a/docs/setup-cluster/aws/install-on-aws.rst +++ b/docs/setup-cluster/aws/install-on-aws.rst @@ -23,12 +23,18 @@ CloudFormation `__ to automatically depl Determined cluster. CloudFormation builds the necessary components for Determined into a single CloudFormation stack. +.. important:: + + **Amazon Aurora V1 is no longer supported**. We recommend migrating to **Amazon RDS for + PostgreSQL 14**. Deployments using ``det deploy aws`` will default to the ``simple-rds`` + deployment type, which uses Amazon RDS. + Requirements ============ -- Either AWS credentials or an IAM role with permissions to access AWS CloudFormation APIs. See the - `AWS Documentation `__ - for information on how to use AWS credentials. +- AWS credentials or an IAM role with permissions to access AWS CloudFormation APIs. See the `AWS + Documentation `__ for + information on how to use AWS credentials. - An `AWS EC2 Keypair `__. diff --git a/docs/setup-cluster/checklists/postgresql.rst b/docs/setup-cluster/checklists/postgresql.rst index cde700b05095..0ea17c831770 100644 --- a/docs/setup-cluster/checklists/postgresql.rst +++ b/docs/setup-cluster/checklists/postgresql.rst @@ -22,7 +22,7 @@ Determined uses a PostgreSQL database to store experiment and trial metadata. GPUs, ensure that the :ref:`NVIDIA Container Toolkit ` on each one is working as expected. -#. Pull the official Docker image for PostgreSQL. PostgreSQL version 10 and later is supported. +#. Pull the official Docker image for PostgreSQL 14 or later. .. code:: @@ -75,7 +75,7 @@ Determined uses a PostgreSQL database to store experiment and trial metadata. Install PostgreSQL using ``apt`` or ``yum`` =========================================== -#. Install PostgreSQL 10 or greater. +#. Install PostgreSQL 14 or later. **Debian Distributions** @@ -83,13 +83,13 @@ Install PostgreSQL using ``apt`` or ``yum`` .. code:: - sudo apt install postgresql-10 + sudo apt install postgresql-14 **Red Hat Distributions** On Red Hat distributions, you'll need to configure the PostgreSQL yum repository as described in the `Red Hat Linux documentation `_. Then, - install version 10: + install PostgreSQL 14: .. code:: diff --git a/docs/setup-cluster/on-prem/options/docker.rst b/docs/setup-cluster/on-prem/options/docker.rst index 2ecf417d02a2..08f1c93145af 100644 --- a/docs/setup-cluster/on-prem/options/docker.rst +++ b/docs/setup-cluster/on-prem/options/docker.rst @@ -14,7 +14,7 @@ This user guide provides step-by-step instructions for installing Determined usi GPUs, ensure that the :ref:`NVIDIA Container Toolkit ` on each one is working as expected. -#. Pull the official Docker image for PostgreSQL. PostgreSQL version 10 and later is supported. +#. Pull the official Docker image for PostgreSQL 14 or later. .. code:: diff --git a/docs/setup-cluster/on-prem/options/linux-packages.rst b/docs/setup-cluster/on-prem/options/linux-packages.rst index 1194c11ad93b..08afb286cad9 100644 --- a/docs/setup-cluster/on-prem/options/linux-packages.rst +++ b/docs/setup-cluster/on-prem/options/linux-packages.rst @@ -34,7 +34,7 @@ Docker container or your Linux distribution's package and service. Run PostgreSQL in Docker ------------------------ -#. Pull the official Docker image for PostgreSQL. PostgreSQL version 10 and later is supported. +#. Pull the official Docker image for PostgreSQL 14 or later. .. code:: @@ -65,7 +65,7 @@ Run PostgreSQL in Docker Install PostgreSQL using ``apt`` or ``yum`` ------------------------------------------- -#. Install PostgreSQL. Version 10 and later is supported. +#. Install PostgreSQL 14 or later. **Debian Distributions** diff --git a/docs/setup-cluster/slurm/hpc-environment-requirements.rst b/docs/setup-cluster/slurm/hpc-environment-requirements.rst index f28d644fa5c3..a0329a8bc0f4 100644 --- a/docs/setup-cluster/slurm/hpc-environment-requirements.rst +++ b/docs/setup-cluster/slurm/hpc-environment-requirements.rst @@ -109,7 +109,7 @@ The following software components are required: Database Requirements ===================== -The solution requires PostgreSQL 10 or newer, which will be installed on the admin node. The +The solution requires PostgreSQL 14 or later, which will be installed on the admin node. The required disk space for the database is estimated as follows: - 200 GB on small systems (less than 15 workers) or big systems if the experiment logs are sent to