Add NIC installation docs#649
Conversation
✅ Deploy Preview for nebari-docs2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| Ensure this location in on your user PATH with `echo $PATH`. | ||
| If not, you can add it to PATH with `export PATH=$PATH:/path/to/dir`. | ||
|
|
||
| :::info[MacOS verification error] |
There was a problem hiding this comment.
I ran into this error, so added a workaround. Ideally, this should not be required, and the installation is streamlined. I can open a separate issue on the nic repo.
There was a problem hiding this comment.
Agreed, the workaround makes sense to keep here for now. Could you drop the NIC issue link in this thread once it's open, so we know when to remove this callout?
|
|
||
| # Install NIC | ||
|
|
||
| Nebari Infrastructure Core (NIC) provisions a production-grade platform (Kubernetes cluster). |
There was a problem hiding this comment.
This intro is not strictly required, but I think it's useful to provide some context around why installing this particular library is the first step.
There was a problem hiding this comment.
I had to pause on this sentence. The parenthetical made it hard to tell whether "production-grade platform" and "Kubernetes cluster" are the same thing or two different things. Could we spell out the layering, e.g. "Nebari Infrastructure Core (NIC) is a CLI that sets up a production-grade Kubernetes cluster and installs the platform essentials that run on top of it."?
| Extract the tarball: | ||
|
|
||
| ```sh | ||
| tar -xzf nic_v0.2.0_xyz.tar.gz |
There was a problem hiding this comment.
The nic_v0.2.0_xyz.tar.gz example doesn't match what's on the releases page. The actual assets follow nebari-infrastructure-core_0.3.0_darwin_arm64.tar.gz. Could we use a real filename here so users can map it back?
| # Install NIC | ||
|
|
||
| Nebari Infrastructure Core (NIC) provisions a production-grade platform (Kubernetes cluster). | ||
| It is the foundational layer of the Nebari ecosystem, that includes platform essentials like authentication (SSO), user management, observability, TLS certification, and more. You can set up software packs (like the data science pack with specific tools like JupyterLab) on top of this layer. |
There was a problem hiding this comment.
The NIC summary and README both describe the Data Science Pack as "JupyterHub and conda-store". JupyterHub is the user-facing tool (it serves JupyterLab to each user), so I think "JupyterHub" would be a touch more accurate as the example here. Small thing.
| sudo mv nic /usr/local/bin/ | ||
| ``` | ||
|
|
||
| Ensure this location in on your user PATH with `echo $PATH`. |
There was a problem hiding this comment.
| Ensure this location in on your user PATH with `echo $PATH`. | |
| Ensure this location is on your user PATH with `echo $PATH`. |
|
|
||
| # Install NIC | ||
|
|
||
| Nebari Infrastructure Core (NIC) provisions a production-grade platform (Kubernetes cluster). |
There was a problem hiding this comment.
I had to pause on this sentence. The parenthetical made it hard to tell whether "production-grade platform" and "Kubernetes cluster" are the same thing or two different things. Could we spell out the layering, e.g. "Nebari Infrastructure Core (NIC) is a CLI that sets up a production-grade Kubernetes cluster and installs the platform essentials that run on top of it."?
| Extract the tarball: | ||
|
|
||
| ```sh | ||
| tar -xzf nic_v0.2.0_xyz.tar.gz |
There was a problem hiding this comment.
| tar -xzf nic_v0.2.0_xyz.tar.gz | |
| tar -xzf nebari-infrastructure-core_0.3.0_darwin_arm64.tar.gz |
| Ensure this location in on your user PATH with `echo $PATH`. | ||
| If not, you can add it to PATH with `export PATH=$PATH:/path/to/dir`. | ||
|
|
||
| :::info[MacOS verification error] |
There was a problem hiding this comment.
Agreed, the workaround makes sense to keep here for now. Could you drop the NIC issue link in this thread once it's open, so we know when to remove this callout?
2 participants
Reference Issues or PRs
Closes #646
What does this implement/fix?
Documentation Update
Acceptance criteria
Testing
Access-centered content checklist
Text styling
H1or#in markdown).Non-text content