Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and lint discovery.openstack to discovery.uyuni #2435

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
+470 −438
Open

Update and lint discovery.openstack to discovery.uyuni #2435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
41105b4
Update openstack topic
clayton-cornell Jan 16, 2025
7a8c4b8
Update ovhcloud topic
clayton-cornell Jan 16, 2025
b8a8a1d
Update process topic
clayton-cornell Jan 16, 2025
1d98dfd
Updated PuppetDB topic
clayton-cornell Jan 16, 2025
e8944f3
Update relabel topic
clayton-cornell Jan 16, 2025
4a5b9cd
Update Scaleway topic
clayton-cornell Jan 17, 2025
a059afb
Update serverset topic
clayton-cornell Jan 17, 2025
a1fad2c
Update triton topic
clayton-cornell Jan 17, 2025
724dec3
Update uyuni topic
clayton-cornell Jan 17, 2025
b9f56da
Updated styles, and added missing descriptions
clayton-cornell Jan 21, 2025
ca64efa
Additional cleanup and fixes
clayton-cornell Jan 21, 2025
d15cc99
Fix up some missing syntax
clayton-cornell Jan 21, 2025
f92a5b3
Fix capitalization typo
clayton-cornell Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 74 additions & 72 deletions docs/sources/reference/components/discovery/discovery.openstack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,62 +15,63 @@ title: discovery.openstack
## Usage

```alloy
discovery.openstack "LABEL" {
role = "hypervisor"
region = "us-east-1"
discovery.openstack "<LABEL>" {
role = "<OPENSTACK_ROLE>"
region = "<OPENSTACK_REGION>"
}
```

## Arguments

The following arguments are supported:

Name | Type | Description | Default | Required
--------------------------------|------------|------------------------------------------------------------------------------------------------------|----------|---------
`role` | `string` | Role of the discovered targets. | | yes
`region` | `string` | OpenStack region. | | yes
`identity_endpoint` | `string` | Specifies the HTTP endpoint that is required to work with te Identity API of the appropriate version | | no
`username` | `string` | OpenStack username for the Identity V2 and V3 APIs. | | no
`userid` | `string` | OpenStack userid for the Identity V2 and V3 APIs. | | no
`password` | `secret` | Password for the Identity V2 and V3 APIs. | | no
`domain_name` | `string` | OpenStack domain name for the Identity V2 and V3 APIs. | | no
`domain_id` | `string` | OpenStack domain ID for the Identity V2 and V3 APIs. | | no
`project_name` | `string` | OpenStack project name for the Identity V2 and V3 APIs. | | no
`project_id` | `string` | OpenStack project ID for the Identity V2 and V3 APIs. | | no
`application_credential_name` | `string` | OpenStack application credential name for the Identity V2 and V3 APIs. | | no
`application_credential_id` | `string` | OpenStack application credential ID for the Identity V2 and V3 APIs. | | no
`application_credential_secret` | `secret` | OpenStack application credential secret for the Identity V2 and V3 APIs. | | no
`all_tenants` | `bool` | Whether the service discovery should list all instances for all projects. | `false` | no
`refresh_interval` | `duration` | Refresh interval to re-read the instance list. | `60s` | no
`port` | `int` | The port to scrape metrics from. | `80` | no
`availability` | `string` | The availability of the endpoint to connect to. | `public` | no
You can use the following arguments with `discovery.openstack`:

