Management Console

The Stackato Management Console is a web interface that allows the administration and management of the Stackato Server.

Your hypervisor provides tty console access to each of its virtual machines. After startup, a Stackato VM displays:

Stackato Management Console at

https://stackato-xxxx.local

On a micro cloud VM where the local network supports multicast DNS, the hostname will be stackato-xxxx.local. If you have configured the hostname and DNS of the Stackato server manually, or are connecting to a server administered by someone else, supply the assigned hostname instead (e.g. api.stackato-test.example.com).

Enter the URL into your web browser, and the Management Console will load. The Console is supported on the following browsers:

  • Chrome (WebKit)
  • Firefox 4+
  • IE9+

Note

The SSL certificate for the Stackato Management Console is self-signed. You will need to manually accept this certificate in your browser. See the HTTPS section for information on using your own certificate.

When you first access the Management Console, you will be prompted to create a primary administrative user for Stackato. Enter an email address as the username, set a secure password, then review and accept the license agreement.

Note

The password you choose here becomes the login password for the stackato user on the VM (e.g. for ssh access).

Once you've logged in, you can begin to add other users and admins, enable and disable services, and generally set up the system to your requirements.

Basic Stackato administration can be done through the Management Console, but some maintenance and configuration tasks may need to be done at the command line using the kato command. See Kato Command Reference for a full list of options.

The Stackato Management Console will periodically send non-identifying pingbacks (Stackato version number and UUID) to ActiveState servers to help us improve the web console experience. You can disable this by setting theme_settings['pingback_allowed'] = false; in the settings.js file described in the Theming and Customization section.

Overview

The Overview section shows high level details on components, services, roles, applications, and users configured on the server or cluster.

Cluster Roles

Displays the number of nodes serving each role. Clicking any of the roles opens the Cluster Admin page for that role.

Cluster Configuration

Displays the current configuration of the server/cluster.

  • API Endpoint: The URL for stackato clients to target. Normally also the URL for the Management Console.
  • MBUS IP: The IP address that hosts the primary node. Cluster nodes (if any) will connect via this IP address. In a micro cloud setting, it will be 127.0.0.1.

Usage

Total memory, app, and service usage on the system.

Administrators, Users & Groups

The bottom of the Oveview page lists administrative users, regular users, and groups configured on the system. Clicking any of these will open its User or Group Details page.

Users

The Users section displays a list of users and admins, and allows the management of all accounts.

  • Click Add New User to add users.
  • Click Import Users to import a user list (see Importing/Exporting for CSV format)
  • Click Export Users to export a user list (see Importing/Exporting for CSV format)
  • Click Default User Settings to modify the account settings for new users.
  • Use the Search field to filter the list of users.

User Details

For details on a specific user, click on the username in the list. The User Details page shows current usage information, group memberships, and lists of that user's applications and provisioned services.

The following options can be set for the user by clicking User Limits:

  • Enable sudo: Sets whether or not the sudo command can be used. The default setting is false.
  • Memory Allotted: Sets the amount of memory allowed.
  • Services Allotted: Sets the number of services allowed.
  • Applications Allotted: Sets the number of apps allowed.
  • Application URIs Allotted: Sets the number of app URIs allowed.

The default settings for new users are configured in the "Users" section of Settings page.

Groups

Displays a list of groups that currently exist. From the list, you can click on the number of assigned users to see the user list, as well as delete the group.

  • To create a new group, press the "Add New Group" button.
  • To view the details of a group, click on the name of the group.

Group Details

The Group Details page displays an overview of the group's status, including the resource usage, applications and services, and a list of users that are part of the group.

A group has limits attached to it that restrict the resources its members can use. Press the "Group Limits" button to configure these settings. The options exposed are the same as those on the User Details page (above).

For more information on Group limits, see the Groups, Users, and Limits documentation.

Applications

The Applications section displays a list of all apps on the server. For details on the application, click on the name of the app. By clicking the username for the app, you can view the details on the user that pushed the app. Under Actions are three buttons, to restart, stop, and view the app.

