Host Template: Cloud - OpenStack - Keystone
Overview Copied
Monitor the status of OpenStack services listed by Keystone
This Host Template includes the following Service Checks:
| Service Check Name | Description | Default Thresholds (Metric: Warning, Critical) | UOM |
|---|---|---|---|
| OpenStack - Keystone - Endpoints Status | The status of OpenStack services listed by the Keystone API | endpoints_not_ok: N/A,0 |
N/A |
Note
See details about Monitoring Plugin thresholds here.
Usage Instructions Copied
Please review the overall Cloud - OpenStack Opspack documentation for details on prerequisites, known issues, and other necessary configurations that apply to all Host Templates in the Opspack.
Add this Host Template Copied
Add the Cloud - OpenStack - Keystone Host Template to your Opsview Monitor host. If the resource you’re monitoring has no hostname or public IP, then open the Advanced settings pane and change Host Check Command to Always assumed to be UP.
Note
For more information, refer to the documentation on Adding Host Templates to Hosts.
Add and configure Variables Copied
The Service Checks in this Host Template use the following variables, and they will be added to your Opsview Monitor instance alongside the Host Template:
- OPENSTACK_CREDENTIALS
- OPENSTACK_SERVICE_INTERFACE
- OPENSTACK_KEYSTONE_ENDPOINT
- OPENSTACK_AUTH_DOMAIN
- OPENSTACK_PROJECT_DOMAIN
- OPENSTACK_SERVICE_BLACKLIST
- OPENSTACK_CERTIFICATES
Note
For more information, refer to the documentation on Adding Variables to Hosts.
Apply Changes Copied
Apply Changes and the system will now be monitored:
Additional Information Copied
Service status codes Copied
Any status code within the inclusive range 200-300 is considered OK. Services are verified to ensure they are running and reporting the available version, and where possible the CURRENT version is also validated. Some services (glance, heat, heat-cfn) do not have a specific endpoint that can be queried and hence may return a status 300 for multiple choices.
Troubleshooting Permissions Copied
The Opsview ‘read’ user requires ‘GET’ access to the following Keystone endpoints with ‘system’ scope set to ‘all’:
- /services
- /endpoints
Note
For more information regarding OpenStack Keystone policies, refer to Keystone configuration policy.
Available Variables Copied
OPENSTACK_CREDENTIALS Copied
The Value is not used and therefore can be set to anything.
| Plugin Parameter | Position in Variable | Name | Description |
|---|---|---|---|
| N/A (Opsview UI Only) | Value | OpenStack Credentials | N/A |
--username |
Arg1 | OpenStack Username | The username of your OpenStack monitoring credentials. |
--password |
Arg2 | OpenStack Password | The password of your OpenStack monitoring credentials. |
OPENSTACK_SERVICE_INTERFACE Copied
This is a multi-service check variable. A new service check will be created for each variable added. This way you can have multiple service checks for each different interface on your OpenStack system.
| Plugin Parameter | Position in Variable | Name | Description |
|---|---|---|---|
--openstack-service-interface |
Value | OpenStack Service Interface | The interface you wish to monitor, which can be one of three types: admin, internal, or public. Please note, only interfaces that are reachable by Opsview will work. |
OPENSTACK_KEYSTONE_ENDPOINT Copied
The Value is not used and therefore can be set to anything.
| Plugin Parameter | Position in Variable | Name | Description |
|---|---|---|---|
| N/A (Opsview UI Only) | Value | OpenStack Keystone Endpoint | N/A |
--openstack-keystone-service-protocol |
Arg1 | OpenStack Keystone Protocol | The protocol (HTTP/HTTPS) that the OpenStack keystone service is listening on. |
--openstack-keystone-service-address |
Arg2 | OpenStack Keystone Address | The IP or hostname that the OpenStack keystone service is listening on. |
--openstack-keystone-service-port |
Arg3 | OpenStack Keystone Port | The port that the OpenStack keystone service is listening on. |
OPENSTACK_AUTH_DOMAIN Copied
The Value is not used and therefore can be set to anything. Override the arguments with either your domain name or domain ID to be used for authentication.
| Plugin Parameter | Position in Variable | Name | Description |
|---|---|---|---|
| N/A (Opsview UI Only) | Value | OpenStack Auth Domain | N/A |
--auth-domain-name |
Arg1 | OpenStack Auth Domain Name | The domain name to be used for authentication. |
--auth-domain-id |
Arg2 | OpenStack Auth Domain ID | The domain ID to be used for authentication. |
OPENSTACK_PROJECT_DOMAIN Copied
The Value is not used and therefore can be set to anything. Override the arguments with either your domain name or domain ID for your project.
| Plugin Parameter | Position in Variable | Name | Description |
|---|---|---|---|
| N/A (Opsview UI Only) | Value | OpenStack Project Domain | N/A |
--project-domain-name |
Arg1 | OpenStack Project Domain Name | The domain name of your project. |
--project-domain-id |
Arg2 | OpenStack Project Domain ID | The domain ID for your project. |
OPENSTACK_SERVICE_BLACKLIST Copied
The Value is not used and therefore can be set to anything. Pass in your list of services to ignore as the first argument.
| Plugin Parameter | Position in Variable | Name | Description |
|---|---|---|---|
| N/A (Opsview UI Only) | Value | OpenStack Service Blacklist | N/A |
--service-blacklist |
Arg1 | OpenStack Service Blacklist | A comma-separated list of services. Use this to ignore specific services when checking Keystone listening endpoints. You can find the service names in the Keystone service check output. |
SSL Certificates: OPENSTACK_CERTIFICATES Copied
Opsview Cloud
For Opsview Cloud customers, please contact ITRS Support for assistance with setting up certificate files, as they require Orchestrator access.
Additionally, you can use the OPENSTACK_CERTIFICATES variable to pass in your SSL certificates for use when connecting to the service provider to gather metrics.
The Value is not used and therefore can be set to anything. Override the arguments with your certificates.
| Parameter | Position in Variable | Name | Description |
|---|---|---|---|
--ca-path |
Arg1 | CA Certificate Path | Path to the CA Certificate |
--client-cert |
Arg2 | Client Certificate Path | Path to the Client Certificate |
--client-key |
Arg3 | Client Key Path | Path to the Client Key |
Plugin help Copied
Plugin: check_ostack
Secure Args
This plugin uses the Secure Args feature for argument passing.
For mode-specific help, run the plugin with the -h -m <mode> flags. This will list the required and optional Variable Arguments for that mode.
The appropriate mode for each Service Check is listed here:
| Service Check Name | Mode |
|---|---|
| OpenStack - Keystone - Endpoints Status | OpenStack.Keystone.Services |