Package: nebari
Your open source data science platform. Built for scale, designed for collaboration.InformationLinksProjectCommunityCITable of contentsTable of contentsNebariCloud Providers ☁️Installation 💻Pre-requisitesInstall NebariUsage 🚀Nebari HPCContributing to Nebari 👩🏻‍💻Installing the Development version of Nebari ⚙️Questions? 🤔Code of Conduct 📖Ongoing SupportLicense⚠️ Warning ⚠️The2023.10.1release includes the initial implementation of aPluggy-basedextension mechanism, for more details referhere.
This version also fully deprecates CDS Dashboards as it is no longer compatible with the newer versions of JupyterHub.
For more details on all of changes included in this release, please refer to ourrelease notes.
After you've installed version2023.10.1, you can update yournebari-config.yamlby runningnebari upgrade -c nebari-config.yaml, please
follow the upgrades instructions output by this command.
And please make sure toback up your data before attempting an upgrade.Automated data science platform. FromJupyterHubto Cloud environments withDask Gateway.Nebari is an open source data platform that enables users to build and maintain cost-effective and scalable compute platforms
onHPCorKuberneteswith minimal DevOps overhead.This repository details theNebari(Kubernetes) version.Not sure what to choose? Check out our documentation onchoosing a deployment platformNebariThe Kubernetes version of Nebari usesTerraform,Helm, andGitHub Actions.Terraform handles the build, change, and versioning of the infrastructure.Helm helps to define, install, and manageKubernetesresources.GitHub Actions is used to automatically create commits when the configuration file (nebari-config.yaml) is rendered,
as well as to kick off the deployment action.Nebari aims to abstract all these complexities for its users.
Hence, it is not necessary to know any of the technologies mentioned above to have your project successfully deployed.TLDR: If you know GitHub and feel comfortable generating and using API keys, you should have all it takes to deploy and maintain your system without the need for a dedicated
DevOps team. No need to learn Kubernetes, Terraform, or Helm.Cloud Providers ☁️Nebari offers out-of-the-box support for the major public cloud providers:Digital Ocean,
AmazonAWS,GCP, and MicrosoftAzure.Installation 💻Pre-requisitesOperating System: Currently, Nebari supports development on macOS and Linux operating systems. Windows is NOT supported.
However, we would welcome contributions that add and improve support for Windows.You need Python >= 3.8 on your local machine or virtual environment to work on Nebari.Adopting virtual environments (conda,pipenvorvenv) is also encouraged.Install NebariTo install Nebari type the following commands in your command line:Install usingconda:condainstall-cconda-forgenebari# if you prefer using mambamambainstall-cconda-forgenebariInstall usingpip:pipinstallnebariOnce finished, you can check Nebari's version (and additional CLI arguments) by typing:nebari--helpIf successful, the CLI output will be similar to the following:usage:nebari[-h][-v]{deploy,destroy,render,init,validate}...

Nebaricommandline

positionalarguments:{deploy,destroy,render,init,validate}Nebari

optionalarguments:-h,--helpshowthishelpmessageandexit-v,--versionNebariversionUsage 🚀Nebari requires setting multiple environment variables to automate the deployments fully.
For details on obtaining those variables, check theNebari Get started documentation.Once all the necessary credentials are gathered and set asUNIX environment variables, Nebari can be
deployed in minutes.For detailed step-by-step instructions on how to deploy Nebari, check theNebari documentation.Nebari HPCAn HPC version of Nebari is currently not available. There is one under development for Nebari's precursor QHub.
Curious? Check out theQHub HPCrepository.Contributing to Nebari 👩🏻‍💻Thinking about contributing? Check out ourContribution Guidelinesto get started.Installing the Development version of Nebari ⚙️To install the latest developer version (unstable) use:pipinstallgit+https://github.com/nebari-dev/nebari.gitQuestions? 🤔Have a look at ourFrequently Asked Questions (FAQ)to see if your query has been answered.Getting help:GitHub Discussionsis our user forum. It can be used to raise discussions about a subject,
such as: "What is the recommended way to doXwith Nebari?"Issuesfor queries, bug reporting, feature requests, documentation, etc.We work around the clock to make Nebari better, but sometimes your query might take a while to get a reply. We
apologize in advance and ask you to please, be patient :pray:.Code of Conduct 📖To guarantee a welcoming and friendly community, we require all community members to follow ourCode of Conduct.Ongoing SupportIf you're using Nebari and would like professional support, please get in touch with the Nebari development team.LicenseNebari is BSD3 licensed.