From aaff8954539ad76f118d51a46e39665f58723b0f Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 7 Aug 2024 11:18:35 -0500 Subject: [PATCH 1/5] Remove `domain` for testing setup Related: https://github.com/nebari-dev/nebari/issues/2555 Thanks @vinicusdc for the suggestion https://github.com/nebari-dev/nebari/issues/2555#issuecomment-2272052705 --- docs/docs/how-tos/nebari-local.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/docs/how-tos/nebari-local.md b/docs/docs/how-tos/nebari-local.md index 15335b4a..110e3fd5 100644 --- a/docs/docs/how-tos/nebari-local.md +++ b/docs/docs/how-tos/nebari-local.md @@ -159,6 +159,14 @@ security: tag: sha-b4a2d1e ``` +### Disable DNS for local deployment + +If you are deploying locally, DNS is not necessary except for dask dashboard and the notebook +scheduler extension. Therefore it is recommended to simply delete the `domain` line from the +`nebari-config.yaml`. + +If you prefer to setup DNS, see the [domain-registry documentation](https://www.nebari.dev/docs/how-tos/domain-registry#what-is-a-dns). + ## Deploying Nebari With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time with: From c43d203a6b568963c86171523166cc35e8f29d57 Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Wed, 7 Aug 2024 20:09:13 -0500 Subject: [PATCH 2/5] Feedback from @viniciusdc --- docs/docs/how-tos/nebari-local.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/docs/how-tos/nebari-local.md b/docs/docs/how-tos/nebari-local.md index 110e3fd5..59bf948e 100644 --- a/docs/docs/how-tos/nebari-local.md +++ b/docs/docs/how-tos/nebari-local.md @@ -73,6 +73,11 @@ The following steps assume you have: Note You will be prompted to enter values for some of the choices above if they are absent from the command line arguments (for example, project name and domain) ::: +:::note +If you are deploying locally, DNS is not necessary except for dask dashboard and the notebook +scheduler extension. Therefore for test deployments it is recommended leave out the `--domain` option. +::: + Once `nebari init` is executed, you should then be able to see the following output: ```bash @@ -124,6 +129,8 @@ If you are a Linux user, you can use the `sudo` command to gain root privileges sudo echo "172.18.1.100 " | sudo tee -a /etc/hosts ``` +See the [domain-registry documentation](https://www.nebari.dev/docs/how-tos/domain-registry#what-is-a-dns) for details. + ::: ### Exposing container network (for MacOS) @@ -159,14 +166,6 @@ security: tag: sha-b4a2d1e ``` -### Disable DNS for local deployment - -If you are deploying locally, DNS is not necessary except for dask dashboard and the notebook -scheduler extension. Therefore it is recommended to simply delete the `domain` line from the -`nebari-config.yaml`. - -If you prefer to setup DNS, see the [domain-registry documentation](https://www.nebari.dev/docs/how-tos/domain-registry#what-is-a-dns). - ## Deploying Nebari With the `nebari-config.yaml` configuration file now created, Nebari can be deployed for the first time with: From ee55461c08adb4898ea7275380e37f1a753477fd Mon Sep 17 00:00:00 2001 From: Austin Macdonald Date: Thu, 26 Sep 2024 11:20:52 -0500 Subject: [PATCH 3/5] Add suggestion from @viniciusdc code review --- docs/docs/how-tos/nebari-local.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/docs/how-tos/nebari-local.md b/docs/docs/how-tos/nebari-local.md index 59bf948e..58d5caf2 100644 --- a/docs/docs/how-tos/nebari-local.md +++ b/docs/docs/how-tos/nebari-local.md @@ -74,8 +74,7 @@ Note You will be prompted to enter values for some of the choices above if they ::: :::note -If you are deploying locally, DNS is not necessary except for dask dashboard and the notebook -scheduler extension. Therefore for test deployments it is recommended leave out the `--domain` option. +If you are deploying for testing purposes, omitting the `--domain` option is recommended to prevent issues related to setting up a DNS domain for your deployment. Nebari will return the external IP associated with the Kubernetes cluster's load balancer by default. ::: Once `nebari init` is executed, you should then be able to see the following output: From 84986197211e43195f877310578c05dd4cef34dc Mon Sep 17 00:00:00 2001 From: "Vinicius D. Cerutti" <51954708+viniciusdc@users.noreply.github.com> Date: Fri, 1 Nov 2024 11:13:58 -0300 Subject: [PATCH 4/5] small suggestion refactor --- docs/docs/how-tos/nebari-local.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/how-tos/nebari-local.md b/docs/docs/how-tos/nebari-local.md index 58d5caf2..5e643fee 100644 --- a/docs/docs/how-tos/nebari-local.md +++ b/docs/docs/how-tos/nebari-local.md @@ -74,7 +74,7 @@ Note You will be prompted to enter values for some of the choices above if they ::: :::note -If you are deploying for testing purposes, omitting the `--domain` option is recommended to prevent issues related to setting up a DNS domain for your deployment. Nebari will return the external IP associated with the Kubernetes cluster's load balancer by default. +If you are deploying for testing purposes, omitting the `--domain` option is recommended to prevent issues related to setting up a DNS domain for your deployment. By default, at the end of your deployment, Nebari will return the external IP associated with the Kubernetes cluster's load balancer. ::: Once `nebari init` is executed, you should then be able to see the following output: From a866c45b58ca958ba495fe100942a2ce1737f6b4 Mon Sep 17 00:00:00 2001 From: vinicius douglas cerutti Date: Tue, 7 Jan 2025 14:31:20 -0300 Subject: [PATCH 5/5] address format CI --- docs/docs/how-tos/nebari-local.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/how-tos/nebari-local.md b/docs/docs/how-tos/nebari-local.md index 436d99a1..41b650ad 100644 --- a/docs/docs/how-tos/nebari-local.md +++ b/docs/docs/how-tos/nebari-local.md @@ -74,7 +74,7 @@ Note You will be prompted to enter values for some of the choices above if they ::: :::note -If you are deploying for testing purposes, omitting the `--domain` option is recommended to prevent issues related to setting up a DNS domain for your deployment. By default, at the end of your deployment, Nebari will return the external IP associated with the Kubernetes cluster's load balancer. +If you are deploying for testing purposes, omitting the `--domain` option is recommended to prevent issues related to setting up a DNS domain for your deployment. By default, at the end of your deployment, Nebari will return the external IP associated with the Kubernetes cluster's load balancer. ::: Once `nebari init` is executed, you should then be able to see the following output: