Skip to content

Commit a91bfd6

Browse files
authored
Update jhub apps related docs (#490)
* update jhub apps images and text * update default value of app launcher
1 parent c75d2a9 commit a91bfd6

File tree

9 files changed

+49
-45
lines changed

9 files changed

+49
-45
lines changed

docs/docs/how-tos/jhub-app-launcher.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,14 @@ description: Using JHub App Launcher with Nebari
66

77
# JHub App Launcher with Nebari
88

9-
[JHub App Launcher](https://github.com/nebari-dev/jhub-apps) is a generalized server launcher
10-
for JupyterHub. You can use it to create and share apps using various frameworks like:
9+
[JHub App Launcher](https://jhub-apps.nebari.dev/) is a generalized server launcher
10+
for deploying web applications via JupyterHub. The App Launcher serves as the "home"
11+
page for Nebari - providing access to various Nebari services (e.g. JupyterLab, VS Code,
12+
conda-store) and access to deploy custom web apps.
13+
14+
![JHub App Launcher home screen](/img/how-tos/jhub_apps_home.png)
15+
16+
You can use it to create and share apps using various frameworks such as:
1117

1218
- Panel
1319
- Bokeh
@@ -16,9 +22,9 @@ for JupyterHub. You can use it to create and share apps using various frameworks
1622
- Voila
1723
- Gradio
1824
- JupyterLab
19-
- Generic Python Command
25+
- Any generic Python command
2026

21-
## Installation
27+
## Installation on Nebari
2228

2329
JHub App Launcher can be enabled on Nebari by adding the following in the
2430
`nebari-config.yml`:
@@ -29,12 +35,18 @@ jhub_apps:
2935
```
3036
3137
:::note
32-
JHub App Launcher is enabled by default in the Nebari after version
33-
[2023.12.1](https://github.com/nebari-dev/nebari/releases/tag/2023.12.1).
38+
JHub App Launcher is was integrated into Nebari in version
39+
[2023.12.1](https://github.com/nebari-dev/nebari/releases/tag/2023.12.1)
40+
and is not enabled by default.
3441
:::
3542
36-
## Environment
43+
## Usage
3744
38-
To be able to create apps using the JHub App Launcher in Nebari,
39-
you need to have `jhub-apps` and the corresponding framework (for example, `panel`)
40-
in your conda-store generated conda environment.
45+
Documentation on how to create apps is included in the
46+
[JHub Apps documentation](https://jhub-apps.nebari.dev/docs/category/create-apps).
47+
Deployed apps on Nebari will utilize environments from conda-store. All apps
48+
will need to include `jhsingle-native-proxy >= 0.8.2` in their environment along with
49+
other framework-specific dependencies. For example, deploying a `panel` app will
50+
require `panel` itself and additional tools for deploying `panel` apps such as
51+
`bokeh-root-cmd >= 0.1.2`. See the documentation for specific requirements on
52+
each framework.

docs/docs/tutorials/create-dashboard.md

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Quickly build and deploy a panel dashboard in Nebari
66

77
# Create, deploy, and share dashboards and apps
88

9-
Analyzing data with visualizations provides insights, and a dashboard stitches these insights into a meaningful story. There are many great open source dashboards tools out there that you can use to organize and display your data in an engaging and digestible way.
9+
Analyzing data with visualizations provides insights, and a dashboard stitches these insights into a meaningful story. There are many great open source dashboarding tools out there that you can use to organize and display your data in an engaging and digestible way.
1010

1111
In this tutorial, you'll learn how to create a new dashboard with [Panel](https://panel.holoviz.org/) within Nebari. You'll also learn how to share your newly created dashboard with other users using JHub App Launcher.
1212

@@ -19,15 +19,15 @@ Since, CDS Dashboards is deprecated, the documentation will be removed soon.
1919

2020
## Supported frameworks
2121

22-
This tutorials demonstrates a Panel dashboard built with HoloViews and Bokeh as the backend, but Nebari supports several other frameworks:
22+
This tutorial demonstrates a Panel dashboard built with HoloViews and Bokeh as the backend, but Nebari supports several other frameworks:
2323

2424
import Tabs from '@theme/Tabs';
2525
import TabItem from '@theme/TabItem';
2626

2727
<Tabs>
2828
<TabItem value="jhub-apps" label="JHub App Launcher" default>
2929

30-
JHub App launcher supports `Panel`, `Bokeh`, `Streamlit`, `Plotly Dash`, `Voila`, `Gradio`, `JupyterLab`, `Generic Python Command`.
30+
JHub App launcher supports `Panel`, `Bokeh`, `Streamlit`, `Plotly Dash`, `Voila`, `Gradio`, `JupyterLab`, and `Any generic Python command`.
3131

3232
</TabItem>
3333
<TabItem value="cds-dashboards" label="CDS Dashboards">
@@ -115,11 +115,7 @@ hover = HoverTool(tooltips=[("avg diameter", "@avg_diameter_inch"),
115115
combine_plot = plot_bar.opts(tools=[hover]) + plot_curve.opts(line_dash='dashed')
116116
117117
# creating a dashboard using panel
118-
dashboard = pn.template.BootstrapTemplate(
119-
site="About 🌳",
120-
title="Species and more",
121-
main=[combine_plot]
122-
).servable()
118+
pn.Row(combine_plot).servable()
123119
```
124120

125121
You can run all the cells in your notebook and view the Panel dashboard using the "Preview with Panel" button in the notebook toolbar:
@@ -129,30 +125,24 @@ You can run all the cells in your notebook and view the Panel dashboard using th
129125
This interactive feature of Panel makes it possible to rapidly prototype and iterate on dashboards.
130126
Feel free to add more plots or different styles to your plots!
131127

132-
## Deploy the dashboard with JHub App Launcher
128+
## Deploy the dashboard
133129

134-
1. In the Nebari Home Page (in the top navigation, `Nebari` -> `Hub Control Panel`) click on **"Create App"** to create a new web application for your dashboard.
135-
2. In the app creation interface, enter or select the following:
136-
- **Display Name** - Provide meaningful name for your application
137-
- **Description (optional)** - Add addition information about the application
138-
- **Thumbnail (optional)** - Choose a meaningful thumbnail for your application. The default thumbnail is the application framework's logo.
139-
- **Framework** - Select the framework used by your application. For this tutorial, select Panel.
140-
- **Filepath** - Path (from root in JupyterLab) to your application code file. For this tutorial, path to the Jupyter Notebook.
141-
- **Conda Environment** - Same [environment](#1-create-environment-and-notebook) used while developing your notebook/script which has `jhub-apps` and the corresponding framework.
142-
- **Spawner profile** - Instance type (i.e. machines with CPU/RAM/GPU resources) required for running your application.
143-
- **Allow Public Access** - Toggle to share the application with your team.
130+
<Tabs>
131+
<TabItem value="jhub-apps" label="JHub App Launcher" default>
144132

145-
<p align="center">
146-
<img src="/img/tutorials/jhub-apps-create-new-app.png" width="50%"/>
147-
</p>
133+
1. On the Nebari Home Page (from JupyterLab, click on the Nebari logo in the top right corner or go to `File` -> `Home`) click on **"Create App"** to create a new web application for your dashboard.
134+
2. Follow the [general instructions](https://jhub-apps.nebari.dev/docs/create-apps/general-app) from the JHub Apps documentation to fill out the `Create app` form.
135+
3. Click **Next**. You'll be redirected to the Spawner profile page. This page will allow you to select the server in which you want your app to run. These options will vary based on the setup of your Nebari deployment (which server types are available overall) and the permissions of your user (which server types you personally have access to).
136+
4. JHub App Launcher will deploy your app (which can take several minutes to complete) and automatically redirect you to it.
148137

149-
3. Click on **Submit**. JHub App Launcher deploy your app (which can take a few minutes to complete) and automatically redirect you to it.
138+
Your dashboard app will be available in the Nebari Home page, under "My Apps". If you allowed shared access, it will be available under "Shared Apps" for those with whom you have shared the app.
139+
140+
</TabItem>
150141

151-
Your dashboard app will be available in the Nebari Home page, under "My Apps". If you allowed public access, it will be available under "Shared Apps" for your team.
152142

153-
## Deploy and share the dashboard with CDS Dashboards (Nebari v2023.7.1 or earlier)
143+
<TabItem value="cds-dashboards" label="CDS Dashboard" default>
154144

155-
In this section, you'll use CDS Dashboards to publish and share your newly created `panel` dashboard.
145+
In this section, you'll use CDS Dashboards ((Nebari v2023.7.1 or earlier)) to publish and share your newly created `panel` dashboard.
156146

157147
:::warning
158148
CDS Dashboards has been deprecated in 2023.9.1. Nebari 2023.7.1 is the last release that support CDS Dashboards.
@@ -193,12 +183,15 @@ This will trigger the deployment of your dashboard, and you'll be presented with
193183

194184
If there are no errors encountered during this process, you will be automatically redirected to the dashboard!
195185

186+
</TabItem>
187+
</Tabs>
188+
196189
## Manage apps in Nebari
197190

198191
<Tabs>
199192
<TabItem value="jhub-apps" label="JHub App Launcher" default>
200193

201-
All applications are available on the Nebari home page. From JupyterLAb, you can click on the `Nebari` menu tab and select `Hub Control Panel` to go to the home page.
194+
All applications are available on the Nebari home page (from JupyterLab, click on the Nebari logo in the top right corner or go to `File` -> `Home`).
202195

203196
To manage an application, click on the three dots in the top right of the corresponding application card where you can:
204197

@@ -234,7 +227,7 @@ You should be mindful of the incurring ongoing costs while the dashboard is runn
234227

235228
---
236229

237-
Dashboards and apps can be a very handy tool to share information and insights with colleagues and external customers or collaborators. You can use this basic dashboard to build more complex dashboards, add more dynamic features, and start sharing data insights with others.
230+
Dashboards and apps can be very handy tools to share information and insights with colleagues and external customers or collaborators. You can use this basic dashboard to build more complex dashboards, add more dynamic features, and start sharing data insights with others.
238231

239232
<!-- Internal links -->
240233

docs/docs/tutorials/login-with-keycloak.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ This guide provides a basic overview of how to log in to your Nebari instance (t
1313

1414
Navigate to the instance homepage.
1515

16-
Once on the site, you will be prompted to log in, similar to
17-
the login page shown in the image below.
16+
Once on the site, you will be prompted to log in, similar to the login page shown in the image below. The text on this screen is configurable so your deployment may look slightly different.
1817

1918
![Nebari login screen](/img/how-tos/nebari_login_screen.png)
2019

@@ -53,7 +52,7 @@ The home page, also referred to as
5352
"Landing page", "JupyterHub launcher", or "App Launcher",
5453
lists Nebari's core **services** and allows you to [create and share web apps][create-dashboard].
5554

56-
Click on the **"JupyterLab"** button under **"Services"** to start a server and launch JupyterLab:
55+
Click on the **"JupyterLab"** button under **"Quick Access"** to start a server and launch JupyterLab:
5756

5857
![Nebari home page with Services: JupyterLab, Argo, Users, Environments, Monitoring, VSCode; My Apps: JupyterLab (default JupyterLab instance); and Shared Apps.](/img/tutorials/nebari-home.png)
5958

@@ -89,11 +88,11 @@ Select an appropriate profile and click **"Start"**.
8988

9089
## 5. Start your server
9190

92-
JupyterLab starts to launch.
91+
After clicking "Start", your JupyterLab instance starts to launch.
9392

94-
This step may take up to several minutes due to Nebari use of autoscaling under the hood. Ultimately this autoscaling feature helps reduce costs when the cluster is idle.
93+
This step may take up to several minutes due to Nebari's use of autoscaling under the hood. Ultimately this autoscaling feature helps reduce costs when the cluster is idle.
9594

96-
A successful launch process shows a purple progress bar:
95+
A progress bar is shown while the server is being set up:
9796

9897
![Nebari start server](/img/how-tos/nebari_server_start.png)
9998

@@ -109,7 +108,7 @@ During this time you might see some log messages that detail the autoscaling pro
109108
:::warning
110109

111110
- The starting up sequence can take up to several minutes, depending on the size of the cluster. If the server is not accessible **after 10 minutes**, an error will be shown, and you will be redirected to the Home page. Please check the [troubleshooting docs][troubleshooting] for more information.
112-
- The Event logs may include warnings about `"[Warning] 0/2 nodes are available: 2 node(s) didn't match Pod's node affinity/selector ..." `. This is normal behaviour as cluster sometimes need to expand in order to start the server.
111+
- The Event logs may include warnings about `"[Warning] 0/2 nodes are available: 2 node(s) didn't match Pod's node affinity/selector ..." `. This is **normal behaviour** as the cluster sometimes need to expand in order to start the server.
113112
- Warning such as `"[Warning]" Unable to retrieve some image pull secrets ..."` can also be safely ignored.
114113
:::
115114

292 KB
Loading
-274 KB
Loading
Binary file not shown.
10.2 KB
Loading
121 KB
Loading
-206 KB
Loading

0 commit comments

Comments
 (0)