Name | Type | Description | Default | Required
--------------------------------|------------|-------------------------------------------------------------------------------------------------------|----------|---------
`region` | `string` | OpenStack region. | | yes
`role` | `string` | Role of the discovered targets. | | yes
`all_tenants` | `bool` | Whether the service discovery should list all instances for all projects. | `false` | no
`application_credential_id` | `string` | OpenStack application credential ID for the Identity V2 and V3 APIs. | | no
`application_credential_name` | `string` | OpenStack application credential name for the Identity V2 and V3 APIs. | | no
`application_credential_secret` | `secret` | OpenStack application credential secret for the Identity V2 and V3 APIs. | | no
`availability` | `string` | The availability of the endpoint to connect to. | `public` | no
`domain_id` | `string` | OpenStack domain ID for the Identity V2 and V3 APIs. | | no
`domain_name` | `string` | OpenStack domain name for the Identity V2 and V3 APIs. | | no
`identity_endpoint` | `string` | Specifies the HTTP endpoint that is required to work with the Identity API of the appropriate version | | no
`password` | `secret` | Password for the Identity V2 and V3 APIs. | | no
`port` | `int` | The port to scrape metrics from. | `80` | no
`project_id` | `string` | OpenStack project ID for the Identity V2 and V3 APIs. | | no
`project_name` | `string` | OpenStack project name for the Identity V2 and V3 APIs. | | no
`refresh_interval` | `duration` | Refresh interval to re-read the instance list. | `60s` | no
`userid` | `string` | OpenStack user ID for the Identity V2 and V3 APIs. | | no
`username` | `string` | OpenStack username for the Identity V2 and V3 APIs. | | no

`role` must be one of `hypervisor` or `instance`.

`username` is required if using Identity V2 API. In Identity V3, either `userid` or a combination of `username` and `domain_id` or `domain_name` are needed.

`project_id` and `project_name` fields are optional for the Identity V2 API.
Some providers allow you to specify a `project_name` instead of the `project_id`. Some require both.
`all_tenants` is only relevant for the `instance` role and usually requires administrator permissions.

`application_credential_id` or `application_credential_name` 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.

`application_credential_secret` field is required if using an application credential to authenticate.

`all_tenants` is only relevant for the `instance` role and usually requires admin permissions.

`availability` must be one of `public`, `admin`, or `internal`.

`project_id` and `project_name` fields are optional for the Identity V2 API.
Some providers allow you to specify a `project_name` instead of the `project_id` and some require both.

`username` is required if using Identity V2 API. In Identity V3, either `userid` or a combination of `username` and `domain_id` or `domain_name` are needed.

## Blocks
The following blocks are supported inside the definition of `discovery.openstack`:

Hierarchy | Block | Description | Required
-----------|----------------|------------------------------------------------------|---------
tls_config | [tls_config][] | TLS configuration for requests to the OpenStack API. | no
You can use the following blocks with `discovery.openstack`:

Block | Description | Required
---------------|------------------------------------------------------|---------
[tls_config][] | TLS configuration for requests to the OpenStack API. | no

[tls_config]: #tls_config-block
[tls_config]: #tls_config

### tls_config block
### tls_config

{{< docs/shared lookup="reference/components/tls-config-block.md" source="alloy" version="<ALLOY_VERSION>" >}}

Expand All @@ -82,35 +83,34 @@ Name | Type | Description
----------|---------------------|------------------------------------------------------
`targets` | `list(map(string))` | The set of targets discovered from the OpenStack API.

#### `hypervisor`
### hypervisor

The `hypervisor` role discovers one target per Nova hypervisor node. The target
address defaults to the `host_ip` attribute of the hypervisor.
The `hypervisor` role discovers one target per Nova hypervisor node.
The target address defaults to the `host_ip` attribute of the hypervisor.

* `__meta_openstack_hypervisor_host_ip`: the hypervisor node's IP address.
* `__meta_openstack_hypervisor_hostname`: the hypervisor node's name.
* `__meta_openstack_hypervisor_id`: the hypervisor node's ID.
* `__meta_openstack_hypervisor_state`: the hypervisor node's state.
* `__meta_openstack_hypervisor_status`: the hypervisor node's status.
* `__meta_openstack_hypervisor_type`: the hypervisor node's type.
* `__meta_openstack_hypervisor_host_ip`: The hypervisor node's IP address.
* `__meta_openstack_hypervisor_hostname`: The hypervisor node's name.
* `__meta_openstack_hypervisor_id`: The hypervisor node's ID.
* `__meta_openstack_hypervisor_state`: The hypervisor node's state.
* `__meta_openstack_hypervisor_status`: The hypervisor node's status.
* `__meta_openstack_hypervisor_type`: The hypervisor node's type.

