Skip to content

Commit 2cc45bb

Browse files
authored
Merge branch 'main' into update-release-guides
2 parents cfe9fd8 + 3d56ac2 commit 2cc45bb

34 files changed

+163
-433
lines changed

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ body:
2828
options:
2929
- label: "This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions"
3030
required: true
31+
3132
- type: textarea
3233
validations:
3334
required: true
@@ -37,19 +38,6 @@ body:
3738
What problem(s) did you run into that caused you to request a fix to the documentation or additional
3839
documentation? What questions do you think we should answer?
3940
40-
- type: textarea
41-
validations:
42-
required: true
43-
attributes:
44-
label: Steps to Resolve this Issue
45-
description: |
46-
How can the problem be solved? Are there any additional steps required? Do any other pages need to be updated?
47-
value: |
48-
1.
49-
2.
50-
3.
51-
...
52-
5341
- type: markdown
5442
attributes:
5543
value: >

.github/workflows/test-website.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
run: echo "::set-output name=dir::$(yarn cache dir)"
2020

2121
- name: Cache dependencies 🧪
22-
uses: actions/cache@v2
22+
uses: actions/cache@v4
2323
id: yarn-cache
2424
with:
2525
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ci:
1717
repos:
1818
# Codespell: Spell checks the code and documentation
1919
- repo: https://github.com/codespell-project/codespell
20-
rev: v2.3.0
20+
rev: v2.4.1
2121
hooks:
2222
- id: codespell
2323
entry: codespell

docs/community/nebari-tests.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ To test on cloud Kubernetes, deploy Nebari in the normal way on the cloud, but m
9191
- [Use a development branch](#use-a-development-branch) to specify the Docker images based on the latest development code in `nebari-config.yaml`.
9292

9393
:::warning
94-
Testing your contribution by deploying Nebari on the cloud (AWS, GCP, Azure, and Digital Ocean) can consume a lot of time and resources.
94+
Testing your contribution by deploying Nebari on the cloud (AWS, GCP, and Azure) can consume a lot of time and resources.
9595
Always prefer local testing when possible.
9696
It will be easier to debug, may be quicker to deploy, and is likely to be less expensive.
9797
:::

docs/docs/explanations/advanced-configuration.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,6 @@ domain: demo.nebari.dev
265265

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

268-
- `do` for DigitalOcean
269268
- `aws` for Amazon Web Services
270269
- `gcp` for Google Could Provider
271270
- `azure` for Microsoft Azure
@@ -316,7 +315,7 @@ The CI/CD workflow that is best for you will depend on your organization, but th
316315
- 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.
317316

318317
:::note
319-
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/).
318+
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/).
320319
:::
321320

322321
### Certificates

