Skip to content
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
1 change: 0 additions & 1 deletion presto-docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
sphinx==8.2.1
sphinx-immaterial==0.13.0
sphinx-copybutton==0.5.2
7 changes: 1 addition & 6 deletions presto-docs/src/main/sphinx/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def get_version():
needs_sphinx = '8.2.1'

extensions = [
'sphinx_immaterial', 'sphinx_copybutton', 'download', 'issue', 'pr', 'sphinx.ext.autosectionlabel'
'sphinx_immaterial', 'download', 'issue', 'pr', 'sphinx.ext.autosectionlabel'
]

copyright = 'The Presto Foundation. All rights reserved. Presto is a registered trademark of LF Projects, LLC'
Expand Down Expand Up @@ -106,13 +106,8 @@ def get_version():
html_logo = 'images/logo.png'
html_favicon = 'images/favicon.ico'

# doesn't seem to do anything
# html_baseurl = 'overview.html'

html_static_path = ['.']

templates_path = ['_templates']

# Set the primary domain to js because if left as the default python
# the theme errors when functions aren't available in a python module
primary_domain = 'js'
Expand Down
2 changes: 1 addition & 1 deletion presto-docs/src/main/sphinx/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ Installation
:maxdepth: 1

installation/deployment
installation/deploy-docker
installation/deploy-brew
installation/deploy-docker
installation/deploy-helm
6 changes: 3 additions & 3 deletions presto-docs/src/main/sphinx/installation/deploy-brew.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
============================
Deploy Presto using Homebrew
============================
===========================
Deploy Presto with Homebrew
===========================

This guide explains how to install and get started with Presto on macOS, Linux or WSL2 using the Homebrew package manager.

Expand Down
88 changes: 50 additions & 38 deletions presto-docs/src/main/sphinx/installation/deploy-docker.rst
Original file line number Diff line number Diff line change
@@ -1,68 +1,74 @@
=================================
Deploy Presto From a Docker Image
=================================
=========================
Deploy Presto with Docker
=========================

This guide explains how to install and get started with Presto using Docker.

.. note::

These steps were developed and tested on Mac OS X, on both Intel and Apple Silicon chips.

These steps were developed and tested on Mac OS X, on both Intel and Apple Silicon chips.
Prepare the container environment
=================================

Follow these steps to:
If Docker is already installed, skip to step 4 to verify the setup.
Otherwise, follow the instructions below to install Docker and Colima using Homebrew or choose an alternative method.

- install the command line tools for brew, docker, and `Colima <https://github.com/abiosoft/colima>`_
- verify your Docker setup
- pull the Docker image of the Presto server
- start your local Presto server
1. Install `Homebrew <https://brew.sh/>`_ if it is not already present on the system.

Installing brew, Docker, and Colima
===================================
2. Install the Docker command line and `Colima <https://github.com/abiosoft/colima>`_ tools via the following command:

This task shows how to install brew, then to use brew to install Docker and Colima.
.. code-block:: shell

Note: If you have Docker installed you can skip steps 1-3, but you should
verify your Docker setup by running the command in step 4.
brew install docker colima

1. If you do not have brew installed, run the following command:
3. Run the following command to start Colima with defaults:

``/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"``
.. code-block:: shell

2. To install the Docker command line and `Colima <https://github.com/abiosoft/colima>`_ tools, run the following command:
colima start

``brew install docker colima``
.. note::

3. Run the following command:
The default VM created by Colima uses 2 CPUs, 2GiB memory and 100GiB storage. To customize the VM resources,
see the Colima README for `Customizing the VM <https://github.com/abiosoft/colima#customizing-the-vm>`_.

``colima start``
4. Verify the local setup by running the following command:

*Note*: The default VM created by Colima uses 2 CPUs, 2GB memory and 60GB storage. To customize the VM resources,
see the Colima README for `Customizing the VM <https://github.com/abiosoft/colima#customizing-the-vm>`_.
.. code-block:: shell

4. To verify your local setup, run the following command:
docker run hello-world

``docker run hello-world``
The following output confirms a successful installation.

If you see a response similar to the following, you are ready.
.. code-block:: shell
:class: no-copy

``Hello from Docker!``
``This message shows that your installation appears to be working correctly.``
Hello from Docker!
This message shows that your installation appears to be working correctly.

Installing and Running the Presto Docker container
==================================================

1. Download the latest non-edge Presto container from `Presto on DockerHub <https://hub.docker.com/r/prestodb/presto/tags>`_. Run the following command:
1. Download the latest non-edge Presto container from `Presto on DockerHub <https://hub.docker.com/r/prestodb/presto/tags>`_:

.. code-block:: shell

``docker pull prestodb/presto:latest``
docker pull prestodb/presto:latest

Downloading the container may take a few minutes. When the download completes, go on to the next step.

2. On your local system, create a file named ``config.properties`` containing the following text:
2. On the local system, create a file named ``config.properties`` containing the following text:

.. code-block:: none
.. code-block:: properties

coordinator=true
node-scheduler.include-coordinator=true
http-server.http.port=8080
discovery-server.enabled=true
discovery.uri=http://localhost:8080

3. On your local system, create a file named ``jvm.config`` containing the following text:
3. On the local system, create a file named ``jvm.config`` containing the following text:

.. code-block:: none

Expand All @@ -78,20 +84,26 @@ Installing and Running the Presto Docker container

4. To start the Presto server in the Docker container, run the command:

``docker run -p 8080:8080 -it -v ./config.properties:/opt/presto-server/etc/config.properties -v ./jvm.config:/opt/presto-server/etc/jvm.config --name presto prestodb/presto:latest``
.. code-block:: shell

docker run -p 8080:8080 -it -v ./config.properties:/opt/presto-server/etc/config.properties -v ./jvm.config:/opt/presto-server/etc/jvm.config --name presto prestodb/presto:latest

This command assigns the name ``presto`` for the newly-created container that uses the downloaded image ``prestodb/presto:latest``.

The Presto server logs startup information in the terminal window. Once you see a response similar to the following, the Presto server is running in the Docker container.
The Presto server logs startup information in the terminal window. The following output confirms the Presto server is running in the Docker container.

.. code-block:: shell
:class: no-copy

``======== SERVER STARTED ========``
======== SERVER STARTED ========

Removing the Presto Docker container
====================================
To remove the Presto Docker container, run the following two commands:
To stop and remove the Presto Docker container, run the following commands:

``docker stop presto``
.. code-block:: shell

``docker rm presto``
docker stop presto
docker rm presto

These commands return the name of the container ``presto`` when they succeed.
8 changes: 4 additions & 4 deletions presto-docs/src/main/sphinx/installation/deploy-helm.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
===============================
Deploy Presto Using Helm Charts
===============================
=======================
Deploy Presto with Helm
=======================

To deploy Presto using Helm charts, see the `Presto Helm Charts README <https://github.com/prestodb/presto-helm-charts/>`_.
To deploy Presto using Helm, see the `Presto Helm Charts README <https://github.com/prestodb/presto-helm-charts/>`_.
Loading