Management Console (Admin View)

The Helion Stackato web interface is called the Management Console. The interface displays more options and settings for administrators than it does for regular end users. Some of the features described below are only available in the Admin view.

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

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

Helion 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 Helion Stackato server manually, or are connecting to a server administered by someone else, supply the assigned hostname instead (for example, 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 30+ (WebKit)
  • Firefox 20+
  • IE 10+

Using a browser which fully supports WebSockets is recommended.

Note

The SSL certificate for the Helion 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 administrator for Helion 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 (for example, for ssh access).

Once you have 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 Helion 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 Client Command Reference for a full list of options.

Tip

By default, the management console displays a maximum of 50 items per page. To increase or reduce the number of items displayed per page, you can run the following command:

kato config set cloud_controller_ng renderer/default_results_per_page <number>

For more information, see the usage details for the kato config set command.

Welcome

The top-level page of the Management Console displays quick links to the most used resources and views. The blue buttons are for features also available for regular end users (see Management Console (User View)).

Green buttons expose Admin-only functionality:

  • Configure Available Services: Opens the Cluster Nodes view showing which roles are running on which nodes. From this view you can add or remove Service roles on the various nodes in the cluster (or on 127.0.0.1 for micro clouds).
  • Manage Organizations: Opens the Organizations view.
  • Manage Users: Opens the Users view.
  • View All Deployed Applications: Opens the Applications view.
  • View Cloud Events: Opens the Cloud Events view.
  • View Dashboard: Opens the Dashboard.

Available patches for the system, new Helion Stackato releases, and the latest Helion Stackato news are also displayed on this page.

Applications

The Applications section displays a list of all apps on the server. Click anywhere on the line for an app to view its details. Admins have the same permissions in the Application View as a Developer of the space it was deployed to.

Organizations

The top level Organizations page allows Admins to add and delete organizations. Clicking on an organization name opens its details. This view is the same as a regular user's Organizations view, but administrators can edit quotas, and add/remove domains, spaces, and users.

Support

The Support menu includes the same options as the regular user.

Admin

Several views that are only available to Helion Stackato administrators are in the Admin menu.

Cluster Management

Summary

Displays a list of roles and their status in the system. Additionally, the following system information is displayed:

  • Number of nodes: The number of nodes in the cluster.
  • Version: Version (release) number of the system.
  • 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.
  • API Endpoint: The URL for stackato clients to target. Normally also the URL for the Management Console.

Cluster Nodes

Displays a list of nodes in the current cluster, and what services are running on each node. In a micro cloud configuration, only the current local node ('127.0.0.1') is displayed.

To enable or disable services on a node, click Configure Roles (cog icon) to see the Node Settings, showing a list of all available roles and checkboxes to enable or disable each one. Click Save to apply changes.

See also the kato role and kato info command documentation for the CLI equivalents, and the Cluster Setup section for information on adding nodes to the cluster.

Available Patches

Displays a list of available patches for the current cluster.

Applications & Organizations

Links to the Applications and organizations lists.

Domains

A filterable list of all domains configured on the system, showing whether they are Shared or Owned domains.

Routes

A filterable list of routes in the system.

Services

Managed Services Instances

A filterable list of managed service instances on the system.

User Provided Service Instances

A filterable list of user provided service instances on the system.

Available Services

A list of available service types (with their version).

Users

The Users section displays a list of users and admins.

  • Click + Add User to add users.
  • Click on the username or email address to view account details or change the password.

Quota Plans

Lists the Quota Plans available to apply to organizations on the system. To edit a definition, click Edit on the right. The following fields can be modified:

  • Name: The definition name. Do not change this without also changing the settings of any organization using the definition.
  • Memory Usage Limit: The total amount of application RAM (in MB) that can be allocated to user applications.
  • Total Services: The total number of service instances that can be allocated.
  • Total Routes: The total number of routes that can be created.
  • Droplets per App: The number of droplets stored (per application) for versioning and rollback .
  • Allow Sudo: Allow users in the organization sudo privileges within their application containers.

To create a new definition use the stackato quota create command.

Dashboards

Memory Summary

Helion Stackato tracks the amount of memory used by applications across all DEA nodes and shows various reports. Available memory is calculated based on the system memory of the DEA nodes multiplied by the Max Memory Percentage. Memory Summary shows how much memory:

  • has been assigned to organizations via Quota Plans
  • is available on DEA nodes
  • remains unallocated
  • has been allocated
  • is currently in use

DEA Usage

Memory usage statistics and a usage bar graph for each DEA node in the pool.

Placement Zone Usage

Memory usage statistics and a usage bar graph for all configured Placement Zones

Availability Zone Usage

Memory usage statistics and a usage bar graph for all configured Availability Zones

Router Stats

Shows realtime results for incoming requests (connections per second), routing errors (errors per second), and an overview of the cumulative requests to the system.

Primary Node Status Graphs

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

Cloud Events

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

Settings

The Settings menu gives access to the following Console and system settings:

Helion Stackato Settings

  • System Settings:

    • Logging Level: Changes the verbosity of Helion 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 Helion Stackato administrators.
  • Sample Application URLs: URIs for Store Definition YAML files which populate the Sample Applications page. The URIs need not be public, but must be accessible from the controller node.

  • Docker App Settings:

    • Require sudo: Limit Docker image deployment to organizations with 'sudo' permissions enabled in the Quota Plan.

    • Allow any docker registry: Let users deploy Docker images from any registry server. Docker image deployment should be limited to either a trusted group of users, trusted image sources, or both. Allowing any user to deploy Docker images without restrictions is not recommended.

    • Allowed Docker Registries: A list of servers, namespaces, or images that users are allowed to deploy. Entries are specified in the standard format accepted by the docker client (user:pass@domain.com:port/namespace/repo:tag). For example:

      Pattern What it allows
      httpd the 'library/httpd' repo on Docker Hub, any tag
      httpd: only 'library/httpd:latest'
      httpd:2.4 only 'library/httpd:2.4'
      cloudfoundry/ Docker Hub repos under the 'cloudfoundry' namespace, any tag
      cloudfoundry/lattice-app only 'cloudfoundry/lattice-app', any tag
      reg.example.com any namespace, repo, and tag on private registry
      reg.example.com/ any repo in the 'library' namespace
      reg.example.com/prod any repo in the 'prod' namespace, any tag
      reg.example.com/prod/app only the 'prod/app' repo, any tag
      reg.example.com/prod/app: only 'prod/app:latest'
      reg.example.com/prod/app:mytag only 'prod/app:mytag'
      reg.example.com:5000 a registry server running on a specific port
      user:pass@reg.example.com a registry server requiring login

      Credentials specified in the Allowed Docker Registries list are used as defaults when the user requests a matching image name without credentials.

  • Allowed Repos: Debian package repositories allowed in application containers. End users can install additional packages (for example, with apt-get or aptitude) only from these repositories. When adding new repositories, GPG keys for each new repo must also be added to the Docker base container (see Allowed Repositories).

  • 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).

