Administration (AEN 4.1.2)
==========================

.. raw:: html

    <p>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.</p>
    <p>An Anaconda Enterprise Notebooks user account can be upgraded to Administrator
    to have both user and administrator privileges.</p>
    <p>When a user has been promoted to <a class="reference internal" href="#aen-add-administrative-user"><span class="std std-ref">Administrator</span></a>
    in the top menu bar two additional links appear that are not available on a
    user account, Admin and Users:</p>
    <p><img alt="image0" src="../../../_images/ae-notebooks/4.1.2/admin/admin_image1.png" /></p>
    <ul class="simple">
    <li><strong>Admin</strong> links to the full Admin dashboard with sub-menus discussed below.</li>
    <li><strong>Users</strong> links to a list of all users currently active on the system.</li>
    <li>All other top menu items are the same as all <a class="reference internal" href="../user/index.html"><span class="doc">user accounts</span></a>.</li>
    </ul>
    <p>In addition, a user promoted to Administrator has access to the <a class="reference internal" href="#aen-admin-tools"><span class="std std-ref">advanced command
    line administration tools</span></a>.</p>
    <p>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.</p>
    <div class="section" id="admin-menu-cheat-sheet">
    <h2>Admin menu cheat sheet<a class="headerlink" href="#admin-menu-cheat-sheet" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="staff-menu">
    <h3>STAFF MENU<a class="headerlink" href="#staff-menu" title="Permalink to this headline">¶</a></h3>
    <ul class="simple">
    <li><strong>Daily Report</strong> reports of the number of users and projects</li>
    <li><strong>Password Reset</strong> allows you to reset a user password</li>
    <li><strong>Notification</strong> allows system messages to be relayed to users via SES or SMTP</li>
    <li><strong>Exceptions</strong> If errors are raised while AEN is running, a red dot appears on the top navigation bar. Review errors or mark as read.</li>
    </ul>
    </div>
    <div class="section" id="site-admin-menu">
    <h3>SITE ADMIN MENU<a class="headerlink" href="#site-admin-menu" title="Permalink to this headline">¶</a></h3>
    <ul class="simple">
    <li><strong>General</strong> allows you to change the configuration settings for your AE Notebook server installation</li>
    <li><strong>Accounts</strong> turns on or off Open Registration</li>
    <li><strong>Users</strong> displays usernames, number of projects and last logins</li>
    <li><strong>Security Log</strong> lists errors that could affect security</li>
    <li><strong>Data Centers</strong> view current or add a new Data Center</li>
    <li><strong>Task Queue</strong> lists workers in the task queue and priority</li>
    <li><strong>License</strong> view current or upload a new license.</li>
    </ul>
    </div>
    <div class="section" id="providers-menu">
    <h3>PROVIDERS MENU<a class="headerlink" href="#providers-menu" title="Permalink to this headline">¶</a></h3>
    <ul class="simple">
    <li><strong>Enterprise Resources</strong> View, add or remove local or cloud services, designate public or not to control access to this compute node.</li>
    </ul>
    <p>Each of these sub-menus is described in detail below.</p>
    </div>
    </div>
    <div class="section" id="id1">
    <h2>Staff menu<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="daily-report">
    <h3>Daily Report<a class="headerlink" href="#daily-report" title="Permalink to this headline">¶</a></h3>
    <p>The Daily Report provides reports of the number of users and
    projects. For new users (if Open Registration is allowed, see also <a class="reference internal" href="#aen-index-site-admin-accounts"><span class="std std-ref">Site
    Admin Accounts</span></a>) the report
    shows a list of the corresponding usernames and emails:</p>
    <p><img alt="image1" src="../../../_images/ae-notebooks/4.1.2/admin/admin_dailyreport.png" /></p>
    <p>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.</p>
    </div>
    <div class="section" id="password-reset">
    <h3>Password Reset<a class="headerlink" href="#password-reset" title="Permalink to this headline">¶</a></h3>
    <p>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:</p>
    <p><img alt="image2" src="../../../_images/ae-notebooks/4.1.2/admin/admin_passreset.png" /></p>
    </div>
    <div class="section" id="notification">
    <h3>Notification<a class="headerlink" href="#notification" title="Permalink to this headline">¶</a></h3>
    <p>You can turn on email notifications
    using Amazon Simple Email Service, or by entering SMTP Email Server
    settings:</p>
    <p><img alt="image3" src="../../../_images/ae-notebooks/4.1.2/admin/admin_notification.png" /></p>
    <p>Notifications are off by default.</p>
    </div>
    <div class="section" id="exceptions">
    <h3>Exceptions<a class="headerlink" href="#exceptions" title="Permalink to this headline">¶</a></h3>
    <p>The Exception menu lists any errors that were raised while Anaconda
    Enterprise Notebooks is running:</p>
    <p><img alt="image4" src="../../../_images/ae-notebooks/4.1.2/admin/admin_except1.png" /></p>
    <p>Click on any exception to review details on its cause.</p>
    <p>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.</p>
    <p>To remove the red dot from the top navigation bar,
    click the Mark All as Read button.</p>
    </div>
    </div>
    <div class="section" id="id2">
    <h2>Site Admin menu<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="general">
    <h3>General<a class="headerlink" href="#general" title="Permalink to this headline">¶</a></h3>
    <p>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).</p>
    <p>The configuration files may also be changed here.</p>
    <p><img alt="image6" src="../../../_images/ae-notebooks/4.1.2/admin/admin_general.png" /></p>
    <p>Click the green Update button to apply the changes.</p>
    </div>
    <div class="section" id="accounts">
    <span id="aen-index-site-admin-accounts"></span><h3>Accounts<a class="headerlink" href="#accounts" title="Permalink to this headline">¶</a></h3>
    <p>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.</p>
    <p><img alt="image7" src="../../../_images/ae-notebooks/4.1.2/admin/admin_accounts.png" /></p>
    <p>TIP: Open Registration means that anyone who has access to the URL of your
    AEN server can create their own account.</p>
    </div>
    <div class="section" id="users">
    <h3>Users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h3>
    <p>The Users menu lets you see the name for all users signed up, the number
    of projects they&#8217;ve created, and the last time they logged onto Anaconda
    Enterprise Notebooks:</p>
    <p><img alt="image8" src="../../../_images/ae-notebooks/4.1.2/admin/admin_users.png" /></p>
    </div>
    <div class="section" id="security-log">
    <h3>Security Log<a class="headerlink" href="#security-log" title="Permalink to this headline">¶</a></h3>
    <p>Lists all errors that could potentially affect security:</p>
    <p><img alt="image9" src="../../../_images/ae-notebooks/4.1.2/admin/admin_securitylog1.png" /></p>
    <p>Click the eye icon to view the details for each log item.</p>
    <p>Click the name in the Actor column to navigate to the user&#8217;s profile page:</p>
    <p><img alt="image10" src="../../../_images/ae-notebooks/4.1.2/admin/admin_securitylog2.png" /></p>
    </div>
    <div class="section" id="data-centers">
    <h3>Data Centers<a class="headerlink" href="#data-centers" title="Permalink to this headline">¶</a></h3>
    <p>View the current Datacenter information or add a new Data Center by
    clicking the Add Datacenter button:</p>
    <p><img alt="image11" src="../../../_images/ae-notebooks/4.1.2/admin/admin_datacenter1.png" /></p>
    <p>This brings you to the following form:</p>
    <p><img alt="image12" src="../../../_images/ae-notebooks/4.1.2/admin/admin_datacenter2.png" /></p>
    <p>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.</p>
    <p>When you are finished click the Submit button to add the new Data
    Center.</p>
    </div>
    <div class="section" id="task-queue">
    <h3>Task Queue<a class="headerlink" href="#task-queue" title="Permalink to this headline">¶</a></h3>
    <p>See the list of workers in the task queue and whether the task is high,
    default or low priority:</p>
    <p><img alt="image13" src="../../../_images/ae-notebooks/4.1.2/admin/admin_taskqueue.png" /></p>
    <p>Also view the list of current queues sorted by default or high priority.</p>
    <p>Click the priority level (default or high) to view all the tasks in the queue.</p>
    </div>
    <div class="section" id="license">
    <h3>License<a class="headerlink" href="#license" title="Permalink to this headline">¶</a></h3>
    <p>You&#8217;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:</p>
    <p><img alt="image14" src="../../../_images/ae-notebooks/4.1.2/admin/admin_license.png" /></p>
    <p>Click on the Renew Your License button to open up a new menu
    where you can easily renew your license.</p>
    <p>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.</p>
    <p>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.</p>
    <p>Click the green Update button for the new license to be applied.</p>
    </div>
    </div>
    <div class="section" id="id3">
    <h2>Providers menu<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="enterprise-resources">
    <h3>Enterprise Resources<a class="headerlink" href="#enterprise-resources" title="Permalink to this headline">¶</a></h3>
    <p>View, add or remove local or cloud services, designate public or not to
    control exactly who has access to this compute node:</p>
    <p><img alt="image15" src="../../../_images/ae-notebooks/4.1.2/admin/admin_enterpriseresources.png" /></p>
    <p>Remove a resource by clicking the red Remove button.</p>
    <p>If you click on the name of the resource, you&#8217;ll see the following
    screen where you can find out more information about the
    resource and edit it:</p>
    <p><img alt="image16" src="../../../_images/ae-notebooks/4.1.2/admin/admin_er_editresource.png" /></p>
    <p>Click on the green Add Resource button on either of these
    screens to open the Add Resource form:</p>
    <p><img alt="image17" src="../../../_images/ae-notebooks/4.1.2/admin/admin_er_addresource.png" /></p>
    </div>
    </div>
    <div class="section" id="top-utility-navigation-menu">
    <h2>Top utility navigation menu<a class="headerlink" href="#top-utility-navigation-menu" title="Permalink to this headline">¶</a></h2>
    <div class="section" id="admin">
    <h3>Admin<a class="headerlink" href="#admin" title="Permalink to this headline">¶</a></h3>
    <p>Opens this Admin dashboard.</p>
    </div>
    <div class="section" id="aen-users-menu">
    <span id="id4"></span><h3>Users<a class="headerlink" href="#aen-users-menu" title="Permalink to this headline">¶</a></h3>
    <p>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:</p>
    <p><img alt="image18" src="../../../_images/ae-notebooks/4.1.2/admin/users_users.png" /></p>
    <p>The remaining top navigation menu items in the Admin dashboard
    are the same as any <a class="reference internal" href="../user/index.html"><span class="doc">user account</span></a>.</p>
    </div>
    </div>
    <div class="section" id="admin-command-line-tools">
    <span id="aen-admin-tools"></span><h2>Admin command line tools<a class="headerlink" href="#admin-command-line-tools" title="Permalink to this headline">¶</a></h2>
    <p>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.</p>
    <p>Display a list of all Admin command line tools:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">ls</span> <span class="o">-</span><span class="n">al</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">wakari</span><span class="o">/</span><span class="n">wakari</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">wk</span><span class="o">-*</span>
    </pre></div>
    </div>
    <p>Execute these commands to set the owner and the file permissions:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">chown</span> <span class="n">wakari</span><span class="p">:</span><span class="n">wakari</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">wakari</span><span class="o">/</span><span class="n">wakari</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">wk</span><span class="o">-*</span>
    <span class="n">chmod</span> <span class="mi">700</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">wakari</span><span class="o">/</span><span class="n">wakari</span><span class="o">-</span><span class="n">server</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">wk</span><span class="o">-*</span>
    </pre></div>
    </div>
    <div class="section" id="add-or-remove-administrative-user">
    <span id="aen-add-administrative-user"></span><h3>Add or remove administrative user<a class="headerlink" href="#add-or-remove-administrative-user" title="Permalink to this headline">¶</a></h3>
    <p>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.</p>
    <p>On the Anaconda Enterprise Notebooks Server node, open a terminal window
    to use the <code class="docutils literal"><span class="pre">wk-server-admin</span> <span class="pre">superuser</span></code> command.</p>
    <p>EXAMPLE: To give administrative privileges to the user named &#8220;jsmith&#8221;
    run the following command:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">wk</span><span class="o">-</span><span class="n">server</span><span class="o">-</span><span class="n">admin</span> <span class="n">superuser</span> <span class="o">--</span><span class="n">add</span> <span class="n">jsmith</span>
    </pre></div>
    </div>
    <p>To remove a user&#8217;s administrative privileges use <code class="docutils literal"><span class="pre">--remove</span></code> instead:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">wk</span><span class="o">-</span><span class="n">server</span><span class="o">-</span><span class="n">admin</span> <span class="n">superuser</span> <span class="o">--</span><span class="n">remove</span> <span class="n">jsmith</span>
    </pre></div>
    </div>
    </div>
    <div class="section" id="delete-user-or-project">
    <h3>Delete user or project<a class="headerlink" href="#delete-user-or-project" title="Permalink to this headline">¶</a></h3>
    <p>The command <code class="docutils literal"><span class="pre">wk-server-admin</span></code> in Anaconda Enterprise can also be used
    to remove users or projects from the data base:</p>
    <p>For example, to remove a user whose username is &#8220;jsmith&#8221; run the
    following command:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">wk</span><span class="o">-</span><span class="n">server</span><span class="o">-</span><span class="n">admin</span> <span class="n">remove</span><span class="o">-</span><span class="n">user</span> <span class="n">jsmith</span>
    </pre></div>
    </div>
    <p>The remove a project called &#8220;project1&#8221; created by the user &#8220;jsmith&#8221;
    execute the following code:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">wk</span><span class="o">-</span><span class="n">server</span><span class="o">-</span><span class="n">admin</span> <span class="n">remove</span><span class="o">-</span><span class="n">project</span> <span class="n">jsmith</span> <span class="n">project</span>
    </pre></div>
    </div>
    <p>For help and information about each command, use the command
    followed by an <code class="docutils literal"><span class="pre">-h</span></code> or <code class="docutils literal"><span class="pre">--help</span></code>.</p>
    <p>EXAMPLE: To display additional information about a command
    presented above:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">wk</span><span class="o">-</span><span class="n">server</span><span class="o">-</span><span class="n">admin</span> <span class="n">remove</span><span class="o">-</span><span class="n">user</span> <span class="o">-</span><span class="n">h</span>
    <span class="n">we</span><span class="o">-</span><span class="n">server</span><span class="o">-</span><span class="n">admin</span> <span class="n">remove</span><span class="o">-</span><span class="n">project</span> <span class="o">-</span><span class="n">h</span>
    </pre></div>
    </div>
    </div>
    </div>
    <div class="section" id="anaconda-environments">
    <h2>Anaconda Environments<a class="headerlink" href="#anaconda-environments" title="Permalink to this headline">¶</a></h2>
    <p>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 &#8216;default&#8217;.</p>
    <p>For more information about environments, see the user guide
    <a class="reference internal" href="../user/anaconda.html"><span class="doc">Anaconda environments</span></a> page.</p>
    </div>
    <div class="section" id="additional-admin-resources">
    <h2>Additional Admin Resources<a class="headerlink" href="#additional-admin-resources" title="Permalink to this headline">¶</a></h2>
    <div class="toctree-wrapper compound">
    <ul>
    <li class="toctree-l1"><a class="reference internal" href="configuration-files.html">Configuration Files</a></li>
    <li class="toctree-l1"><a class="reference internal" href="configuration-files.html#dns-changes">DNS Changes</a></li>
    <li class="toctree-l1"><a class="reference internal" href="configuration-files.html#ldap-configuration">LDAP Configuration</a></li>
    <li class="toctree-l1"><a class="reference internal" href="configuration-files.html#example-ldap-configuration">Example LDAP Configuration</a></li>
    <li class="toctree-l1"><a class="reference internal" href="shutdown.html">Start/Shutdown</a></li>
    <li class="toctree-l1"><a class="reference internal" href="backup.html">Backup/Restore</a></li>
    <li class="toctree-l1"><a class="reference internal" href="third-party.html">Third Party Extensions</a></li>
    <li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
    </ul>
    </div>
    <div class="toctree-wrapper compound">
    </div>
    </div>

.. toctree::
    :hidden:

    configuration-files
    shutdown
    backup
    third-party
    troubleshooting
    compute-nodes
