Configuring Contrail Observer jobs
Using the Contrail Observer, you can retrieve topology data from Juniper Network Contrail Release 4.1 through REST APIs exposed by the Contrail apiserver. This observer is developed against Juniper Network Contrail that integrates with OpenStack orchestration platform (Ubuntu 18.04 + Contrail Cloud - Ocata).
Before you begin
Important: The Contrail Observer supports the on-premises Contrail version 4.1.0.
Ensure you have the Contrail API Server and OpenStack credentials details to hand. For rabbitmq jobs, you must also specify the location of the RabbitMQ queue and its authentication details.
About this task
You define and start the following jobs.
Rabbitmq Listen job
A long-running job that monitors its source for updates and runs until it is explicitly stopped, or until the Observer is stopped.
This job loads all supported resources during startup, and listens to RabbitMQ messages from 'vnc_config.object-update' fanout exchange.
The restapi job does not have to be run before running the rabbitmq job because the rabbitmq job performs a restapi job during initialization.
Restapi Load job
This job loads all supported resources.
Run this job whenever you need the Contrail topology data refreshed.
By default, Load jobs are one-off, transient jobs that upload all of the requested topology data as soon as they are triggered.
You can also run these jobs (again) 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.
Rabbitmq Listen job parameters
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| RabbitMQ hostname or IP address | Enter a hostname or IP address for the RabbitMQ server | Required |
| RabbitMQ port | Specify the port for connection | Required |
| RabbitMQ username | Specify the username for authentication with RabbitMQ | Required |
| RabbitMQ password | Enter the password for authentication with RabbitMQ | Required |
| RabbitMQ virtual host | Enter the RabbitMQ virtual hostname | Optional. Default is /. |
| Contrail API URL | Specify the URL for the Contrail apiserver | Required |
| OpenStack Authentication URL | Enter the authentication URL for the identity service | Required |
| OpenStack username | Specify the OpenStack username to connect as (or to) | Required |
| OpenStack password | Specify the OpenStack password with which to authenticate | Required |
| Authentication type | Specify the authentication type used. | Optional. The default is Keystone. The other option is None. |
| OpenStack project domain name | Specify the OpenStack project domain name | Optional |
| OpenStack user domain name | Specify the OpenStack project user domain name | Optional |
| OpenStack project name | Enter the OpenStack project name for version 3 authentication | Optional |
| OpenStack tenant name | Enter the OpenStack tenant name for version 2 authentication | Optional |
| OpenStack identity API version | Select an option from the drop-down list | Optional |
| Connection and read timeout (milliseconds) | Choose the time at which the connection and read action times out | Optional. Must be a value greater than 0 (zero). The default is 5000 (5 seconds). |
| 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 |
Restapi Load job parameters
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| Contrail API URL | Specify the URL for the Contrail API server | Required |
| OpenStack Authentication URL | Enter the authentication URL for the identity service | Required |
| OpenStack username | Specify the OpenStack username to connect as (or to) | Required |
| OpenStack password | Specify the OpenStack password with which to authenticate | Required |
| Authentication type | Specify the authentication type used | Optional. The default is Keystone, the other option is None. |
| OpenStack project domain name | Specify the OpenStack project domain name | Optional |
| OpenStack user domain name | Specify the OpenStack project user domain name | Optional |
| OpenStack project name | Enter the OpenStack project name for version 3 authentication | Optional |
| OpenStack tenant name | Enter the OpenStack tenant name for version 2 authentication | Optional |
| OpenStack identity API version | Select an option from the drop-down list | Optional |
| Connection and read timeout (milliseconds) | Choose the time at which the connection and read action times out | Optional. Must be a value greater than 0 (zero). The default is 5000 (5 seconds). |
| 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 |