Skip to content

Commit

Permalink
docs: Update postgres aurora info
Browse files Browse the repository at this point in the history
Update instances of "postgresql <14", add note about Aurora v1
  • Loading branch information
tara-hpe committed Oct 24, 2024
1 parent 186962c commit 2719ca5
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/setup-cluster/aws/aws-spot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 9 additions & 3 deletions docs/setup-cluster/aws/install-on-aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,18 @@ CloudFormation <https://aws.amazon.com/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 <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`__
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 <https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html>`__ for
information on how to use AWS credentials.

- An `AWS EC2 Keypair <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html>`__.

Expand Down
8 changes: 4 additions & 4 deletions docs/setup-cluster/checklists/postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Determined uses a PostgreSQL database to store experiment and trial metadata.
GPUs, ensure that the :ref:`NVIDIA Container Toolkit <validate-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::
Expand Down Expand Up @@ -75,21 +75,21 @@ 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**

On Debian distributions, use the following command:

.. 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 <https://www.postgresql.org/download/linux/redhat>`_. Then,
install version 10:
install PostgreSQL 14:

.. code::
Expand Down
2 changes: 1 addition & 1 deletion docs/setup-cluster/on-prem/options/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This user guide provides step-by-step instructions for installing Determined usi
GPUs, ensure that the :ref:`NVIDIA Container Toolkit <validate-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::
Expand Down
4 changes: 2 additions & 2 deletions docs/setup-cluster/on-prem/options/linux-packages.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -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**

Expand Down
2 changes: 1 addition & 1 deletion docs/setup-cluster/slurm/hpc-environment-requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2719ca5

Please sign in to comment.