Skip to content

Commit

Permalink
Merge pull request #544 from nebari-dev/remove-do
Browse files Browse the repository at this point in the history
Remove DigitalOcean references in the docs
  • Loading branch information
marcelovilla authored Dec 16, 2024
2 parents 67c76b5 + 9554d08 commit 53fae55
Show file tree
Hide file tree
Showing 24 changed files with 9 additions and 395 deletions.
2 changes: 1 addition & 1 deletion docs/community/nebari-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ To test on cloud Kubernetes, deploy Nebari in the normal way on the cloud, but m
- [Use a development branch](#use-a-development-branch) to specify the Docker images based on the latest development code in `nebari-config.yaml`.

:::warning
Testing your contribution by deploying Nebari on the cloud (AWS, GCP, Azure, and Digital Ocean) can consume a lot of time and resources.
Testing your contribution by deploying Nebari on the cloud (AWS, GCP, and Azure) can consume a lot of time and resources.
Always prefer local testing when possible.
It will be easier to debug, may be quicker to deploy, and is likely to be less expensive.
:::
Expand Down
3 changes: 1 addition & 2 deletions docs/docs/explanations/advanced-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,6 @@ domain: demo.nebari.dev

`provider`: Determines the cloud provider used to deploy infrastructure related resources on Nebari. Possible values are:

- `do` for DigitalOcean
- `aws` for Amazon Web Services
- `gcp` for Google Could Provider
- `azure` for Microsoft Azure
Expand Down Expand Up @@ -316,7 +315,7 @@ The CI/CD workflow that is best for you will depend on your organization, but th
- Advanced Nebari users may also want to add a step in their deployment flow that includes a `nebari render` so that the administrator may preview the resulting diffs to IaC and/or CI/CD files before `nebari deploy` is executed.

:::note
In order for your CI/CD pipeline to be able to deploy changes into your Nebari cloud hosting provider, you must set the appropriate authentication environment variables for your GitLab or GitHub CI/CD execution environment. See the Authentication section for deploing to [AWS](https://www.nebari.dev/docs/how-tos/nebari-aws/#authentication), [Azure](https://www.nebari.dev/docs/how-tos/nebari-azure#authentication), [GCP](https://www.nebari.dev/docs/how-tos/nebari-gcp/#authentication), or [Digital Ocean](https://www.nebari.dev/docs/how-tos/nebari-do/#authentication) for Nebari's required variables. Guidance on how to set these for your repository/project can be found in the documentation for [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/variables) and [GitLab CI/CD](https://docs.gitlab.com/ee/ci/variables/).
In order for your CI/CD pipeline to be able to deploy changes into your Nebari cloud hosting provider, you must set the appropriate authentication environment variables for your GitLab or GitHub CI/CD execution environment. See the Authentication section for deploing to [AWS](https://www.nebari.dev/docs/how-tos/nebari-aws/#authentication), [Azure](https://www.nebari.dev/docs/how-tos/nebari-azure#authentication), or [GCP](https://www.nebari.dev/docs/how-tos/nebari-gcp/#authentication) for Nebari's required variables. Guidance on how to set these for your repository/project can be found in the documentation for [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/variables) and [GitLab CI/CD](https://docs.gitlab.com/ee/ci/variables/).
:::

### Certificates
Expand Down
32 changes: 0 additions & 32 deletions docs/docs/explanations/advanced-provider-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,37 +226,6 @@ azure:
</TabItem>
<TabItem value="do" label="DigitalOcean">
DigitalOcean has a restriction with autoscaling in that the minimum nodes allowed (`min_nodes` = 1) is one but is by far the least expensive provider even accounting for `spot/pre-emptible` instances.
In addition, Digital Ocean doesn't have accelerator/gpu support.

Digital Ocean is a good choice for trying out Nebari, but we recommend selecting a different provider for your production Nebari deployment.

To see available instance types refer to [Digital Ocean Instance Types](https://www.digitalocean.com/docs/droplets/).
Additionally the Digital Ocean cli `doctl` has [support for listing droplets](https://www.digitalocean.com/docs/apis-clis/doctl/reference/compute/droplet/list/).

```yaml
digital_ocean:
region: nyc3
kubernetes_version: "1.21.10-do.0"
node_groups:
general:
instance: "g-4vcpu-16gb"
min_nodes: 1
max_nodes: 1
user:
instance: "g-2vcpu-8gb"
min_nodes: 1
max_nodes: 5
worker:
instance: "g-2vcpu-8gb"
min_nodes: 1
max_nodes: 5
```

</TabItem>

<TabItem value="existing" label="Existing Kubernetes clusters">
Originally designed for Nebari deployments on a "local" minikube cluster, this feature has now expanded to allow users to deploy Nebari to any existing kubernetes cluster.
Expand Down Expand Up @@ -318,7 +287,6 @@ local:
:::note
Many of the cloud providers regularly update their internal **Kubernetes versions** so if you wish to specify a particular version, please check the following resources.
This is _completely optional_ as Nebari will, by default, select the most recent version available for your preferred cloud provider:
[Digital Ocean](https://docs.digitalocean.com/products/kubernetes/changelog/);
[Google Cloud Platform](https://cloud.google.com/kubernetes-engine/docs/release-notes-stable);
[Amazon Web Services](https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html);
[Microsoft Azure](https://docs.microsoft.com/en-us/azure/aks/supported-kubernetes-versions?tabs=azure-cli).
Expand Down
4 changes: 0 additions & 4 deletions docs/docs/explanations/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,7 @@ import TabItem from '@theme/TabItem';
![GCP Architecture Diagram](/img/explanations/architecture-diagram-gcp.png)

</TabItem>
<TabItem value="do" label="Digital Ocean">

![DO Architecture Diagram](/img/explanations/architecture-diagram-do.png)

</TabItem>
<TabItem value="aws" label="Amazon AWS">

![AWS Architecture Diagram](/img/explanations/architecture-diagram-aws.png)
Expand Down
8 changes: 2 additions & 6 deletions docs/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ If you'd like to retain the latest version of an environment and only remove spe
## How do I use preemptible and spot instances on Nebari?

A preemptible or spot VM is an instance that you can create and run at a much lower price than normal instances. Azure
and Google Cloud platform use the term preemptible, while AWS uses the term spot, and Digital Ocean doesn't support
these types of instances. However, the cloud provider might stop these instances if it requires access to those
and Google Cloud platform use the term preemptible, while AWS uses the term spot.
However, the cloud provider might stop these instances if it requires access to those
resources for other tasks. Preemptible instances are excess Cloud Provider's capacity, so their availability varies with
usage.

Expand Down Expand Up @@ -84,10 +84,6 @@ Spot instances aren't supported at this moment.
Preemptible instances aren't supported at this moment.
##### Digital Ocean
Digital Ocean doesn't support these type of instances.
## Why doesn't my code recognize the GPU(s) on Nebari?
First be sure you chose a [GPU-enabled server when you selected a profile][selecting a profile]. Next, if you're using PyTorch, see [Using GPUs on Nebari][using gpus]. If it's still not working for you, be sure your environment includes a GPU-specific version of either PyTorch or TensorFlow, i.e. `pytorch-gpu` or `tensorflow-gpu`. Also note that `tensorflow>=2` includes both CPU and GPU capabilities, but if the GPU is still not recognized by the library, try removing `tensorflow` from your environment and adding `tensorflow-gpu` instead.
Expand Down
10 changes: 0 additions & 10 deletions docs/docs/get-started/cloud-providers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,17 +36,8 @@ import TabItem from '@theme/TabItem';
For detailed instructions on how to deploy Nebari on **GCP** visit the [How to deploy Nebari on GCP][nebari-gcp] section.

</TabItem>
<TabItem value="do" label="Digital Ocean">

<div class="text--center">
<img src="/img/get-started/started-digital-ocean-logo.png" width={420} />
</div>

[DigitalOcean](https://docs.digitalocean.com/products/kubernetes/) is a cloud hosting provider that offers cloud computing services and Infrastructure as a Service (IaaS) known for its pricing and scalability.

For detailed instructions on how to deploy Nebari on **Digital Ocean** visit the [How to deploy Nebari on Digital Ocean][nebari-do] section.

</TabItem>
<TabItem value="aws" label="Amazon AWS">

<div class="text--center">
Expand Down Expand Up @@ -75,7 +66,6 @@ For detailed instructions on how to deploy Nebari on **Azure** visit the [How to

[nebari-aws]: /how-tos/nebari-aws.md
[nebari-azure]: /how-tos/nebari-azure.md
[nebari-do]: /how-tos/nebari-do.md
[nebari-gcp]: /how-tos/nebari-gcp.md
[nebari-local]: /how-tos/nebari-local.md
[nebari-how-tos]: /how-tos/index.mdx
4 changes: 1 addition & 3 deletions docs/docs/get-started/deploy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ If you are not sure which option to choose, a cloud installation is likely your
:::note
The cloud installation is based on Kubernetes, but knowledge of Kubernetes is **NOT** required nor is in-depth knowledge about the specific provider required either.

Currently, Nebari supports [Amazon AWS][nebari-aws], [DigitalOcean][nebari-do], [Google GCP][nebari-gcp], and [Azure][nebari-azure].
Currently, Nebari supports [Amazon AWS][nebari-aws], [Google GCP][nebari-gcp], and [Azure][nebari-azure].
:::

</TabItem>
Expand Down Expand Up @@ -73,14 +73,12 @@ For instructions on installing and deploying Nebari on a particular cloud provid

- [Deploying Nebari on AWS][nebari-aws]
- [Deploying Nebari on Azure][nebari-azure]
- [Deploying Nebari on Digital Ocean][nebari-do]
- [Deploying Nebari on GCP][nebari-gcp]

<!-- Internal links -->

[nebari-aws]: /how-tos/nebari-aws.md
[nebari-azure]: /how-tos/nebari-azure.md
[nebari-do]: /how-tos/nebari-do.md
[nebari-gcp]: /how-tos/nebari-gcp.md
[nebari-local]: /how-tos/nebari-local.md
[nebari-deploy]: /get-started/deploy.mdx
Expand Down
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 @@ -98,7 +98,6 @@ Already made your mind about deployment? Check our handy how-to-guides:

- [Deploying Nebari on AWS][nebari-aws]
- [Deploying Nebari on Azure][nebari-azure]
- [Deploying Nebari on Digital Ocean][nebari-do]
- [Deploying Nebari on GCP][nebari-gcp]
- [Deploying Nebari on a local cluster][nebari-local]- using [`kind`](https://kind.sigs.k8s.io/) no cloud required

Expand All @@ -107,7 +106,6 @@ Already made your mind about deployment? Check our handy how-to-guides:
[advanced-configuration]: /explanations/advanced-configuration.md
[nebari-aws]: /how-tos/nebari-aws.md
[nebari-azure]: /how-tos/nebari-azure.md
[nebari-do]: /how-tos/nebari-do.md
[environment-management]: /how-tos/nebari-environment-management.md
[nebari-extension-system]: /how-tos/nebari-extension-system.md
[nebari-gcp]: /how-tos/nebari-gcp.md
Expand Down
18 changes: 0 additions & 18 deletions docs/docs/get-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,25 +79,7 @@ nebari init aws --project projectname \
```

</TabItem>
<TabItem value="do" label="Digital Ocean" default>

Provide authentication credentials to Nebari by setting the following environment variables:

```bash
export DIGITALOCEAN_TOKEN="" # API token required to generate resources
export SPACES_ACCESS_KEY_ID="" # public access key for access spaces
export SPACES_SECRET_ACCESS_KEY="" # the private key for access spaces
```

Create `nebari-config.yaml` with:

```bash
nebari init do --project projectname \
--domain domain \
--auth-provider password
```

</TabItem>
<TabItem value="azure" label="Azure" default>

Provide authentication credentials to Nebari by setting the following environment variables:
Expand Down
13 changes: 0 additions & 13 deletions docs/docs/how-tos/debug-nebari.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,21 +73,8 @@ Finally, you can generate the `kubeconfig` which will be used by k9s:
```bash
gcloud container clusters get-credentials <project-name>-<namespace> --region <region>
```

</TabItem>

<TabItem value="do" label="Digital Ocean">

For [DigitalOcean](https://docs.digitalocean.com/products/kubernetes/),
you'll need to have the
[doctl](https://docs.digitalocean.com/reference/doctl/how-to/install/) tool
(the Digital Ocean CLI) installed. The command to update your `kubeconfig` for DO is:

```bash
doctl kubernetes cluster kubeconfig save <project-name>-<namespace>
```

</TabItem>

<TabItem value="aws" label="Amazon AWS">

Expand Down
3 changes: 1 addition & 2 deletions docs/docs/how-tos/domain-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Take IP Address 12.312.312.312 and update DNS to point to "your.domain" [Press E
Once the IP is generated, you will need to grab it and create the necessary records within the DNS provider of your choice. Setting a DNS record heavily depends on your provider, so an internet search for A/CNAME record for your specific provider should yield helpful results.

:::note
During the initial deployment, Digital Ocean, GCP, and Azure will display an "IP" address, that you can use to set the A record.
During the initial deployment, GCP and Azure will display an "IP" address, that you can use to set the A record.
Whereas, AWS will display a "hostname" that you can use to set the CNAME record.
:::

Expand Down Expand Up @@ -77,7 +77,6 @@ Below are the links to detailed documentation on how to create and manage DNS re
- [Cloud DNS](https://cloud.google.com/dns/docs/tutorials/create-domain-tutorial) provider
- [Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-register.html) DNS provider
- [Azure DNS](https://docs.microsoft.com/en-us/azure/dns/dns-getstarted-portal) provider
- [Digital Ocean DNS](https://docs.digitalocean.com/products/networking/dns/quickstart/) provider

:::note
Once your new DNS domain is created, it might take time for the records and related certificates to fully propagate.
Expand Down
6 changes: 1 addition & 5 deletions docs/docs/how-tos/manual-backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ apt install curl -y
apt install unzip -y
```

For AWS, you need to install the CLI (see CLI instructions for Google, Azure, Digital Ocean below):
For AWS, you need to install the CLI (see CLI instructions for Google and Azure below):

```shell
curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
Expand Down Expand Up @@ -203,10 +203,6 @@ export AZCOPY_AUTO_LOGIN_TYPE=AZCLI
azcopy copy "https://[account].blob.core.windows.net/[container]/nebari-backups/2021-04-23.tar" "./2021-04-23.tar"
```

### Digital Ocean

Instructions will be similar to those for AWS above, but use Digital Ocean spaces instead of S3. For more information on command-line tool, check out the [documentation for Digital Ocean Spaces](https://www.digitalocean.com/community/tutorials/how-to-migrate-from-amazon-s3-to-digitalocean-spaces-with-rclone)

## JupyterHub Database

The JupyterHub database will mostly be recreated whenever you start a new cluster, but should be backed up to save Dashboard configurations.
Expand Down
18 changes: 0 additions & 18 deletions docs/docs/how-tos/nebari-destroy.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,24 +139,6 @@ az group delete --resource-group "<project-name>-<namespace>"

Or if you'd prefer, you can destroy the resource group from the Azure portal, [follow these instructions](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#delete-resource-groups).

### Digital Ocean

If you deployed your Nebari cluster on Digital Ocean and the `nebari destroy` command failed, you will need to destroy two resources, the Kubernetes cluster (DOKS) and the S3 bucket (a Digital Ocean resource, not AWS).

Digital Ocean offers an S3-compatible cloud object storage and requires the use of the [`aws` CLI](https://aws.amazon.com/cli/) to destroy it.

```bash
aws s3 rb s3://<project-name>-<namespace>-terraform-state --force --endpoint=https://<region>.digitaloceanspaces.com
```

Finally, you will need to destroy the Kubernetes cluster with [Digital Ocean's CLI tool, `doctl`](https://docs.digitalocean.com/reference/doctl/).

```bash
doctl kubernetes cluster delete <project-name>-<namespace> -f
```

Or, if you wish to destroy your Digital Ocean resources from the Digital Ocean control panel and follow these instructions to destroy your [Kubernetes cluster](https://docs.digitalocean.com/products/kubernetes/how-to/destroy-clusters/) and these instructions to destroy the associated [space (i.e. S3)](https://docs.digitalocean.com/products/spaces/how-to/destroy/).

### Google Cloud Platform (GCP)

If you deployed your Nebari cluster on GCP and the `nebari destroy` command failed, you will need to destroy two resources, the Kubernetes cluster (GKE) and cloud storage bucket (GCS).
Expand Down
Loading

0 comments on commit 53fae55

Please sign in to comment.