-
Notifications
You must be signed in to change notification settings - Fork 97
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README to include comprehensive local deploy, test, and build steps #2346
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -151,6 +151,75 @@ To install the latest developer version (unstable) use: | |
pip install git+https://github.com/nebari-dev/nebari.git | ||
``` | ||
|
||
### ⚙️⚙️⚙️ Deploying, Testing, and Packaging a Local Nebari Repo ⚙️⚙️⚙️ | ||
Tested on Debian 12 | ||
#### Prereqs: | ||
Docker: https://docs.docker.com/engine/install/debian/#install-using-the-repository | ||
``` | ||
sudo usermod -aG docker $USER # add current user to docker group | ||
sudo systemctl start docker | ||
``` | ||
|
||
conda: https://docs.anaconda.com/free/anaconda/install/linux/#installation | ||
|
||
git: | ||
``` | ||
apt-get install git | ||
``` | ||
|
||
#### Clone Nebari repo: | ||
``` | ||
git clone [email protected]:nebari-dev/nebari.git | ||
cd nebari | ||
``` | ||
|
||
#### Create a conda environment to build, deploy, and test Nebari: | ||
``` | ||
conda create -n nebari0 | ||
conda activate nebari0 | ||
conda install python==3.12 pip # or python version of your choice | ||
``` | ||
|
||
#### Test local Nebari repo: | ||
From within the local Nebari repo directory: | ||
``` | ||
pip install -e . | ||
``` | ||
|
||
Create a nebari-config.yaml that targets a local kind cluster | ||
``` | ||
nebari init local --project local-dev --domain example.local --ssl-cert-email [your@email] | ||
``` | ||
|
||
Add to hosts file specific resolutions for .local domains specified above | ||
``` | ||
echo -e "\n172.18.1.100 local-dev.example.local\n172.18.1.100" example.local\n | sudo tee -a /etc/hosts | ||
``` | ||
|
||
Deploy Nebari locally (as specified in the yaml file) | ||
``` | ||
nebari deploy -c nebari-config.yaml | ||
``` | ||
|
||
Run tests against deployed Nebari | ||
``` | ||
pip install python-dotenv # needed for tests | ||
pytest tests/tests_deployment | ||
``` | ||
|
||
#### Build & package Nebari: | ||
use pip to install further dependencies within the above environment: | ||
``` | ||
pip install pytest-playwright build grayskull | ||
playwright install | ||
``` | ||
From within the local Nebari repo directory: | ||
``` | ||
python -m build ./ --outdir ./build-temp/ | ||
grayskull pypi --strict-conda-forge build-temp/*.tar.gz --output ./build-temp/ | ||
conda build --channel=conda-forge ./build-temp/nebari | ||
``` | ||
|
||
### Questions? 🤔 | ||
|
||
Have a look at our [Frequently Asked Questions (FAQ)][nebari-faqs] to see if your query has been answered. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not always as simple (nebari-dev/nebari-docs#403).