Openstack Service Checks

  • By Canonical BootStack Charmers
  • Cloud
Channel Revision Published Runs on
latest/stable 46 05 Dec 2023
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
latest/candidate 46 05 Dec 2023
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
latest/edge 48 25 Jan 2024
Ubuntu 22.04 Ubuntu 20.04 Ubuntu 18.04
juju deploy openstack-service-checks
Show information

Platform:

Ubuntu
22.04 20.04 18.04
  • allocations-instances-ignored | string

    Comma separated list of VM UUIDs to ignore in placement checks.

  • check-allocations | boolean

    Default: True

    Switch to turn on or off check for allocation inconsistencies between nova and placement.

  • check-dns | string

    A space-separated list of DNS names to check. If any of the names are not resolvable, alert as CRITICAL.

  • check-floating-ips | string

    Default: all

    List of OpenStack floating ips IDs to be checked by NRPE check. All values must be separated by a comma or 'all' can be entered.

  • check-horizon | boolean

    Switch to turn on or off check for horizon connectivity and login. A website relation with openstack-dashboard(horizon) is a prerequisite.

  • check-masakari | boolean

    Switch to turn on or off check for masakari segment hosts

  • check-mysql-innodb-cluster | boolean

    Switch to turn on or off check for mysql innodb cluster

  • check-networks | string

    List of OpenStack networks IDs to be checked by NRPE check. All values must be separated by a comma and the value `all` is not allowed.

  • check-neutron-agents | boolean

    Default: True

    Switch to turn on or off neutron agents checks. By default, neutron_agents nrpe check is enabled. If a different SDN (ie. Contrail) is in use, you may want to disable this check.

  • check-octavia | boolean

    Default: True

    Switch to turn on or off check for octavia services.

  • check-port-security | boolean

    Switch to turn on or off check for port security. If hardware offloading is used on a port, port security must be disabled.

  • check-ports | string

    Default: all

    List of OpenStack ports IDs to be checked by NRPE check. All values must be separated by a comma or 'all' can be entered.

  • check-rally | boolean

    Switch to turn on or off rally checks via the fcbtest snap. By default, rally nrpe check is disabled.

  • check-security-groups | string

    List of OpenStack security group IDs to be checked by NRPE check. All values must be separated by a comma and the value `all` is not allowed.

  • check-servers | string

    Default: all

    List of OpenStack servers IDs to be checked by NRPE check. All values must be separated by a comma or 'all' can be entered.

  • check-ssl-cert-maximum-validity | int

    Option to set the maximum validity check value used by the check_ssl_cert script. By default, this value is unset and check_ssl_cert will use its' own default. Use non-negative values to set --maximum-validity, use -1 to disable maximum-validity check altogether. (--ignore-maximum-validity)

  • check-subnets | string

    List of OpenStack subnets IDs to be checked by NRPE check. All values must be separated by a comma and the value `all` is not allowed.

  • check_admin_urls | boolean

    Default: True

    If true, create NRPE checks matching all 'admin' URLs in the Keystone catalog.

  • check_internal_urls | boolean

    Default: True

    If true, create NRPE checks matching all 'internal' URLs in the Keystone catalog.

  • check_public_urls | boolean

    Default: True

    If true, create NRPE checks matching all 'public' URLs in the Keystone catalog.

  • check_ssl_cert_ignore_ocsp | boolean

    Pass --ignore-ocsp option to check_ssl_cert script.

  • contrail_analytics_vip | string

    The VIP used for Contrail Analytics. Leave blank to disable Contrail monitoring.

  • contrail_ignored_alarms | string

    Default: vrouter,

    Comma separated list of contrail alerts to ignore

  • email_from_addr | string

    From address when sending email notifications.

  • email_recipients | string

    Comma separated list of email recipients to send notifications on demand.

  • nagios_context | string

    Default: juju

    Used by the nrpe subordinate charms. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like: juju-myservice-0 If you're running multiple environments with the same services in them this allows you to differentiate between them.

  • nagios_servicegroups | string

    A comma-separated list of nagios servicegroups. If left empty, the nagios_context will be used as the servicegroup

  • nova_crit | int

    Default: 1

    Critical level for nova aggregate unit count check - setting this to -1 will effectively disable host aggregate checks.

  • nova_warn | int

    Default: 2

    Warning level for nova aggregate unit count check - setting this to -1 will effectively disable host aggregate checks.

  • octavia-amp-image-days | int

    Default: 365

    If latest glance image tagged with above octavia-amp-image-tag is updated more than these days ago, a Nagios warning will be raised. The version of octavia agent builtin in amphora image must match version of octavia controller, otherwise octavia will fail to communicate with new amphora, failover will also fail.

  • octavia-amp-image-tag | string

    Default: octavia-amphora

    The glance image tag octavia will use to create amphora.

  • octavia-amphorae-ignored | string

    Comma separated list of octavia amphorae alerts to ignore

  • octavia-image-ignored | string

    Comma separated list of octavia image alerts to ignore

  • octavia-loadbalancers-ignored | string

    Comma separated list of octavia load balancer alerts to ignore

  • octavia-pools-ignored | string

    Comma separated list of octavia pool alerts to ignore

  • os-credentials | string

    Comma separated OpenStack credentials to be used by nagios. It is strongly recommended this be a user with a dedicated role, and not a full admin. Takes the mandatory format of username=foo, password=bar, credentials_project=baz, region_name=Region1, auth_url=http://127.0.0.1:35357, volume_api_version=3 If using keystone v3 (as evident when the auth_url ends with /v3), then the parameter domain=qux needs to be specified as well.

  • rally-cron-schedule | string

    Default: */15 * * * *

    Cron schedule used to run the rally tests. Default value is every 15 minutes. Furthermore, the cronjob is scheduled to time out after 13 minutes (SIGTERM) or 14 minutes (SIGKILL).

  • s3_check_params | string

    Default: /healthcheck

    URL to use with check_http if there is an S3 endpoint. Default is '/healthcheck', but it's possible to add extra params, e.g. '/v3 -e Unauthorized -d x-openstack-request-id' or a different url, e.g. '/' (when the endpoint is used with ceph-radosgw for example).

  • skip-disabled | boolean

    An option to specify whether you want Warning alerts in nagios for disabled nova-compute hosts.

  • skip-floating-ips | string

    List of OpenStack floating ips IDs to be skipped by the NRPE check. All values must be separated by a comma. The condition for using this option is to set "check-floating-ips" to "all" or this value will raise an error.

  • skip-ports | string

    List of OpenStack ports IDs to be skipped by the NRPE check. All values must be separated by a comma. The condition for using this option is to set "check-ports" to "all" or this value will raise an error.

  • skip-rally | string

    Comma separated list of OpenStack components to not monitor. An empty string means all components will be monitored (up to the number of currently supported components: Cinder, Glance, Nova, Neutron). Sample: skip-rally=cinder

  • skip-servers | string

    List of OpenStack servers IDs to be skipped by the NRPE check. All values must be separated by a comma. The condition for using this option is to set "nrpe-server-ids" to "all" or this value will raise an error.

  • skipped_host_aggregates | string

    Comma separated list of host aggregates that need to be skipped from checks. Example "Agg1,AGg2" or 'Aggregate3'. This is a case-insensitive option.

  • snapd_refresh | string

    How often snapd handles updates for installed snaps. The default (an empty string) is 4x per day. Set to "max" to check once per month based on the charm deployment date. You may also set a custom string as described in the 'refresh.timer' section here: https://forum.snapcraft.io/t/system-options/87

  • swift_check_params | string

    Default: /

    URL to use with check_http if there is a Swift endpoint. Default is '/', but it's possible to add extra params, e.g. '/v3 -e Unauthorized -d x-openstack-request-id' or a different url, e.g. '/healthcheck'. Mitaka Swift typically needs '/healthcheck'.

  • tls_crit_days | int

    Default: 14

    Number of days left for the TLS certificate to expire before alerting Critical.

  • tls_warn_days | int

    Default: 30

    Number of days left for the TLS certificate to expire before warning.

  • trusted_ssl_ca | string

    base64 encoded SSL ca cert to use for OpenStack API client connections. Note that it should only contain exactly one certificate, presumably the root certificate. For more information, you can refer to the man page of `update-ca-certificates` and `openssl rehash`.