terraform-provider-stackitp.../docs/resources/argus_instance.md
Diogo Ferrão c2389be47b
Onboard Argus ACL (#304)
* resource create and schema/model

* consider empty value in resource creation

* Address issue in mapfields that came up in testing

* Unit testing the mapFields func

* extend update

* extend read

* extend datasource.go

* update example

* extended acceptance tests and generated docs

* update description and comments

* improve messages and var names, fix update acceptance test

* extend acceptance tests, improve error messages
2024-03-22 17:35:10 +00:00

2.7 KiB

page_title subcategory description
stackit_argus_instance Resource - stackit Argus instance resource schema. Must have a region specified in the provider configuration.

stackit_argus_instance (Resource)

Argus instance resource schema. Must have a region specified in the provider configuration.

Example Usage

resource "stackit_argus_instance" "example" {
  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  name       = "example-instance"
  plan_name  = "Monitoring-Medium-EU01"
  acl        = ["1.1.1.1/32", "2.2.2.2/32"]
}

Schema

Required

  • name (String) The name of the Argus instance.
  • plan_name (String) Specifies the Argus plan. E.g. Monitoring-Medium-EU01.
  • project_id (String) STACKIT project ID to which the instance is associated.

Optional

  • acl (Set of String) The access control list for this instance. Each entry is an IP or IP range that is permitted to access, in CIDR notation.
  • parameters (Map of String) Additional parameters.

Read-Only

  • alerting_url (String) Specifies Alerting URL.
  • dashboard_url (String) Specifies Argus instance dashboard URL.
  • grafana_initial_admin_password (String, Sensitive) Specifies an initial Grafana admin password.
  • grafana_initial_admin_user (String) Specifies an initial Grafana admin username.
  • grafana_public_read_access (Boolean) If true, anyone can access Grafana dashboards without logging in.
  • grafana_url (String) Specifies Grafana URL.
  • id (String) Terraform's internal resource ID. It is structured as "project_id,instance_id".
  • instance_id (String) The Argus instance ID.
  • is_updatable (Boolean) Specifies if the instance can be updated.
  • jaeger_traces_url (String)
  • jaeger_ui_url (String)
  • logs_push_url (String) Specifies URL for pushing logs.
  • logs_url (String) Specifies Logs URL.
  • metrics_push_url (String) Specifies URL for pushing metrics.
  • metrics_retention_days (Number) Specifies for how many days the raw metrics are kept.
  • metrics_retention_days_1h_downsampling (Number) Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to 0 (disabled).
  • metrics_retention_days_5m_downsampling (Number) Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to 0 (disabled).
  • metrics_url (String) Specifies metrics URL.
  • otlp_traces_url (String)
  • plan_id (String) The Argus plan ID.
  • targets_url (String) Specifies Targets URL.
  • zipkin_spans_url (String)