Add a container service

This Orion Platform topic applies only to the following products:


To add a container service to the Orion Platform, you must connect to the server that hosts the containers and run an environment-specific script to:

  • Download a deployment file to a single node — usually an orchestrator's master node —in the container environment.
  • Deploy an Orion Monitor container to every node in the cluster to track node status and metrics.
  • Deploy an Orion Aggregator container to a single node in the container environment to collect data from Orion Monitor containers. The Orion Aggregator container reports its own status, plus status and metrics for each Orion Monitor container, to the Orion server every five minutes.

Two types of agent plug-ins are also deployed:

  • A CleanUp agent plug-in runs daily to clear all data, including images and environment variables, for containers reported as being deleted for over 7 days.
  • A StatusSetUp agent plug-in checks the status of the Orion Aggregator container every minute.
    • If the Orion Aggregator container fails to connect to the Orion server for two, consecutive five-minute intervals, the container service status changes to Down and the container status switches to Unknown.
    • If the Orion Aggregator container fails to report metrics from Orion Monitor containers for two, consecutive five-minute intervals, the container status switches to Unknown.

Agent plug-ins are components that help Orion agents handle tasks such as polling. See the Orion Platform Administrator Guide for details.

To add a container service:

  1. Review requirements for Supported container environments.
  2. In the Orion Web Console, click Settings > All Settings.
  3. Under Node & Group Management, click Manage Container Services.

  4. On the Container Services page, click Add.

  5. In the Monitor Container Service wizard, provide service details, enter Orion Web Console credentials, and then click Get Script.

    When you add a container service, Orion credentials are stored in a plain-text file that stays in memory for two hours. SolarWinds recommends creating an Orion user account specifically to add container services so no actual user credentials are exposed.

  6. When the installation script appears in the wizard, click the Copy icon to save the code to the Windows Clipboard.

  7. Connect to the node via SSH, open a command line, and run the script provided by the Orion Platform that performs different actions based on the environment type. See Supported container environments for details.

    Need an SSH client? Try the free tool SolarWinds® Solar-PuTTY.

  8. Close the Monitor Container Service wizard and wait for the list of container services to refresh. This may take up to 5 minutes.
  9. Refresh the Orion Web Console to display the new service on the Container Services page.

You can adjust polling intervals for container services on the Global tab of the Advanced Configuration page (http://localhost/Orion/Admin/AdvancedConfiguration/Global.aspx). Changes apply to future container services added to the Orion Platform.