Anaconda Enterprise: Documentation

# Administration (AEN 4.1.1)

This section is for the administrator of Anaconda Enterprise Notebooks (AEN). Most management of an AEN system is done from the Administrative interface. A few advanced tasks are done from a terminal window using the command line.

An Anaconda Enterprise Notebooks user account can be upgraded to Administrator to have both user and administrator privileges.

When a user has been promoted to Administrator in the top menu bar two additional links appear that are not available on a user account, Admin and Users:

- Admin links to the full Admin dashboard with sub-menus discussed below.
- Users links to a list of all users currently active on the system.
- All other top menu items are the same as all user accounts.

In addition, a user promoted to Administrator has access to the advanced command line administration tools.

The Admin dashboard includes three sub-menus in the left column: Staff, Site Admin and Providers. Each sub-menu is described in detail in the section below this cheat sheet.

## Admin menu cheat sheet

### STAFF MENU

- Daily Report reports of the number of users and projects
- Password Reset allows you to reset a user password
- Notification allows system messages to be relayed to users via SES or SMTP
- Exceptions If errors are raised while AEN is running, a red dot appears on the top navigation bar. Review errors or mark as read.

### SITE ADMIN MENU

- General allows you to change the configuration settings for your AE Notebook server installation
- Accounts turns on or off Open Registration
- Users displays usernames, number of projects and last logins
- Security Log lists errors that could affect security
- Data Centers view current or add a new Data Center
- Task Queue lists workers in the task queue and priority
- License view current or upload a new license.

### PROVIDERS MENU

- Enterprise Resources View, add or remove local or cloud services, designate public or not to control access to this compute node.

Each of these sub-menus is described in detail below.

## Staff menu

### Daily Report

The Daily Report provides reports of the number of users and projects. For new users (if Open Registration is allowed, see also Site Admin Accounts) the report shows a list of the corresponding usernames and emails:

The report also shows a list of actions (projects created, projects updated, user authentications and added users) that occurred in Anaconda Enterprise Notebooks over the selected time frame. You can see this information for Today, Yesterday, This Week, and This Month.

### Password Reset

Enter the username of the user who needs a new password and click the Generate URL button. This generates a link that can be emailed to the user to reset their password:

### Notification

You can turn on email notifications using Amazon Simple Email Service, or by entering SMTP Email Server settings:

Notifications are off by default.

### Exceptions

The Exception menu lists any errors that were raised while Anaconda Enterprise Notebooks is running:

Click on any exception to review details on its cause.

TIP: When an error occurs, a red dot appears in the top navigation bar next to the Admin link. The red dot disappears when you have marked all exceptions as read.

To remove the red dot from the top navigation bar, click the Mark All as Read button.

## Site Admin menu

### General

This menu is where you can change the settings for your AE Notebook installation. This includes the main URL where the site will be accessed, the static URL where the JavaScript files can be accessed, the default project access (public or private), and the account type (cloud or LDAP).

The configuration files may also be changed here.

Click the green Update button to apply the changes.

### Accounts

The Accounts menu lets you turn on or off Open Registration. When Open Registration is checked new users can sign up. You must click the green Update button for the changes to take effect.

TIP: Open Registration means that anyone who has access to the URL of your AEN server can create their own account.

### Users

The Users menu lets you see the name for all users signed up, the number of projects they’ve created, and the last time they logged onto Anaconda Enterprise Notebooks:

### Security Log

Lists all errors that could potentially affect security:

Click the eye icon to view the details for each log item.

Click the name in the Actor column to navigate to the user’s profile page:

### Data Centers

View the current Datacenter information or add a new Data Center by clicking the Add Datacenter button:

This brings you to the following form:

Enter the Name, select Subdomain Routing or Https, enter the base domain name and a summary description of the server, and then select the provider.

When you are finished click the Submit button to add the new Data Center.

### Task Queue

See the list of workers in the task queue and whether the task is high, default or low priority:

Also view the list of current queues sorted by default or high priority.

Click the priority level (default or high) to view all the tasks in the queue.

### License

You’ll find information on your Anaconda Enterprise Notebooks license in the License menu of the Admin Settings. This includes the name of the product, vendor, name, type, end date and when the license was issued:

Click on the Renew Your License button to open up a new menu where you can easily renew your license.

After you have received a new license file, you can use the Upload New License dialog box to add the file to your Anaconda Enterprise Notebooks installation.

To upload your new license, click the Choose File button, select the new license file and click the Open button. This brings you to the Admin Settings page.

Click the green Update button for the new license to be applied.

## Providers menu

### Enterprise Resources

View, add or remove local or cloud services, designate public or not to control exactly who has access to this compute node:

Remove a resource by clicking the red Remove button.

If you click on the name of the resource, you’ll see the following screen where you can find out more information about the resource and edit it:

Click on the green Add Resource button on either of these screens to open the Add Resource form:

## Top utility navigation menu

### Admin

Opens this Admin dashboard.

### Users

List of users who are currently logged onto the system. Clicking on a username navigates to its profiles screen. The profile displays a summary of the projects created by that user and the list of projects to which the user is contributing:

The remaining top navigation menu items in the Admin dashboard are the same as any user account.

## Admin command line tools

Anaconda Enterprise Notebooks includes a set of command line tools that can be used to perform advanced administrative tasks. These utility files are owned by the Anaconda Enterprise notebooks user and should be executed only by the Anaconda Enterprise notebooks user.

Display a list of all Admin command line tools:

    ls -al /opt/wakari/wakari-server/bin/wk-*

Execute these commands to set the owner and the file permissions:

    chown wakari:wakari /opt/wakari/wakari-server/bin/wk-*
    chmod 700 /opt/wakari/wakari-server/bin/wk-*

### Add or remove administrative user

Users can be promoted to Administrator by an Administrator using a command line tool in the terminal application. The same tool can remove Administrator privileges.

On the Anaconda Enterprise Notebooks Server node, open a terminal window to use the `wk-server-admin superuser` command.

EXAMPLE: To give administrative privileges to the user named “jsmith” run the following command:

    wk-server-admin superuser --add jsmith

To remove a user’s administrative privileges use `--remove` instead:

    wk-server-admin superuser --remove jsmith

### Delete user or project

The command `wk-server-admin` in Anaconda Enterprise can also be used to remove users or projects from the data base:

For example, to remove a user whose username is “jsmith” run the following command:

    wk-server-admin remove-user jsmith

The remove a project called “project1” created by the user “jsmith” execute the following code:

    wk-server-admin remove-project jsmith project

For help and information about each command, use the command followed by an `-h` or `--help`.

EXAMPLE: To display additional information about a command presented above:

    wk-server-admin remove-user -h
    we-server-admin remove-project -h

## Anaconda Environments

Each project has an associated conda environment containing the packages needed for that project. When a project is first started, Anaconda Enterprise Notebooks clones a default environment into the project directory, with the name ‘default’.

For more information about environments, see the user guide Anaconda environments page.

## Additional Admin Resources

- Configuration Files
- DNS Changes
- LDAP Configuration
- Example LDAP Configuration
- Start/Shutdown
- Backup/Restore
- Third Party Extensions
- Troubleshooting