Services

Displays a list of services, their type, and the user that created each one.

Features

This page shows two tabs with details on the features available on the server.

Runtimes & Frameworks

Displays a list of runtimes and frameworks available.

Available Services

Displays a list of services that can be created for use by apps.

Cloud Events

The Cloud Events section displays a list of events (including errors and warnings) on the Stackato server. The events can be filtered by Severity or Type, or by using a substring match in the Search field.

Cluster Admin

Displays a list of nodes in the current cluster, and what services are running on each node. The view can be filtered by IP Address and/or Role. In a micro cloud configuration, only the current local node ('127.0.0.1') is shown.

To enable or disable services on a node, click the Configure button to enter its Role Configuration page. This page shows a list of all available roles (see kato info for the command line interface), and a toggle button to enable or disable each one (see also kato role).

To set up a Stackato cluster, or to add nodes to an existing cluster, see the Cluster Setup section.

Status Graphs

Displays graphs for server statistics including CPU, Load, Memory, Processes, and Swap (primary node or micro cloud only).

App Store

Displays a list of apps ready for install to the server. Press the "Install" button to push an app to the server. Apps which require frameworks or services not available on the system will not be installable.

For information on configuring the App Store, see the App Store documentation.

Settings

Allows the user to manage the Stackato Server Settings. There are sub-menus separating the settings into the following groups.

System

  • Maintenance Mode: Shuts down API requests but continues to serve web requests, useful when performing system operations such as importing and exporting data for upgrades. When the primary node enters maintenance mode, the Management Console becomes "read only" with the exception of this toggle (to bring it back online).
  • Logging Level: Changes the verbosity of Stackato logs from 'debug2' (most verbose) through 'off' (silent).
  • Support Email: The email address displayed to end users when errors are encountered. Use an address which is monitored by Stackato administrators.
  • App Store URLs: URIs for JSON files which populate the App Store. The URIs need not be public, but must be accessible from the controller node.
  • Allowed Repos: Debian package repositories allowed in application containers. End users can install additional packages (e.g. with apt-get or aptitude) only from these repositories.

User

  • Default User Settings: The defaults for new user account creation.
    • Enable sudo: Toggles whether new accounts have 'sudo' (root) privileges within application containers. Though applications containers (LXC) are highly secure, there are potential vulnerabilities that could be exposed with sudo enabled. This should only be enabled for trusted end users.
    • Memory Allotted: The amount of memory in a default user's quota.
    • Services Allotted: The number of services a default user can request.
    • Applications Allotted: The number of applications a default user can push.
    • Application URIs Allotted: The number of URLs a default end user can use.
  • Administrators: A list of active administrative accounts.

Application

  • Allow non-local URLs: Toggles whether end users can map external URLs (i.e. not on the Stackato system's domain) to their applications.
  • Reserved URIs: URIs which cannot be used for end user applications.

DEA

  • Max Memory Percentage: The percentage of physical memory each DEA node can use for applications. The default of 80% leaves enough memory space for normal system runtime operation. Do not exceed 100% unless you are using machine or hypervisor that correctly supports swap space and has it enabled.

Stager

  • Max Staging Duration: The maximum time allowed for application staging.

Harbor

Settings for the Harbor TCP/UDP port service.

  • External Host: The public IP (if configured) for the Harbor node.
  • External Hostname: The public hostname for the Harbor node.
  • Port Range Minimum: Sets the minimum for the exposed port range (default: 35000).
  • Port Range Maximum: Sets the maximum for the exposed port range (default: 40000).

See Harbor: Requirements & Setup for more information.

Data Services

  • Allow Over-provisioning: Ignore the Capacity setting.
  • Capacity: Maximum number of service slots to allocate.
  • Max DB size: Maximum size on disk for database services.
  • Max Memory: Maximum amount of physical memory to allocate the service.
  • Memcached Memory: Maximum amount of physical memory to allocate for memcached instances.
  • Max FS Size: Maximum size on disk for filesystem services.