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 specify details about a service and generate an environment-specific script that will:

  • 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 the master server 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.

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.

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

To add a container service:

  1. Review container monitoring requirements.
  2. Click Settings > All Settings.
  3. Under Node & Group Management, click Manage Container Services.

  4. When the Container Services page appears, click Add.

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

  6. 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 add container services, Orion credentials are stored in a plain text YAML 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.

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

  8. Use an SSH client to connect to the Linux node that hosts containers and:

    1. Open a command line.
    2. Copy the generated script added to the Windows Clipboard in step 7.
    3. Run the script to deploy the Orion Monitor and Orion Aggregator containers to the node.
  9. Return to the Orion Web Console and exit the wizard.

  10. Refresh the Orion Web Console to display the new service on the Container Services page. This may take up to 5 minutes.

When you upgrade SAM or VMAN, rebuild containers and add container services again to refresh YAML files and agents plugins. Click here for details.