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.
Procedure
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 |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| 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 |
| Rancher 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 | Specify the truststore file name. The observer generates the trust store file based on the file name provided. Tip: You can use the observer name as file name (<observer>.jks), for example rancher.jks. |
Required if enable_secure_host_connection is set to 'true'. The supported format is JKS and the file is relative to $ASM_HOME/security. You must also supply the SSL truststore password to decrypt the HTTPS
truststore file. |
| SSL TrustStore Password | Specify the truststore password the observer will use to decrypt the HTTPS truststore file. Use a password that conforms to your internal security requirements. | Required if enable_secure_host_connection is set to 'true' |
| Access scope | Enter text to provide a scope for the resources. Access scope can help map alerts to resources when resources in different scopes share the same parameters, such as matchTokens. | Optional. Tip: You can define access scope for locations, project names, namespaces, etc. |
| 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 |
| Observer job description | Enter additional information to describe the job | Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |