Skip to content
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

docs: Update postgres aurora info #10116

Merged
merged 2 commits into from
Oct 24, 2024
Merged
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
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
12 changes: 8 additions & 4 deletions docs/setup-cluster/checklists/postgresql.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@

Determined uses a PostgreSQL database to store experiment and trial metadata.

.. note::

We recommend installing the latest available version of PostgreSQL.

.. note::

If you are using an existing PostgreSQL installation, we recommend confirming that
Expand All @@ -22,7 +26,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 the latest PostgreSQL version.

.. code::

Expand Down Expand Up @@ -75,21 +79,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.

**Debian Distributions**

On Debian distributions, use the following command:

.. code::

sudo apt install postgresql-10
sudo apt install postgresql

**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:

.. 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 the latest PostgreSQL version.

.. 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 the latest PostgreSQL version.

.. 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.

**Debian Distributions**

Expand Down
5 changes: 3 additions & 2 deletions docs/setup-cluster/slurm/hpc-environment-requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The following software components are required:
| Podman | >= 4.0.0 | Admin |
+------------------------+----------------------------------+------------------+
| PostgreSQL | 10 (RHEL 8), 13 (RHEL 9), 14 | Admin |
| | (Ubuntu 22.04) or newer | |
| | (Ubuntu 22.04) or later | |
+------------------------+----------------------------------+------------------+
| HPC client packages | Same as login nodes | Admin |
+------------------------+----------------------------------+------------------+
Expand All @@ -109,7 +109,8 @@ 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 13 or later, which will be installed on the admin node. We
recommend using the latest available version of PostgreSQL for optimal support and security. 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
Loading