Skip to content

Commit 49cf488

Browse files
committed
add file back and reword it so its clear this is directed at platform setup
1 parent aec4384 commit 49cf488

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
id: nebari-environment-management
3+
title: Setup Environment for Deployment
4+
description: Best Practices for Managing Your Python Environment
5+
---
6+
7+
# Nebari Deployment Python Environment Setup
8+
9+
To configure and deploy the Nebari platform, you'll first need to set up your python environment.
10+
11+
Nebari configuration and deployment is highly dependent on the version of the Nebari CLI that you have active when you run `nebari` commands. A such, we highly recommend [installing Conda](https://docs.anaconda.com/free/anaconda/install/) for managing isolated Python environments, especially when working on more than one Nebari deployment from the same machine or using [Nebari extensions][nebari-extension-system].
12+
13+
Once installed, you can use [manage environments](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#managing-environments) in different ways.
14+
15+
This is a simple way to set up a new Conda environment named `nebari0` with a specific Nebari version and exactly one extension installed. This `nebari0` environment will store all of our packages, including those installed with `pip` because *when **pip** is installed into an active conda environment, packages which are then installed with pip will not be saved in the global namespace*. This especially critical when working with extensions, because `nebari` will detect and apply any extensions installed in your Python environment when it runs.
16+
17+
```
18+
conda create -n nebari0
19+
conda activate nebari0
20+
conda install python==3.12 pip # or python version of your choice
21+
pip install nebari==2024.1.1
22+
# Example plugin that can also be installed
23+
pip install nebari-plugin-self-registration==0.0.9
24+
```
25+
26+
<!-- internal links -->
27+
28+
[nebari-extension-system]: /how-tos/nebari-extension-system.md

docs/sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ module.exports = {
6262
"how-tos/nebari-kubernetes",
6363
"how-tos/nebari-local",
6464
"how-tos/nebari-stages-directory",
65+
"how-tos/nebari-environment-management",
6566
"how-tos/nebari-destroy",
6667
"how-tos/domain-registry",
6768
"how-tos/debug-nebari",

0 commit comments

Comments
 (0)