docs/docs/explanations/advanced-profiles-settings.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,27 @@ Profiles are used to control the JupyterLab user instances and Dask workers prov
1515
profiles:
1616
jupyterlab:
1717
- display_name: Small Instance
18-
description: Stable environment with 1 cpu / 1 GB ram
18+
description: Stable environment with 2 cpu / 8 GB ram
1919
access: all
2020
default: true
21+
profile_options: # optional
22+
image:
23+
display_name: Image
24+
choices:
25+
default:
26+
display_name: nebari-jupyterlab:latest
27+
default: true
28+
kubespawner_override:
29+
image: quay.io/nebari/nebari-jupyterlab:latest
30+
custom:
31+
display_name: my-custom-image:mytag
32+
kubespawner_override:
33+
image: <my-container-registry>/myOrg/my-custom-image:mytag
2134
kubespawner_override:
22-
cpu_limit: 1
23-
cpu_guarantee: 1
24-
mem_limit: 1G
25-
mem_guarantee: 1G
35+
cpu_limit: 2
36+
cpu_guarantee: 1.5
37+
mem_limit: 8G
38+
mem_guarantee: 6G
2639
- display_name: Medium Instance
2740
...
2841
```
@@ -35,6 +48,8 @@ Each profile under `jupyterlab` is a named JupyterLab profile.
3548

3649
`description` is a description of the profile that will be displayed to users.
3750

51+
`profile_options` makes it possible to set various sub-options per profile. See the [Kubespawner docs](https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html#kubespawner.KubeSpawner.profile_list) for more info.
52+
3853
`kubespawner_override` field to define behavior as per the [KubeSpawner](https://jupyterhub-kubespawner.readthedocs.io/en/latest/spawner.html) API.
3954

4055
It is possible to control which users have access to which JupyterLab profiles. Each profile has a field named `access` which can be set to `all` (default if omitted), `yaml`, or

docs/docs/explanations/advanced-provider-configuration.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -226,37 +226,6 @@ azure:
226226
227227
</TabItem>
228228
229-
<TabItem value="do" label="DigitalOcean">
230-
231-
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.
232-
In addition, Digital Ocean doesn't have accelerator/gpu support.
233-
234-
Digital Ocean is a good choice for trying out Nebari, but we recommend selecting a different provider for your production Nebari deployment.
235-
236-
To see available instance types refer to [Digital Ocean Instance Types](https://www.digitalocean.com/docs/droplets/).
237-
Additionally the Digital Ocean cli `doctl` has [support for listing droplets](https://www.digitalocean.com/docs/apis-clis/doctl/reference/compute/droplet/list/).
238-
239-
```yaml
240-
digital_ocean:
241-
region: nyc3
242-
kubernetes_version: "1.21.10-do.0"
243-
node_groups:
244-
general:
245-
instance: "g-4vcpu-16gb"
246-
min_nodes: 1
247-
max_nodes: 1
248-
user:
249-
instance: "g-2vcpu-8gb"
250-
min_nodes: 1
251-
max_nodes: 5
252-
worker:
253-
instance: "g-2vcpu-8gb"
254-
min_nodes: 1
255-
max_nodes: 5
256-
```
257-
258-
</TabItem>
259-
260229
<TabItem value="existing" label="Existing Kubernetes clusters">
261230
262231
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.
@@ -318,7 +287,6 @@ local:
318287
:::note
319288
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.
320289
This is _completely optional_ as Nebari will, by default, select the most recent version available for your preferred cloud provider:
321-
[Digital Ocean](https://docs.digitalocean.com/products/kubernetes/changelog/);
322290
[Google Cloud Platform](https://cloud.google.com/kubernetes-engine/docs/release-notes-stable);
323291
[Amazon Web Services](https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html);
324292
[Microsoft Azure](https://docs.microsoft.com/en-us/azure/aks/supported-kubernetes-versions?tabs=azure-cli).

docs/docs/explanations/architecture.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,7 @@ import TabItem from '@theme/TabItem';
5252
![GCP Architecture Diagram](/img/explanations/architecture-diagram-gcp.png)
5353

5454
</TabItem>
55-
<TabItem value="do" label="Digital Ocean">
5655

57-
![DO Architecture Diagram](/img/explanations/architecture-diagram-do.png)
58-
59-
</TabItem>
6056
<TabItem value="aws" label="Amazon AWS">
6157

6258
![AWS Architecture Diagram](/img/explanations/architecture-diagram-aws.png)

docs/docs/faq.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ If you'd like to retain the latest version of an environment and only remove spe
4848
## How do I use preemptible and spot instances on Nebari?
4949

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

@@ -84,10 +84,6 @@ Spot instances aren't supported at this moment.
8484
8585
Preemptible instances aren't supported at this moment.
8686
87-
##### Digital Ocean
88-
89-
Digital Ocean doesn't support these type of instances.
90-
9187
## Why doesn't my code recognize the GPU(s) on Nebari?
9288
9389
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.

docs/docs/get-started/cloud-providers.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,8 @@ import TabItem from '@theme/TabItem';
3636
For detailed instructions on how to deploy Nebari on **GCP** visit the [How to deploy Nebari on GCP][nebari-gcp] section.
3737

3838
</TabItem>
39-
<TabItem value="do" label="Digital Ocean">
4039

41-
<div class="text--center">
42-
<img src="/img/get-started/started-digital-ocean-logo.png" width={420} />
43-
</div>
44-
45-
[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.
4640

47-
For detailed instructions on how to deploy Nebari on **Digital Ocean** visit the [How to deploy Nebari on Digital Ocean][nebari-do] section.
48-
49-
</TabItem>
5041
<TabItem value="aws" label="Amazon AWS">
5142

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

7667
[nebari-aws]: /how-tos/nebari-aws.md
7768
[nebari-azure]: /how-tos/nebari-azure.md
78-
[nebari-do]: /how-tos/nebari-do.md
7969
[nebari-gcp]: /how-tos/nebari-gcp.md
8070
[nebari-local]: /how-tos/nebari-local.md
8171
[nebari-how-tos]: /how-tos/index.mdx

0 commit comments

Comments
 (0)