Applications

  • Reserved URIs: Virtual hostnames and URIs reserved for use by the Helion Stackato system which cannot be used for end user applications. This prevents users from deploying applications on URIs which the system requires (for example, api), or for cases where a particular DNS sub-domain record is not being resolved to the Helion Stackato system. Specify only the host (subdomain) portion of the URI. Fully qualified URLs will be ignored.

Console

Various settings and templates to customize the look and feel of the Management Console. The settings are divided into the following categories:

  • Product: Options to rename and reversion Helion Stackato for OEM deployments, change the default locale (currently only en and de are available), or choose a different URL for documentation.
  • Client: A version number setting and alternative paths/URLs for alternative or renamed CLI clients.
  • Look and Feel: Change the favicon, header, footer, or background color.
  • Welcome Page: EJS templated HTML to display on the Welcome page (see above).
  • Support Page: EJS templated HTML to display on the Support page. Change this if you are supporting your end users directly.
  • Eula Content: End User License Agreement. Change this only if you are an OEM customer exposing Helion Stackato to end users under your own specific licensing terms.
  • Custom Stylesheet: A single CSS file used to override any existing styling in the Management Console. Inspect the Console with browser tools such as Firebug or Chrome Developer Tools to see the class names and IDs.

Detailed instructions for customizing and branding Helion Stackato can be found in the Theming and Customization section.

DEA

DEA Settings

  • Max Memory Percentage: The percentage of physical memory each DEA node can use for hosted applications. The 80% default setting leaves enough memory for the OS and DEA processes on a node with 4GB of RAM. This can be increased on nodes with more memory available (for example, to 90% on a node with 8GB of RAM). Do not exceed 100% unless the system correctly supports swap space and has it enabled. Restart all DEA roles/nodes to apply the change.
  • Max Staging Duration: The maximum time allowed for application staging.

DEA Placement Zones

A filterable list of DEA Placement Zones on the system.

Availability Zones

A filterable list of Availability Zones on the system.

Feature Flags

Specific permissions allowing organization managers and developers to perform certain tasks can be toggled by admins using feature flags. When disabled, only admins can perform these tasks.

  • Enable App Bits Upload: Allows developers to upload application bits (enabled by default).
  • Enable App Scaling: Allows developers to scale applications (enabled by default).
  • Enable Private Domain Creation: Allows organization managers to create private domains for that organization (enabled by default).
  • Enable Route Creation: Allows developers to create routes in a space (enabled by default).
  • Enable Service Instance Creation: Allows developers to create service instances in a space (enabled by default).
  • Enable User Organization Creation: Allows any user to create an organization via the API (disabled by default).

These options can also be toggled using the stackato CLI client with the feature flags commands.

Logyard

Lists current log Drains and the log drain retry limits. Drains and limits cannot be changed in this interface; use the kato log drain ... commands and kato config ... commands.

File System

  • Capacity: Maximum number of data service instances to allow globally across all organizations and spaces.
  • Max FS Size: Maximum size on disk for filesystem services in MB.
  • Allow Over-provisioning: Ignore the Capacity setting.

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.

Trying and Licensing Helion Stackato

You may use the VirtualBox distribution of HPE Helion Stackato as a stand-alone micro cloud system with up to 4GB of RAM under the Product Evaluation Agreement.

All other distributions of HPE Helion Stackato are subject to the Software License Terms and require a software license key.

For Helion Stackato pricing and options, contact stackato-sales@hpe.com.