NAME

IO::K8s::PrometheusOperator::V1alpha1::OpenStackSDConfig - OpenStackSDConfig allow retrieving scrape targets from OpenStack Nova instances.

VERSION

version 1.108

allTenants

allTenants defines whether the service discovery should list all instances for all projects. It is only relevant for the 'instance' role and usually requires admin permissions.

applicationCredentialId

applicationCredentialId defines the OpenStack applicationCredentialId.

applicationCredentialName

applicationCredentialName defines the ApplicationCredentialID or ApplicationCredentialName fields are required if using an application credential to authenticate. Some providers allow you to create an application credential to authenticate rather than a password.

applicationCredentialSecret

applicationCredentialSecret defines the required field if using an application credential to authenticate.

availability

availability defines the availability of the endpoint to connect to.

domainID

domainID defines The OpenStack domainID.

domainName

domainName defines at most one of domainId and domainName that must be provided if using username with Identity V3. Otherwise, either are optional.

identityEndpoint

identityEndpoint defines the HTTP endpoint that is required to work with the Identity API of the appropriate version.

password

password defines the password for the Identity V2 and V3 APIs. Consult with your provider's control panel to discover your account's preferred method of authentication.

port

port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule.

projectID

projectID defines the OpenStack projectID.

projectName

projectName defines an optional field for the Identity V2 API. Some providers allow you to specify a ProjectName instead of the ProjectId. Some require both. Your provider's authentication policies will determine how these fields influence authentication.

refreshInterval

refreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.

region

region defines the OpenStack Region.

role

role defines the OpenStack role of entities that should be discovered.

Note: The `LoadBalancer` role requires Prometheus >= v3.2.0.

tlsConfig

tlsConfig defines the TLS configuration applying to the target HTTP endpoint.

userid

userid defines the OpenStack userid.

username

username defines the username required if using Identity V2 API. Consult with your provider's control panel to discover your account's username. In Identity V3, either userid or a combination of username and domainId or domainName are needed

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/pplu/io-k8s-p5/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHORS

  • Torsten Raudssus <getty@cpan.org>

  • Jose Luis Martinez Torres <jlmartin@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2026 by Jose Luis Martinez Torres <jlmartin@cpan.org>.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004