Documentation forOrion Platform

Add a container service

This Orion Platform topic applies only to the following products:

SAMVMAN

You can use the Add Container Service wizard to add specify details about a container service and generate an environment-specific script that will:

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

If FIPS mode is enabled, you cannot add container services.

The wizard will prompt you to connect to the Linux node via SSH, open a command line, and run the script to deploy the Orion containers, which act as Orion agents to report data to the Orion Platform. 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.

An Orion Administrator account is required to add container services. Orion credentials are stored in a plain text file that stays in memory for two hours. SolarWinds recommends creating a dedicated Orion user account to manage container services so critical credentials are not exposed.

To add a container service:

  1. Log into the Orion Web Console as an Orion administrator.
  2. Add each Linux server that hosts containers as a managed Orion node using ICMP as the Polling Method, per Container monitoring requirements. To monitor all containers in a single cluster, add each server from the cluster as a separate Orion node.

    If working with the Azure Kubernetes Service (AKS), add the Kubernetes API server as a managed Orion node.

  3. Click Settings > All Settings.
  4. Under Node & Group Management, click Manage Container Services.
  5. When the Container Services page appears, click Add.

  6. On the first page of the Add Container Service wizard, provide service details, and then click Next.

  7. On the Orion credentials page, provide a Username and select the optional "User secure connection" check box. Click Next to advance to the Script page.

    When you add a service, Orion credentials are stored in a plain text file that stays in memory for two hours. SolarWinds recommends creating a dedicated Orion user account to manage container services so critical credentials are not exposed.

  8. On the Script page, click the Copy icon to save the script generated by the Orion Platform to the Windows Clipboard.

  9. Use an SSH client to connect to the Linux server that hosts containers, and then:

    1. Open a command line.
    2. Paste the generated script from the Windows Clipboard.
    3. Run the script to deploy the Orion Monitor and Orion Aggregator containers to the node.

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

  10. Return to the Orion Web Console and exit the wizard.

  11. Refresh the Orion Web Console to display the new service on the Container Services page. This may take up to 5 minutes. If expected data does not appear, see Troubleshoot container monitoring.

SolarWinds documentation describes how to display container data in the Orion Web Console. To learn about manipulating containers directly, refer to third-party documentation provided by the vendor. For example, to learn about swarm mode, see Docker docs (© 2020 Docker, Inc., available at docs.docker.com, obtained on October 26, 2020.)