Skip to content

Commit

Permalink
Merge pull request #414 from pavithraes/remove-hpc-docs
Browse files Browse the repository at this point in the history
Remove Nebari-HPC docs
  • Loading branch information
viniciusdc authored May 14, 2024
2 parents 9c8038d + eb34703 commit aec2b9d
Show file tree
Hide file tree
Showing 7 changed files with 2 additions and 75 deletions.
8 changes: 0 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ To get started with Nebari right away, check the [Nebari documentation][nebari-d
## Table of contents

- [Nebari 101 :zap:](#nebari-101-zap)
- [Nebari on-prem](#nebari-on-prem)
- [Installation :computer:](#installation-computer)
- [Contributing to Nebari :woman_technologist:](#contributing-to-nebari-woman_technologist)
- [Installing the Development version of Nebari :gear:](#installing-the-development-version-of-nebari-gear)
Expand All @@ -54,13 +53,6 @@ mentioned technologies to have your project successfully deployed.
> If you know GitHub/GitLab and feel comfortable generating and using API keys, you should have all it takes to deploy
> and maintain your system without the need for a dedicated DevOps team. No need to learn Kubernetes, Terraform, or Helm.
### Nebari on-prem

We also have a version of Nebari based on OpenHPC. It can be used to deploy onto HPC systems or on bare-metal.

> **Note**
> This tool is currently under development. Curious? Check out the [Nebari HPC](https://github.com/Quansight/qhub-hpc) repository.
## Installation :computer:

Nebari is supported by macOS and Linux operating systems (Windows is **NOT** currently supported).
Expand Down
1 change: 0 additions & 1 deletion docs/docs/get-started/cloud-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,5 @@ For detailed instructions on how to deploy Nebari on **Azure** visit the [How to
[nebari-azure]: /how-tos/nebari-azure.md
[nebari-do]: /how-tos/nebari-do.md
[nebari-gcp]: /how-tos/nebari-gcp.md
[nebari-hpc]: /how-tos/nebari-hpc.md
[nebari-local]: /how-tos/nebari-local.md
[nebari-how-tos]: /how-tos/index.mdx
37 changes: 1 addition & 36 deletions docs/docs/get-started/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Choosing a deployment platform

# Choosing a deployment platform

Nebari can be deployed on a bare-metal server using HPC, any of the major public cloud providers, or on a pre-existing Kubernetes cluster.
Nebari can be deployed on any of the major public cloud providers, or on a pre-existing Kubernetes cluster.
Review the options below to determine which option best suits your needs.

import Tabs from '@theme/Tabs';
Expand Down Expand Up @@ -34,40 +34,6 @@ Currently, Nebari supports [Amazon AWS][nebari-aws], [DigitalOcean][nebari-do],

</TabItem>

<TabItem value="hpc-deployment-tab" label="HPC">

Nebari HPC is an opinionated open source deployment of JupyterHub based on an HPC jobscheduler (e.g. Slurm).
Nebari HPC is a "distribution" of these packages much like Debian and Ubuntu are distributions of Linux.

:::note
To note, Nebari HPC can be used on other distributed compute hardware, not just HPC hardware specifically. We anticipate that Nebari HPC will be used most often on HPC hardware, however.
:::

The high level goal of this distribution is to form a cohesive set of tools that enable:

- Environment management via [`conda`](https:/...conda.io/en/latest/) and [`conda-store`](https://conda-store.readthedocs.io/en/latest/)

- Monitoring of compute infrastructure and services

- Scalable and efficient compute via Jupyterlab and Dask

- On-prem deployment of Jupyterhub without requiring deep DevOps knowledge of the Slurm/HPC and Jupyter ecosystems

Nebari HPC should be your choice if:

- You have highly optimized code that requires highly performant infrastructure

- You have existing HPC infrastructure

- You expect that your projects will not exceed the resources/capabilities of your current infrastructure

For instructions on installing and deploying Nebari HPC, visit the [How to install and setup Nebari HPC on bare metal machines][nebari-hpc] section of the documentation.

:::note
Although it is possible to deploy Nebari HPC in the cloud, it is not generally recommended due to potentially high costs. For more information, check out the [base cost] section of the docs.
:::

</TabItem>
<TabItem value="local" label="Local deployment">

This approach is recommended for **testing and development** of Nebari’s components due to its simplicity. Choose the local mode if:
Expand Down Expand Up @@ -116,7 +82,6 @@ For instructions on installing and deploying Nebari on a particular cloud provid
[nebari-azure]: /how-tos/nebari-azure.md
[nebari-do]: /how-tos/nebari-do.md
[nebari-gcp]: /how-tos/nebari-gcp.md
[nebari-hpc]: /how-tos/nebari-hpc.md
[nebari-local]: /how-tos/nebari-local.md
[nebari-deploy]: /get-started/deploy.mdx
[supported-cloud-providers]: /get-started/cloud-providers.mdx
2 changes: 0 additions & 2 deletions docs/docs/get-started/installing-nebari.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,6 @@ Already made your mind about deployment? Check our handy how-to-guides:
- [Deploying Nebari on Azure][nebari-azure]
- [Deploying Nebari on Digital Ocean][nebari-do]
- [Deploying Nebari on GCP][nebari-gcp]
- [Deploying Nebari on HPC][nebari-hpc]
- [Deploying Nebari on a local cluster][nebari-local]- using [`kind`](https://kind.sigs.k8s.io/) no cloud required

<!-- Internal links -->
Expand All @@ -101,7 +100,6 @@ Already made your mind about deployment? Check our handy how-to-guides:
[nebari-azure]: /how-tos/nebari-azure.md
[nebari-do]: /how-tos/nebari-do.md
[nebari-gcp]: /how-tos/nebari-gcp.md
[nebari-hpc]: /how-tos/nebari-hpc.md
[nebari-local]: /how-tos/nebari-local.md
[nebari-deploy]: /get-started/deploy.mdx
[nebari-troubleshooting]: /troubleshooting.mdx
Expand Down
25 changes: 0 additions & 25 deletions docs/docs/how-tos/nebari-hpc.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ module.exports = {
"how-tos/nebari-aws",
"how-tos/nebari-do",
"how-tos/nebari-azure",
"how-tos/nebari-hpc",
"how-tos/nebari-kubernetes",
"how-tos/nebari-local",
"how-tos/nebari-destroy",
Expand Down
3 changes: 1 addition & 2 deletions docs/src/pages/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,7 @@ export default function HomePage() {
</p>
<p>
Nebari can be seamlessly deployed to the major public cloud
providers, including AWS, Azure, GCP, and Digital Ocean or to
bare-metal HPC clusters.
providers, including AWS, Azure, GCP, and Digital Ocean.
</p>
</div>
</div>
Expand Down

0 comments on commit aec2b9d

Please sign in to comment.