Configuring Rancher Observer jobs

Using the Rancher Observer, you can define a full load job that will read data from Rancher through the REST API and generate a topology.

Before you begin

Important: The Rancher Observer supports the on-premises Rancher version 2.3.2 and API version 3.0.

Ensure you have the Rancher details to hand, such as the Rancher host IP, accessKey, secretKey and clusterId, before running the observer job.

The Rancher Observer supports a transient (one-off) Load job that loads all requested topology data through Rancher REST API to build the topology, and then exit.

You define and start the following job. You must edit the parameters in the configuration file before running this job.

Full Topology Upload job By default, Load jobs are one-off, transient jobs that do a full upload of all requested topology data as soon as they are triggered.

You can also run these jobs (again) manually from the Observer UI, or schedule them to run at set times when configuring them.

Enabling access to the URL routes

To access the URL routes for the topology Swagger documentation, see the Enabling access to URL routes topic.


Define or edit the following parameters, then click Run job to save and run the job.

Encryption requirement: See the Configuring observer jobs security topic for more information.

Parameter Action Details
Rancher Host IP Enter the Rancher host IP address Required
Rancher Access Key ID Supply the Rancher access key Required
Rancher Secret Access Key Supply the Rancher secret key Required
Rancher Cluster ID Enter the cluster ID to be discovered Required
Enable/Disable Secure Host Connection to Rancher's Host Set to 'true' to secure the connection. Alternatively, set to 'false' to bypass secure host connection. Required
Certificate If enable_secure_host_connection is set to 'true', update the global secret with encrypted certificate information. See the relevant step here. Optional
SSL truststore File If enable_secure_host_connection is set to 'true', provide the JKS name, and the observer creates the JKS file Optional
Password SSL truststore File If enable_secure_host_connection is set to 'true', set the password to decrypt the HTTPS truststore file. Required if enable_secure_host_connection is set to 'true'. You must supply the SSL truststore Password to decrypt the HTTPS truststore file.
Generate debug support file Set this parameter to 'True' in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request of your designated Support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to 'False' after the next completed run. To examine the output produced, you can load the generated debug file using the File Observer. Optional
Job schedule Specify when the job runs Optional. Load jobs only.
Observer job description Enter additional information to describe the job Optional