Overview

OpsRamp’s collector bootstrap is a small and flexible tool designed to simplify and automate day-0 onboarding of all OpsRamp’s collector technologies - agent, gateway into myriad of IT environments - bare-metal, virtualized, containerized and cloud-native environments on various host OS’s (Linux, macOS, Windows) be it either on-prem or in the public cloud.

Once you download the right binary from the cloud platform into your target operating system - macOS, Linux, Windows, you can instruct the tool via its command line interface (CLI) to kickstart the collector installation. In a single command, the tool not only verifies the host environment that will eventually house the collector but also automates what are currently manual steps around authentication and registration of the collector with the cloud platform. The tool can be optionally instructed, in the same command, to start infrastructure discovery automatically without requiring any additional configuration on the cloud side.

How to download the Collector Bootstrap Tool ?

While the collector bootstrap tool can be downloaded into any machine (into your laptop, for example), the tool is expected to be executed from the same host as you will eventually run the collector. So, please transfer a copy of the binary into the target host if you are downloading this temporarily into your local machine.

Download the NextGen gateway binary

Download the nextGen gateway binary, use the below links as per your operating system and run it into your environment.

Linux:

Windows:

Mac:

wget download-link:

bootstrap
Check opsramp-collector version:
bootstrap

Available Commands

CommandsDescription
installDownload and register the collector (agent, gateway)
uninstallUnregister and delete the collector
setupSetup kubernetes and high availability

Available Flag

FlagsDescription
--version (-v)It is used to check the collector version

How to use the Collector Bootstrap Tool ?

Install the Collector

Use the following command to install the collector. The collector bootstrap needs sudo privileges.

opsramp-collector-start install --help

Flags for installation commands

FlagsDescription
--config (-c)Initial discovery configuration
--enable-squid (-s)Enable squid proxy service (enable/disable)
--environment (-e)Environment to install OpsRamp gateway
--key (k)Gateway unique authentication token
--proxy-ip (i)Used to get the proxy server ip address
--proxy-password (p)Used to get the proxy server password
--proxy-port (-p)Used to get the proxy server port
--proxy-protocol (-r)Proxy server communication protocol
--proxy-username (-u)Used to get the proxy server username
--thirdPartyApp (-t)Enable or disable third party app integration
--url (-u)It is used to specify Opsramp url
--namespace (-n)Namespace to deploy gateway in k8s environment

Management Profile

To find the activation token and API server url, navigate to Setup > Resources > Management Profile and click on the name of your newly created profile.

Activation auth token: 55c803a1-2e2f-4c07-be95-479dc8fdf7ff

bootstrap

Cloud url API server: gatewaytest.api.opsramp.net

bootstrap

Registering environments

Use the following commands to register the kubernetes and docker.

Installing gateway in a kubernetes environment:

bootstrap
Pod status:
bootstrap
Installing gateway in a docker environment:
bootstrap
Containers status:
bootstrap

Successful gateway registration

Once the CLI returns successfully, navigate to Setup > Resource > Management Profile to check if the Gateway registered successfully.

Gateway connection status:

bootstrap

Installing gateway through proxy

Often customers will not be allowed to connect to their network directly for security reasons, customers will install proxy in their environment and will allow the third party users to connect to their network through proxy.

Opsramp Gateways are deployed in customer environments, so in order to connect to an outside network from Gateway it needs to pass through a proxy.

The customers who have proxies installed in their environment, need to use the below gateway installation command for registration.

The examples below show how to register the gateway through proxy method. The collector will try to register the gateway, once it’s installed, through the proxy. The tool supports registration with or without credentials as shown below:

  • Register through proxy with credentials
    opsramp-collector-start install -e {Environment} –-url {OpsRamp Server URL} –-key {Gateway unique authentication token} --proxy-protocol {Proxy Protocol http/https} --proxy-ip {Proxy IP Address} --proxy-port {Proxy Port} --proxy-username {Proxy Username} --proxy-password {Proxy Password}
  • Register through proxy without credentials
    opsramp-collector-start install -e {Environment} –-url {OpsRamp Server URL} –-key {Gateway unique authentication token} --proxy-protocol {Proxy Protocol http/https} --proxy-ip {Proxy IP Address} --proxy-port {Proxy Port}

Uninstall the Collector

Use the following commands to uninstall the collector.

sudo opsramp-collector-start uninstall -e {Environment}

Available Flags

FlagsDescription
--environment (-e)It is used to specify on which environment nextgen gateways is available
--namespace (-n)k8s namespace (This is used only in kubernetes environments)

Uninstallation of kubernetes:

bootstrap
Uninstallation of docker:
bootstrap

Once the CLI returns successfully, navigate to Setup > Resource > Management Profile to check if the Gateway is de-registered successfully.

Gateway connection status:

bootstrap

Troubleshooting

Following are the errors if any CLI failures.

  • Incorrect cloud api server url:
    bootstrap
  • Re-registering gateway:
    bootstrap
  • Kubernetes is not reachable:
    bootstrap
  • Docker is not reachable:
    bootstrap

Limitations

This version currently only supports the Gateway collector and support for Agent collectors will come in a future version of the tool.