Using the Admin Console

Learn about administration tools used in the Admin Console.

Table of Contents

Introduction

Platform administration is performed using the Admin Console. After the platform is installed and the Configure Container Instance Wizard is used to define a container that will host selected features, the Admin Console is used to perform feature installation, configuration, and maintenance tasks.

Admin Console tabs

The Admin Console includes the following tabs:

Available Features tab

The Available Features tab displays a list of features, tools, and plug-ins that are available to be installed on the current container instance.

For an example of the Available Features list, see Installation Options: Full List.

Feature List

The feature list can be filtered to show Feature, Tool, or Plug-in via the Filter drop-down. Installation and configuration instructions can be found here: Installing Features, Installing Tools, Installing Plug-ins.

Install Feature(s)

To install a feature, select the corresponding checkbox, and click Install Feature. Select additional checkboxes to install multiple features. During the installation process a series of feature resolution screens will display. After the installation process is complete, the feature is listed on the Installed Features tab.

Configure Feature

If additional configuration steps are required, you can select Configure on the Installation Complete screen, or select Complete Configuration in the Pending Installation Tasks section of the Installed Features screen. See Configuration Actions for information on available configuration tasks.

Installed Features tab

The Installed Features tab displays a list of features that are installed on the current container instance. The feature list Filter drop-down list box allows you to filter features by Product Feature or Bundle categories.

Pending Installation Tasks

The Pending Installation Tasks is a list of configuration tasks (if applicable) that are required to complete the installation process. To perform pending installation tasks, click Complete Configuration. See Configuration Actions for information on available configuration tasks.

Uninstall Feature

To uninstall a feature, select the icon and click OK. The system uninstalls the selected feature, removes it from the Installed Features tab, and moves it back to the Available Features tab.

Update Feature

To update features, refresh the repository using the Repository tab or restart the administrator console to view the bundle changes. Select a feature line item and click Search for Updates. An installation wizard displays and presents a listing of available updates (if applicable). To install the updates proceed with the installation process. After the update is complete, the version number of updated features is changed to reflect the installed version.

Rollback Feature

To rollback a feature, select a feature line item and click Rollback Changes. Select the latest snapshot to restore the system to an earlier snapshot by choosing the snapshot date and time. Although the feature bundles and configuration will be restored to the previous snapshot, some manual changes may still be required.

The rollback is successful to an earlier snapshot if all the bundles are updated successfully, which can be verified using the System tab. If the bundles are not updated and a rollback is performed, it can corrupt the container and rollback can be unsuccessful.

View Feature / Bundle List

To view bundles associated with a current update, click the "Installed Features" tab, select "Bundle" from the "Filter" drop-down list box, and click the "Version" column to sort by version. To view "Bundle Details" click on a bundle line item.

Configuration tab

The Configuration tab provides two methods of modifying a container configuration including Configuration Actions on the left sidebar that execute wizards, and Properties that are presented in a table format. After modifying any container configuration properties you must restart your container.

Configuration Actions

Configuration Actions are located in the bottom left sidebar area of the Configuration tab. They represent repeatable tasks that were performed during the initial container configuration. To modify properties for a specific configuration area, click the task link to launch a wizard and then configure the properties.

Configuration Properties

Configuration properties are organized into Configuration Categories and are located in the top left sidebar area of the Configuration tab. To view properties, click a Configuration Category link and a properties table displays. To update a property, modify the property information in the table row and click Apply Changes. To add additional properties click, Add Property. See Configuration Categories for a listing of configuration categories and settings.

  • The Configuration Categories section displays a list of property categories that expand to display specific property names and values. The initial property configuration is created during the installation and configuration of features.
  • To update a property value, select a property name in the Configuration Categories section, update the property value, and click Apply Changes.
  • To add a property value, select a Configuration Category to add a property to, and click Add Property. The Add Configuration Property popup displays. Enter a Property Name and Property Value and click Apply.
  • The Configuration Actions section displays a list of maintenance actions.

Health tab

The Health tab gives you access to the System Health tool, which allows you to monitor health statistics by making a GET call to any Akana container.

For more information about this tool, see Monitoring the Health of a Container: Akana System Health Tool.

Repository tab

The Repository tab displays a list of repositories identified by "Location" that store product features that are available for installation on the current container instance. A default repository (Platform Default Repository) is added as part of the initial Platform installation.

Install Container Updates

Container Updates are distributed using a Repository URL that points to a repository that contains designated product features or updates. The Repository URL is added to the Repository tab via the Admin Console. Updates include bundles that represent new features, or updates to existing features.

After a Repository URL is added to the "Repository," updates to a specific feature can be applied by clicking the Search for Updates button via the Installed Features tab and applying the list of updates found.

This section provides instructions for adding a Repository URL to the Admin Console and applying an update.

Add Repository URL

Product updates are installed via the Admin Console. The first step in applying a product update is to add the Repository URL that includes the update data to via the Repository tab.

System tab

The System tab provides a summary of the Platform process characteristics and states. Information includes the last start time of the process, memory details (Total, Used, Free), and a listing of associated system properties. System details can be used to review system health and for troubleshooting purposes.

Restart Container

To restart the current container instance and associated bundles, click Restart. Note that Restart applies to standalone deployments only.

Monitoring tab

You can monitor the real-time state of a container with the Admin Monitoring Tool, an optional plug-in.

For more information, see Using the Admin Monitoring Tool.

Generate System Report

The Generate System Report option allows you to generate a report of all system activity associated with the current container.