User's Guide
The Labs Workbench is currently in beta testing. Documentation is subject to change.
This document refers to the Labs Workbench demonstration instance available at https://www.workbench.nationaldataservice.org.
- 1 Introduction
- 2 Registration and approval
- 3 Resource Limits
- 4 Account Management
- 4.1 Login
- 4.2 Forgot password
- 4.3 Change password
- 4.4 Logout
- 5 Application Dashboard
- 6 Your home directory
- 6.1 File Manager
- 6.2 Console access
- 6.3 Mounting folders
- 7 Application catalog
- 7.1 Searching and filtering
- 7.2 Official vs user-defined applications
- 7.3 Adding your own application specification
- 7.4 Importing an application specification
- 7.5 Application menu
- 7.6 Editing an application specification
- 7.7 Cloning an application specification
- 7.8 Deleting an application specification
- 7.9 Sharing your application specification
- 7.10 Adding your application to the official catalog
- 8 Application specification
- 8.1 Application Details
- 8.2 Dependencies
- 8.3 Environment
- 8.4 Data
- 8.5 Ports
- 8.6 Resource Limits
- 8.7 Development
- 9 Development environments
- 10 Backing up your data
- 11 Troubleshooting
Introduction
This User's Guide refers to the demonstration instance of NDS Labs Workbench available at http://www.workbench.nationaldataservice.org.
For more information, see What is NDS Labs Workbench?
Registration and approval
This section describes the NDS Labs Workbench account registration and approval process.
Register for an account
To register for an account, select or and enter your registration information:
Field | Description |
|---|---|
Full Name | Your full name will be considered during the account approval process. |
Email Address | Email address will be verified and used for limited communications. |
Organization | Your organization will be considered during the account approval process. |
Description | Please provide a brief description about why you are requesting access to the NDS Labs Workbench. |
Username | Unique username will be used for login. |
Password | Must be longer than 6 characters. |
Email verification
After submitting your account registration information, should should receive an email from the NDS Labs team with the subject "Email address verification". Click the link in this message to verify your email and complete the registration process. After your email address has been verified, your registration will be reviewed and approved by the NDS Labs team.
Account approval
The NDS Labs team will review your registration request and get back to you within 5 business days. You will be notified whether your request has been approved or denied. See our Frequently Asked Questions for information about who is able to access the service.
Resource Limits
Labs Workbench restricts resources allocated to user accounts and individual applications.
Account resource limits: By default, each user account is allocated 12GB RAM, 4 cores, and 20GB of storage. If more resources are required, contact ndslabs-support@nationaldataservice.org.
Application resource limits: Application developers are required to specify baseline resource limits for their services. User's can override these settings by cloning the official application. For more information, please see the "Resource Limits" section below. For developers interested in estimating resource requirements for services, please see the Developer's Guide.
Account Management
Login
After you receive your account approvel email, select the link and enter your username and password.
Forgot password
To recover a forgotten password, on the page select the link. Enter your username and a password recovery email will be sent to the registered email address.
Change password
After logging in, select your username in the upper right-hand corner then the menu item.
Logout
Select your username in the upper right-hand corner then the menu item.
Application Dashboard
Select the link you to manage your applications. From this page you can add, rename, configure, start and stop applications. Once an application is started, you can view logs and access a console. You can also enable or disable basic authentication on the running application.
Adding an application
To add a new application, select . This will take you to the application catalog, where you can search for or add your own applications. Select the for an application to add it to your dashboard.
Configuring an application
Official applications are added with reasonable default settings when possible. However, you may want to customize settings or add optional services. Note that some services require configuration.
Once added to your dashboard, to configure a service, select the button.
Tab | Description |
|---|---|
Environment | Customize or override any configuration options offered by the service or add your own custom environment variables that will be set in the running container. |
Data | Override default data directories or mount custom directories from your home directory. |
Docker | Select the Docker image to be used. |
Adding optional services
Some applications offer optional configurable dependencies. To add an optional service, select thebutton. You will be prompted to enter any required configuration information.
Launching an application
To start or launch the application, select .
During the startup process, you may notice the following:
Status | Description |
|---|---|
The service is currently stopped or waiting for a dependent service to start. | |
The service is starting. You can view logs during the startup process. Please note, for new services the startup process might include pulling images from Dockerhub. | |
The service entered an error state. View log files for more information. | |
The service is ready. | |
The service has an HTTP interface that can be access. Click on the endpoint link to access the running application. |