-
Notifications
You must be signed in to change notification settings - Fork 39
docs(software-packs): add catalog and stub pages #669
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
Open
khuyentran1401
wants to merge
14
commits into
main
Choose a base branch
from
docs/software-packs-catalog
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
0753546
docs(software-packs): add catalog and stub pages
khuyentran1401 29ba6dd
docs(software-packs): add concept explainer link
khuyentran1401 5f66a9c
docs(software-packs): group packs in subcategory
khuyentran1401 79ef4c4
docs(software-packs): simplify pack descriptions
khuyentran1401 6801e12
docs(software-packs): add skillsctl pack
khuyentran1401 f825e7e
docs(software-packs): refine pack descriptions
khuyentran1401 9281db8
docs(software-packs): document maturity levels
khuyentran1401 d560de6
Merge branch 'main' into docs/software-packs-catalog
khuyentran1401 68512ec
docs(software-packs): drop per-pack stub pages
khuyentran1401 ec197e9
Merge branch 'main' into docs/software-packs-catalog
khuyentran1401 8415e3b
docs(software-packs): clarify ArgoCD vs Helm install paths
khuyentran1401 05b2e3c
Merge branch 'main' into docs/software-packs-catalog
viniciusdc 751af29
Merge branch 'main' into docs/software-packs-catalog
dcmcand da9259b
Merge remote-tracking branch 'origin/main' into docs/software-packs-c…
khuyentran1401 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 was deleted.
Oops, something went wrong.
This file contains hidden or 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 |
|---|---|---|
| @@ -1,10 +1,59 @@ | ||
| --- | ||
| title: Software Packs | ||
| slug: /software-packs/ | ||
| description: A catalog of Software Packs you can install on a Nebari Kubernetes Platform cluster. | ||
| --- | ||
|
|
||
| :::note[Coming soon] | ||
| # Software Packs | ||
|
|
||
| Tracked in [#631](https://github.com/nebari-dev/nebari-docs/issues/631). | ||
| **[Software Packs](../explanations/software-packs.mdx) are the apps you install on Nebari.** Browse the catalog and pick the capabilities your team needs: dashboards, model serving, chat assistants, document analysis, and more. Every pack plugs into Nebari's single sign-on, routing, and TLS automatically, so users reach them through one secure entry point. | ||
|
|
||
| ::: | ||
| ## Installing a pack | ||
|
|
||
| To install any pack: | ||
|
|
||
| 1. Make sure your Nebari cluster is up and running. | ||
| 2. Install the pack. Every pack's README documents the exact steps; pick one of two paths: | ||
| - **Recommended:** add it to your gitops repo as a new ArgoCD Application that references the pack. ArgoCD then deploys it onto your cluster. | ||
| - **Alternative:** install the pack's chart manually with Helm. | ||
| 3. Open your cluster's landing page; the new capability appears there once it finishes installing. | ||
|
|
||
| ## Official packs | ||
|
|
||
| Packs maintained by OpenTeams and listed in the central Nebari registry. Each pack declares a maturity level. See [How packs mature](#how-packs-mature) below for definitions, and the [pack dashboard](https://github.com/nebari-dev/software-pack-dashboard) for the current level of each pack. | ||
|
|
||
| | Pack | Description | Source | | ||
| | --- | --- | --- | | ||
| | Chat | A team chat app with customizable AI agents, ready to use behind your Nebari single sign-on. | [nebari-chat-pack](https://github.com/nebari-dev/nebari-chat-pack) | | ||
| | Data Science | JupyterHub with room to publish interactive apps alongside notebooks, behind your Nebari single sign-on. | [nebari-data-science-pack](https://github.com/nebari-dev/nebari-data-science-pack) | | ||
| | LGTM Observability | Grafana's LGTM stack (Loki, Grafana, Tempo, Mimir) for logs, metrics, traces, and dashboards on your Nebari cluster. | [nebari-lgtm-pack](https://github.com/nebari-dev/nebari-lgtm-pack) | | ||
| | LLM Serving | A managed API for running large language models on your cluster, with per-model access control and rate limits. | [nebari-llm-serving-pack](https://github.com/nebari-dev/nebari-llm-serving-pack) | | ||
| | Longhorn Backup | Hourly snapshots and daily off-site S3 backups for every volume on your cluster's default storage. | [nebari-longhorn-backup-pack](https://github.com/nebari-dev/nebari-longhorn-backup-pack) | | ||
| | MLflow | Experiment tracking and a model registry for your ML team, with Nebari single sign-on. | [nebari-mlflow-pack](https://github.com/nebari-dev/nebari-mlflow-pack) | | ||
| | Nebi | Shared, reproducible Python and data science environments managed from a single CLI. | [nebari-nebi-pack](https://github.com/nebari-dev/nebari-nebi-pack) | | ||
| | Pi Coding Agent | AI-assisted coding inside your team's JupyterHub notebook sessions. | [nebari-pi-coding-agent-pack](https://github.com/nebari-dev/nebari-pi-coding-agent-pack) | | ||
| | Provenance Collector | A compliance scanner that proves what's running on your cluster and where each piece came from. | [nebari-provenance-collector-pack](https://github.com/nebari-dev/nebari-provenance-collector-pack) | | ||
| | Ray Serve | Distributed serving for ML models and Python apps, with autoscaling built in. | [nebari-rayserve-pack](https://github.com/nebari-dev/nebari-rayserve-pack) | | ||
| | skillsctl | A CLI and registry for discovering, installing, and publishing Claude Code skills on your Nebari cluster. | [skillsctl](https://github.com/nebari-dev/skillsctl) | | ||
| | Superset | BI dashboards and ad-hoc data exploration through a web UI, behind your Nebari single sign-on. | [nebari-superset-pack](https://github.com/nebari-dev/nebari-superset-pack) | | ||
|
|
||
| All packs above are maintained by [nebari-dev](https://github.com/nebari-dev) and are considered **official**. | ||
|
|
||
| ### How packs mature | ||
|
|
||
| A pack's level reflects how stable, tested, and supported it is. | ||
|
|
||
| | Level | What you can expect | Intended for | | ||
| | ------------- | ------------------------------------------------------------------------- | ------------------ | | ||
| | Experimental | May not install or work; can disappear at any time | Contributors only | | ||
| | Alpha | Happy path works on a current dev cluster; limitations documented | Internal demos | | ||
| | Beta | Stable enough for a pilot with engineering support; APIs may still shift | Customer pilots | | ||
| | GA (v1.0+) | Fully supported, with a documented upgrade and security-fix story | Production | | ||
|
|
||
| A pack at any level can also be marked **Deprecated**, with a sunset date (when it will be retired) and a migration path. Avoid new deployments. | ||
|
|
||
| ## Community packs | ||
|
|
||
| A **community pack** is a Software Pack maintained outside OpenTeams. It follows the same structure as an official pack and can be installed on any Nebari cluster. | ||
|
|
||
| Want to share your pack with the Nebari community? See [Build your own pack](./build-your-own.mdx) to get started. | ||
Oops, something went wrong.
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 part is not entirely true unfortuanatedly, for a pack to show up in the landing page it needs to support it already trough its nebari contract CRD (nebariApp), specificaly needs to have the nebariLanding fields populated:
example from https://github.com/nebari-dev/nebari-landing/blob/main/dev/manifests/test-nebariapps.yaml#L14-L25