#### `instance`
### instance

The `instance` role discovers one target per network interface of Nova
instance. The target address defaults to the private IP address of the network
interface.
The `instance` role discovers one target per network interface of Nova instance.
The target address defaults to the private IP address of the network interface.

* `__meta_openstack_address_pool`: the pool of the private IP.
* `__meta_openstack_instance_flavor`: the flavor of the OpenStack instance.
* `__meta_openstack_instance_id`: the OpenStack instance ID.
* `__meta_openstack_instance_image`: the ID of the image the OpenStack instance is using.
* `__meta_openstack_instance_name`: the OpenStack instance name.
* `__meta_openstack_instance_status`: the status of the OpenStack instance.
* `__meta_openstack_private_ip`: the private IP of the OpenStack instance.
* `__meta_openstack_project_id`: the project (tenant) owning this instance.
* `__meta_openstack_public_ip`: the public IP of the OpenStack instance.
* `__meta_openstack_tag_<tagkey>`: each tag value of the instance.
* `__meta_openstack_user_id`: the user account owning the tenant.
* `__meta_openstack_address_pool`: The pool of the private IP.
* `__meta_openstack_instance_flavor`: The flavor of the OpenStack instance.
* `__meta_openstack_instance_id`: The OpenStack instance ID.
* `__meta_openstack_instance_image`: The ID of the image the OpenStack instance is using.
* `__meta_openstack_instance_name`: The OpenStack instance name.
* `__meta_openstack_instance_status`: The status of the OpenStack instance.
* `__meta_openstack_private_ip`: The private IP of the OpenStack instance.
* `__meta_openstack_project_id`: The project (tenant) owning this instance.
* `__meta_openstack_public_ip`: The public IP of the OpenStack instance.
* `__meta_openstack_tag_<tagkey>`: Each tag value of the instance.
* `__meta_openstack_user_id`: The user account owning the tenant.

## Component health

Expand All @@ -119,18 +119,18 @@ In those cases, exported fields retain their last healthy values.

## Debug information

`discovery.openstack` does not expose any component-specific debug information.
`discovery.openstack` doesn't expose any component-specific debug information.

## Debug metrics

`discovery.openstack` does not expose any component-specific debug metrics.
`discovery.openstack` doesn't expose any component-specific debug metrics.

## Example

```alloy
discovery.openstack "example" {
role = OPENSTACK_ROLE
region = OPENSTACK_REGION
role = <OPENSTACK_ROLE>
region = <OPENSTACK_REGION>
}

prometheus.scrape "demo" {
Expand All @@ -140,21 +140,23 @@ prometheus.scrape "demo" {

prometheus.remote_write "demo" {
endpoint {
url = PROMETHEUS_REMOTE_WRITE_URL
url = <PROMETHEUS_REMOTE_WRITE_URL>

basic_auth {
username = USERNAME
password = PASSWORD
username = <USERNAME>
password = <PASSWORD>
}
}
}
```

Replace the following:
- `OPENSTACK_ROLE`: Your OpenStack role.
- `OPENSTACK_REGION`: Your OpenStack region.
- `PROMETHEUS_REMOTE_WRITE_URL`: The URL of the Prometheus remote_write-compatible server to send metrics to.
- `USERNAME`: The username to use for authentication to the remote_write API.
- `PASSWORD`: The password to use for authentication to the remote_write API.

* _`<OPENSTACK_ROLE>`_: Your OpenStack role.
* _`<OPENSTACK_REGION>`_: Your OpenStack region.
* _`<PROMETHEUS_REMOTE_WRITE_URL>`_: The URL of the Prometheus remote_write-compatible server to send metrics to.
* _`<USERNAME>`_: The username to use for authentication to the `remote_write` API.
* _`<PASSWORD>`_: The password to use for authentication to the `remote_write` API.

<!-- START GENERATED COMPATIBLE COMPONENTS -->

Expand Down
Loading
Loading