diff --git a/docs/source/how-to/adaptive.rst b/docs/source/adaptive.rst similarity index 97% rename from docs/source/how-to/adaptive.rst rename to docs/source/adaptive.rst index 93b1e1dd6e1..942db0b6833 100644 --- a/docs/source/how-to/adaptive.rst +++ b/docs/source/adaptive.rst @@ -1,5 +1,5 @@ -Setup adaptive deployments -========================== +Adaptive deployments +==================== Motivation ---------- @@ -20,7 +20,7 @@ goal of the *adaptive deployments* discussed in this document. | -.. image:: ../images/dask-adaptive.svg +.. image:: images/dask-adaptive.svg :alt: Dask adaptive scaling :align: center :scale: 40% diff --git a/docs/source/conf.py b/docs/source/conf.py index fa014fd6249..8a129d032b9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -404,9 +404,12 @@ ("setup/ssh.html", "deploying-ssh.html"), ("how-to/deploy-dask/ssh.html", "deploying-ssh.html"), ("setup/adaptive.html", "how-to/adaptive.html"), + ("how-to/adaptive.html", "adaptive.html"), ("setup/custom-startup.html", "how-to/customize-initialization.html"), ("setup/environment.html", "how-to/manage-environments.html"), + ("how-to/manage-environments.html", "software-environments.html"), ("setup/prometheus.html", "how-to/setup-prometheus.html"), + ("how-to/setup-prometheus.html", "prometheus.html"), ] diff --git a/docs/source/how-to/customize-initialization.rst b/docs/source/customize-initialization.rst similarity index 99% rename from docs/source/how-to/customize-initialization.rst rename to docs/source/customize-initialization.rst index 9fec9ec8268..22098b2e1b5 100644 --- a/docs/source/how-to/customize-initialization.rst +++ b/docs/source/customize-initialization.rst @@ -1,4 +1,4 @@ -Customize initialization +Customize Initialization ======================== Often we want to run custom code when we start up or tear down a scheduler or diff --git a/docs/source/deploying-extra.rst b/docs/source/deploying-extra.rst new file mode 100644 index 00000000000..8d4debbca99 --- /dev/null +++ b/docs/source/deploying-extra.rst @@ -0,0 +1,13 @@ +Additional Information +====================== + +.. toctree:: + :maxdepth: 1 + + adaptive + deploying-docker.rst + deploying-python-advanced.rst + software-environments + prometheus + customize-initialization + deployment-considerations.rst diff --git a/docs/source/deploying.rst b/docs/source/deploying.rst index c4db371784c..67b57c8a0de 100644 --- a/docs/source/deploying.rst +++ b/docs/source/deploying.rst @@ -16,12 +16,10 @@ Deploy Dask Clusters deploying-python.rst deploying-cli.rst deploying-ssh.rst - deploying-docker.rst deploying-hpc.rst deploying-kubernetes.rst deploying-cloud.rst - deploying-python-advanced.rst - deployment-considerations.rst + deploying-extra.rst .. grid-item:: :columns: 12 12 7 7 @@ -91,7 +89,7 @@ and debugging by using the distributed scheduler. The sophistication of the newer system on a single machine. This provides more advanced features while still requiring almost no setup. Manual deployments (not recommended) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +------------------------------------ You can set up Dask clusters by hand, or with tools like SSH. @@ -107,7 +105,7 @@ some common resource manager to help you manage your machines, and then deploy Dask on that system. Those options are described below. High Performance Computing -~~~~~~~~~~~~~~~~~~~~~~~~~~ +-------------------------- See :doc:`deploying-hpc` for more details. @@ -119,7 +117,7 @@ See :doc:`deploying-hpc` for more details. Multi-tenant, secure clusters. Once configured, users can launch clusters without direct access to the underlying HPC backend. Kubernetes -~~~~~~~~~~ +---------- See :doc:`deploying-kubernetes` for more details. @@ -131,7 +129,7 @@ See :doc:`deploying-kubernetes` for more details. Single Dask cluster and (optionally) Jupyter on deployed with Helm. Cloud -~~~~~ +----- See :doc:`deploying-cloud` for more details. @@ -144,8 +142,14 @@ See :doc:`deploying-cloud` for more details. .. _managed-cluster-solutions: Managed Solutions -~~~~~~~~~~~~~~~~~ +----------------- - `Coiled `_ manages the creation and management of Dask clusters on cloud computing environments (AWS and GCP). - `Domino Data Lab `_ lets users create Dask clusters in a hosted platform. - `Saturn Cloud `_ lets users create Dask clusters in a hosted platform or within their own AWS accounts. + +Advanced Understanding +---------------------- + +There are additional concepts to understand if you want to improve your +deployment. diff --git a/docs/source/how-to/setup-prometheus.rst b/docs/source/prometheus.rst similarity index 93% rename from docs/source/how-to/setup-prometheus.rst rename to docs/source/prometheus.rst index 47697373ca9..e3fffcf1570 100644 --- a/docs/source/how-to/setup-prometheus.rst +++ b/docs/source/prometheus.rst @@ -1,7 +1,7 @@ .. When modifying the contents of this page, please adjust the corresponding page in the dask.distributed documentation accordingly. -Setup Prometheus monitoring -=========================== +Prometheus +========== Prometheus_ is a widely popular tool for monitoring and alerting a wide variety of systems. A distributed cluster offers a number of Prometheus metrics if the diff --git a/docs/source/how-to/manage-environments.rst b/docs/source/software-environments.rst similarity index 99% rename from docs/source/how-to/manage-environments.rst rename to docs/source/software-environments.rst index 85cae3eb49b..1373029aadd 100644 --- a/docs/source/how-to/manage-environments.rst +++ b/docs/source/software-environments.rst @@ -1,4 +1,4 @@ -Manage environments +Manage Environments =================== It is critical that each of your dask workers uses the same set of