Terraform Provider HPEUXI - Terraform Provider HPEUXI
- Terraform Provider HPEUXI - Terraform Provider HPEUXI
A repository to hold the HPEUXI terraform provider.
See the INSTALL.md file for instructions on how to install the binaries manually.
- Terraform version >= v1.7.0 and 64-bit install terraform
- A Greenlake API client to authenticate against UXI configuration API.
- Terraform basics. Terraform Introduction
Make sure you have the correct Terraform version installed; It must be v1.7.0 or later:
terraform version
Create a Terraform file in your working directory, and reference the desired provider version from the terraform registry. For more information please consult the documentation:
terraform {
required_providers {
hpeuxi = {
source = "aruba-uxi/hpeuxi"
version = ">= 0.0.0-pre.alpha.3"
}
}
required_version = ">= 1.7.0"
}
# create a group
resource "hpeuxi_group" "my_group" {
name = "level_1"
}
# import a sensor
resource "hpeuxi_sensor" "my_sensor" {
name = "my_sensor_name"
lifecycle {
prevent_destroy = true
}
}
import {
to = hpeuxi_sensor.my_sensor
id = "my_sensor_id"
}
# assign the sensor to a group
resource "hpeuxi_sensor_group_assignment" "my_uxi_sensor_group_assignment" {
sensor_id = hpeuxi_sensor.my_sensor.id
group_id = hpeuxi_group.my_group.id
}
export HPEUXI_CLIENT_ID=<hpeuxi_client_id>
export HPEUXI_CLIENT_SECRET=<hpeuxi_client_secret>
To override the host against which the API requests are made, use the env var as shown below, else UXI production is used as the default.
export HPEUXI_HOST_OVERRIDE=api.staging.capedev.io
> terraform init
> terraform plan
> terraform apply
Add the appropriate terraform provider dev override to your ~/.terraformrc
file to ensure that that terraform operations is performed against the local provider.
Example ~/.terraformrc
file
provider_installation {
dev_overrides {
"registry.terraform.io/aruba-uxi/hpeuxi" = "/Users/<user>/go/bin"
}
direct {}
}
Install just. This is used to run
the recipes defined in the Justfile
. Run the following to see a helpful list of commands:
just help
just setup-run
just test
The client used for interfacing with the UXI backend is autogenerated using an API Spec and openapitools. In order to download the latest spec and generate the corresponding client, run:
just generate-config-api-client
Create a file called acceptance.env
containing the following environment variables. See the table below for a description of the fields.
ACCEPTANCE_AGENT_ID=<acceptance_agent_id>
ACCEPTANCE_AGENT_PROVISION_HOST=<acceptance_agent_provision_host>
ACCEPTANCE_AGENT_PROVISION_SERIAL=<acceptance_agent_provision_serial>
ACCEPTANCE_CUSTOMER_ID=<acceptance_customer_id>
ACCEPTANCE_GROUP_ID_ROOT=<acceptance_group_id_root>
ACCEPTANCE_SENSOR_ID=<acceptance_sensor_id>
ACCEPTANCE_SERVICE_TEST_ID=<acceptance_service_test_id>
ACCEPTANCE_WIRED_NETWORK_ID=<acceptance_wired_network_id>
ACCEPTANCE_WIRELESS_NETWORK_ID=<acceptance_wireless_network_id>
HPEUXI_CLIENT_ID=<hpeuxi_client_id>
HPEUXI_CLIENT_SECRET=<hpeuxi_client_secret>
HPEUXI_HOST_OVERRIDE=<hpeuxi_host_override>
HPEUXI_PROVISION_TOKEN=<hpeuxi_provision_token>
Environment Variable | Description |
---|---|
ACCEPTANCE_AGENT_ID | ID of an agent on customer. |
ACCEPTANCE_AGENT_PROVISION_SERIAL | Serial number of an agent to be provisioned. Keep this constant between test runs to avoid excessive provisioning of agents. |
ACCEPTANCE_CUSTOMER_ID | ID of the customer against which the acceptance tests will be run. |
ACCEPTANCE_GROUP_ID_ROOT | ID of the root group. |
ACCEPTANCE_SENSOR_ID | ID of a hardware sensor on the customer. |
ACCEPTANCE_SERVICE_TEST_ID | ID of a service test on the customer. |
ACCEPTANCE_WIRED_NETWORK_ID | ID of a wired network on the customer. |
ACCEPTANCE_WIRELESS_NETWORK_ID | ID of a wireless network on the customer. |
DEVICE_GATEWAY_HOST | Host address of the device gateway (against which the agent provisioning will be run) |
HPEUXI_CLIENT_ID | CLIENT_ID component of the UXI API credentials as obtained from Greenlake. |
HPEUXI_CLIENT_SECRET | CLIENT_SECRET component of the UXI API credentials as obtained from Greenlake. |
HPEUXI_HOST_OVERRIDE | Host address of the configuration API (against which the configuration API requests will be run). |
HPEUXI_PROVISION_TOKEN | Token used to provision agents for the given customer. |
Then run the following command to execute the acceptance tests against the given customer.
just acceptance-tests acceptance.env
All builds must be signed by HPE before distribution. Read the Notices Report and ensure a report is added to every build which is published All open source sourcecode must be submitted to the HPE DSM to make this available for customers to download on request.