Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion docs/data-sources/affinity_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ data "stackit_affinity_group" "example" {
- `affinity_group_id` (String) The affinity group ID.
- `project_id` (String) STACKIT Project ID to which the affinity group is associated.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`affinity_group_id`".
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`affinity_group_id`".
- `members` (List of String) Affinity Group schema. Must have a `region` specified in the provider configuration.
- `name` (String) The name of the affinity group.
- `policy` (String) The policy of the affinity group.
3 changes: 2 additions & 1 deletion docs/data-sources/iaas_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@ data "stackit_iaas_project" "example" {
- `created_at` (String) Date-time when the project was created.
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`".
- `internet_access` (Boolean) Specifies if the project has internet_access
- `state` (String) Specifies the state of the project.
- `state` (String, Deprecated) Specifies the state of the project.
- `status` (String)
- `updated_at` (String) Date-time when the project was last updated.
6 changes: 5 additions & 1 deletion docs/data-sources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,16 @@ data "stackit_image" "example" {
- `image_id` (String) The image ID.
- `project_id` (String) STACKIT project ID to which the image is associated.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `checksum` (Attributes) Representation of an image checksum. (see [below for nested schema](#nestedatt--checksum))
- `config` (Attributes) Properties to set hardware and scheduling settings for an image. (see [below for nested schema](#nestedatt--config))
- `disk_format` (String) The disk format of the image.
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`image_id`".
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`image_id`".
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
- `min_disk_size` (Number) The minimum disk size of the image in GB.
- `min_ram` (Number) The minimum RAM of the image in MB.
Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/image_v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,15 @@ data "stackit_image_v2" "filter_distro_version" {
- `image_id` (String) Image ID to fetch directly
- `name` (String) Exact image name to match. Optionally applies a `filter` block to further refine results in case multiple images share the same name. The first match is returned, optionally sorted by name in ascending order. Cannot be used together with `name_regex`.
- `name_regex` (String) Regular expression to match against image names. Optionally applies a `filter` block to narrow down results when multiple image names match the regex. The first match is returned, optionally sorted by name in ascending order. Cannot be used together with `name`.
- `region` (String) The resource region. If not defined, the provider region is used.
- `sort_ascending` (Boolean) If set to `true`, images are sorted in ascending lexicographical order by image name (such as `Ubuntu 18.04`, `Ubuntu 20.04`, `Ubuntu 22.04`) before selecting the first match. Defaults to `false` (descending such as `Ubuntu 22.04`, `Ubuntu 20.04`, `Ubuntu 18.04`).

### Read-Only

- `checksum` (Attributes) Representation of an image checksum. (see [below for nested schema](#nestedatt--checksum))
- `config` (Attributes) Properties to set hardware and scheduling settings for an image. (see [below for nested schema](#nestedatt--config))
- `disk_format` (String) The disk format of the image.
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`image_id`".
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`image_id`".
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
- `min_disk_size` (Number) The minimum disk size of the image in GB.
- `min_ram` (Number) The minimum RAM of the image in MB.
Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/machine_type.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,15 @@ stackit server machine-type list

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.
- `sort_ascending` (Boolean) Sort machine types by name ascending (`true`) or descending (`false`). Defaults to `false`

### Read-Only

- `description` (String) Machine type description.
- `disk` (Number) Disk size in GB.
- `extra_specs` (Map of String) Extra specs (e.g., CPU type, overcommit ratio).
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`image_id`".
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`image_id`".
- `name` (String) Name of the machine type (e.g. 's1.2').
- `ram` (Number) RAM size in MB.
- `vcpus` (Number) Number of vCPUs.
12 changes: 6 additions & 6 deletions docs/data-sources/network_area.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ data "stackit_network_area" "example" {

### Read-Only

- `default_nameservers` (List of String) List of DNS Servers/Nameservers.
- `default_prefix_length` (Number) The default prefix length for networks in the network area.
- `default_nameservers` (List of String, Deprecated) List of DNS Servers/Nameservers.
- `default_prefix_length` (Number, Deprecated) The default prefix length for networks in the network area.
- `id` (String) Terraform's internal resource ID. It is structured as "`organization_id`,`network_area_id`".
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
- `max_prefix_length` (Number) The maximal prefix length for networks in the network area.
- `min_prefix_length` (Number) The minimal prefix length for networks in the network area.
- `max_prefix_length` (Number, Deprecated) The maximal prefix length for networks in the network area.
- `min_prefix_length` (Number, Deprecated) The minimal prefix length for networks in the network area.
- `name` (String) The name of the network area.
- `network_ranges` (Attributes List) List of Network ranges. (see [below for nested schema](#nestedatt--network_ranges))
- `network_ranges` (Attributes List, Deprecated) List of Network ranges. (see [below for nested schema](#nestedatt--network_ranges))
- `project_count` (Number) The amount of projects currently referencing this area.
- `transfer_network` (String) Classless Inter-Domain Routing (CIDR).
- `transfer_network` (String, Deprecated) Classless Inter-Domain Routing (CIDR).

<a id="nestedatt--network_ranges"></a>
### Nested Schema for `network_ranges`
Expand Down
57 changes: 57 additions & 0 deletions docs/data-sources/network_area_region.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "stackit_network_area_region Data Source - stackit"
subcategory: ""
description: |-
Network area region data source schema.
---

# stackit_network_area_region (Data Source)

Network area region data source schema.

## Example Usage

```terraform
data "stackit_network_area_region" "example" {
organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
network_area_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `network_area_id` (String) The network area ID.
- `organization_id` (String) STACKIT organization ID to which the network area is associated.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `id` (String) Terraform's internal resource ID. It is structured as "`organization_id`,`network_area_id`,`region`".
- `ipv4` (Attributes) The regional IPv4 config of a network area. (see [below for nested schema](#nestedatt--ipv4))

<a id="nestedatt--ipv4"></a>
### Nested Schema for `ipv4`

Read-Only:

- `default_nameservers` (List of String) List of DNS Servers/Nameservers.
- `default_prefix_length` (Number) The default prefix length for networks in the network area.
- `max_prefix_length` (Number) The maximal prefix length for networks in the network area.
- `min_prefix_length` (Number) The minimal prefix length for networks in the network area.
- `network_ranges` (Attributes List) List of Network ranges. (see [below for nested schema](#nestedatt--ipv4--network_ranges))
- `transfer_network` (String) IPv4 Classless Inter-Domain Routing (CIDR).

<a id="nestedatt--ipv4--network_ranges"></a>
### Nested Schema for `ipv4.network_ranges`

Read-Only:

- `network_range_id` (String)
- `prefix` (String) Classless Inter-Domain Routing (CIDR).
6 changes: 5 additions & 1 deletion docs/data-sources/network_area_route.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,13 @@ data "stackit_network_area_route" "example" {
- `network_area_route_id` (String) The network area route ID.
- `organization_id` (String) STACKIT organization ID to which the network area is associated.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `id` (String) Terraform's internal data source ID. It is structured as "`organization_id`,`network_area_id`,`network_area_route_id`".
- `id` (String) Terraform's internal data source ID. It is structured as "`organization_id`,`region`,`network_area_id`,`network_area_route_id`".
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
- `next_hop` (String) The IP address of the routing system, that will route the prefix configured. Should be a valid IPv4 address.
- `prefix` (String) The network, that is reachable though the Next Hop. Should use CIDR notation.
6 changes: 5 additions & 1 deletion docs/data-sources/network_interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,15 @@ data "stackit_network_interface" "example" {
- `network_interface_id` (String) The network interface ID.
- `project_id` (String) STACKIT project ID to which the network interface is associated.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `allowed_addresses` (List of String) The list of CIDR (Classless Inter-Domain Routing) notations.
- `device` (String) The device UUID of the network interface.
- `id` (String) Terraform's internal data source ID. It is structured as "`project_id`,`network_id`,`network_interface_id`".
- `id` (String) Terraform's internal data source ID. It is structured as "`project_id`,`region`,`network_id`,`network_interface_id`".
- `ipv4` (String) The IPv4 address.
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a network interface.
- `mac` (String) The MAC address of network interface.
Expand Down
6 changes: 5 additions & 1 deletion docs/data-sources/public_ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ data "stackit_public_ip" "example" {
- `project_id` (String) STACKIT project ID to which the public IP is associated.
- `public_ip_id` (String) The public IP ID.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `id` (String) Terraform's internal datasource ID. It is structured as "`project_id`,`public_ip_id`".
- `id` (String) Terraform's internal datasource ID. It is structured as "`project_id`,`region`,`public_ip_id`".
- `ip` (String) The IP address.
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
- `network_interface_id` (String) Associates the public IP with a network interface or a virtual IP (ID).
4 changes: 4 additions & 0 deletions docs/data-sources/security_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ data "stackit_security_group" "example" {
- `project_id` (String) STACKIT project ID to which the security group is associated.
- `security_group_id` (String) The security group ID.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `description` (String) The description of the security group.
Expand Down
6 changes: 5 additions & 1 deletion docs/data-sources/security_group_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,17 @@ data "stackit_security_group_rule" "example" {
- `security_group_id` (String) The security group ID.
- `security_group_rule_id` (String) The security group rule ID.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `description` (String) The description of the security group rule.
- `direction` (String) The direction of the traffic which the rule should match. Some of the possible values are: Possible values are: `ingress`, `egress`.
- `ether_type` (String) The ethertype which the rule should match.
- `icmp_parameters` (Attributes) ICMP Parameters. (see [below for nested schema](#nestedatt--icmp_parameters))
- `id` (String) Terraform's internal datasource ID. It is structured as "`project_id`,`security_group_id`,`security_group_rule_id`".
- `id` (String) Terraform's internal datasource ID. It is structured as "`project_id`,`region`,`security_group_id`,`security_group_rule_id`".
- `ip_range` (String) The remote IP range which the rule should match.
- `port_range` (Attributes) The range of ports. (see [below for nested schema](#nestedatt--port_range))
- `protocol` (Attributes) The internet protocol which the rule should match. (see [below for nested schema](#nestedatt--protocol))
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ data "stackit_server" "example" {
- `project_id` (String) STACKIT project ID to which the server is associated.
- `server_id` (String) The server ID.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `affinity_group` (String) The affinity group the server is assigned to.
Expand Down
6 changes: 5 additions & 1 deletion docs/data-sources/volume.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,15 @@ data "stackit_volume" "example" {
- `project_id` (String) STACKIT project ID to which the volume is associated.
- `volume_id` (String) The volume ID.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `availability_zone` (String) The availability zone of the volume.
- `description` (String) The description of the volume.
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`volume_id`".
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`volume_id`".
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
- `name` (String) The name of the volume.
- `performance_class` (String) The performance class of the volume. Possible values are documented in [Service plans BlockStorage](https://docs.stackit.cloud/stackit/en/service-plans-blockstorage-75137974.html#ServiceplansBlockStorage-CurrentlyavailableServicePlans%28performanceclasses%29)
Expand Down
10 changes: 7 additions & 3 deletions docs/resources/affinity_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
page_title: "stackit_affinity_group Resource - stackit"
subcategory: ""
description: |-
Affinity Group schema. Must have a region specified in the provider configuration.
Affinity Group schema.
Usage with server

resource "stackit_affinity_group" "affinity-group" {
Expand Down Expand Up @@ -39,7 +39,7 @@ description: |-

# stackit_affinity_group (Resource)

Affinity Group schema. Must have a `region` specified in the provider configuration.
Affinity Group schema.



Expand Down Expand Up @@ -104,8 +104,12 @@ import {
- `policy` (String) The policy of the affinity group.
- `project_id` (String) STACKIT Project ID to which the affinity group is associated.

### Optional

- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `affinity_group_id` (String) The affinity group ID.
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`affinity_group_id`".
- `id` (String) Terraform's internal resource identifier. It is structured as "`project_id`,`region`,`affinity_group_id`".
- `members` (List of String) The servers that are part of the affinity group.
3 changes: 2 additions & 1 deletion docs/resources/image.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,12 @@ import {
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
- `min_disk_size` (Number) The minimum disk size of the image in GB.
- `min_ram` (Number) The minimum RAM of the image in MB.
- `region` (String) The resource region. If not defined, the provider region is used.

### Read-Only

- `checksum` (Attributes) Representation of an image checksum. (see [below for nested schema](#nestedatt--checksum))
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`image_id`".
- `id` (String) Terraform's internal resource ID. It is structured as "`project_id`,`region`,`image_id`".
- `image_id` (String) The image ID.
- `protected` (Boolean) Whether the image is protected.
- `scope` (String) The scope of the image.
Expand Down
6 changes: 2 additions & 4 deletions docs/resources/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,9 @@ import {
- `nameservers` (List of String, Deprecated) The nameservers of the network. This field is deprecated and will be removed in January 2026, use `ipv4_nameservers` to configure the nameservers for IPv4.
- `no_ipv4_gateway` (Boolean) If set to `true`, the network doesn't have a gateway.
- `no_ipv6_gateway` (Boolean) If set to `true`, the network doesn't have a gateway.
- `region` (String) Can only be used when experimental "network" is set.
The resource region. If not defined, the provider region is used.
- `region` (String) The resource region. If not defined, the provider region is used.
- `routed` (Boolean) If set to `true`, the network is routed and therefore accessible from other networks.
- `routing_table_id` (String) Can only be used when experimental "network" is set.
The ID of the routing table associated with the network.
- `routing_table_id` (String) The ID of the routing table associated with the network.

### Read-Only

Expand Down
26 changes: 10 additions & 16 deletions docs/resources/network_area.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,19 @@
page_title: "stackit_network_area Resource - stackit"
subcategory: ""
description: |-
Network area resource schema. Must have a region specified in the provider configuration.
Network area resource schema.
---

# stackit_network_area (Resource)

Network area resource schema. Must have a `region` specified in the provider configuration.
Network area resource schema.

## Example Usage

```terraform
resource "stackit_network_area" "example" {
organization_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
name = "example-network-area"
network_ranges = [
{
prefix = "192.168.0.0/24"
}
]
transfer_network = "192.168.1.0/24"
labels = {
"key" = "value"
}
Expand All @@ -40,17 +34,17 @@ import {
### Required

- `name` (String) The name of the network area.
- `network_ranges` (Attributes List) List of Network ranges. (see [below for nested schema](#nestedatt--network_ranges))
- `organization_id` (String) STACKIT organization ID to which the network area is associated.
- `transfer_network` (String) Classless Inter-Domain Routing (CIDR).

### Optional

- `default_nameservers` (List of String) List of DNS Servers/Nameservers.
- `default_prefix_length` (Number) The default prefix length for networks in the network area.
- `default_nameservers` (List of String, Deprecated) List of DNS Servers/Nameservers for configuration of network area for region `eu01`.
- `default_prefix_length` (Number, Deprecated) The default prefix length for networks in the network area for region `eu01`.
- `labels` (Map of String) Labels are key-value string pairs which can be attached to a resource container
- `max_prefix_length` (Number) The maximal prefix length for networks in the network area.
- `min_prefix_length` (Number) The minimal prefix length for networks in the network area.
- `max_prefix_length` (Number, Deprecated) The maximal prefix length for networks in the network area for region `eu01`.
- `min_prefix_length` (Number, Deprecated) The minimal prefix length for networks in the network area for region `eu01`.
- `network_ranges` (Attributes List, Deprecated) List of Network ranges for configuration of network area for region `eu01`. (see [below for nested schema](#nestedatt--network_ranges))
- `transfer_network` (String, Deprecated) Classless Inter-Domain Routing (CIDR) for configuration of network area for region `eu01`.

### Read-Only

Expand All @@ -63,8 +57,8 @@ import {

Required:

- `prefix` (String) Classless Inter-Domain Routing (CIDR).
- `prefix` (String, Deprecated) Classless Inter-Domain Routing (CIDR).

Read-Only:

- `network_range_id` (String)
- `network_range_id` (String, Deprecated)
Loading
Loading