You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs/tutorials/create-dashboard.md
+21-28Lines changed: 21 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: Quickly build and deploy a panel dashboard in Nebari
6
6
7
7
# Create, deploy, and share dashboards and apps
8
8
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.
10
10
11
11
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.
12
12
@@ -19,15 +19,15 @@ Since, CDS Dashboards is deprecated, the documentation will be removed soon.
19
19
20
20
## Supported frameworks
21
21
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:
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
129
125
This interactive feature of Panel makes it possible to rapidly prototype and iterate on dashboards.
130
126
Feel free to add more plots or different styles to your plots!
131
127
132
-
## Deploy the dashboard with JHub App Launcher
128
+
## Deploy the dashboard
133
129
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.
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.
148
137
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>
150
141
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.
152
142
153
-
## Deploy and share the dashboard with CDS Dashboards (Nebari v2023.7.1 or earlier)
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`).
202
195
203
196
To manage an application, click on the three dots in the top right of the corresponding application card where you can:
204
197
@@ -234,7 +227,7 @@ You should be mindful of the incurring ongoing costs while the dashboard is runn
234
227
235
228
---
236
229
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.
Copy file name to clipboardExpand all lines: docs/docs/tutorials/login-with-keycloak.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,8 +13,7 @@ This guide provides a basic overview of how to log in to your Nebari instance (t
13
13
14
14
Navigate to the instance homepage.
15
15
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.
@@ -53,7 +52,7 @@ The home page, also referred to as
53
52
"Landing page", "JupyterHub launcher", or "App Launcher",
54
53
lists Nebari's core **services** and allows you to [create and share web apps][create-dashboard].
55
54
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:
57
56
58
57

59
58
@@ -89,11 +88,11 @@ Select an appropriate profile and click **"Start"**.
89
88
90
89
## 5. Start your server
91
90
92
-
JupyterLab starts to launch.
91
+
After clicking "Start", your JupyterLab instance starts to launch.
93
92
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.
95
94
96
-
A successful launch process shows a purple progress bar:
95
+
A progress bar is shown while the server is being set up:
@@ -109,7 +108,7 @@ During this time you might see some log messages that detail the autoscaling pro
109
108
:::warning
110
109
111
110
- 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.
113
112
- Warning such as `"[Warning]" Unable to retrieve some image pull secrets ..."` can also be safely ignored.
0 commit comments