Skip to content

Commit e768ca1

Browse files
adamkrimadamkrim
committed
generate doc
1 parent 7ccb0a4 commit e768ca1

744 files changed

Lines changed: 35952 additions & 1448 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/resources/ackee.md‎

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,39 @@ description: |-
1616
resource "elestio_ackee" "example" {
1717
project_id = "2500"
1818
version = "latest"
19-
provider_name = "hetzner"
20-
datacenter = "fsn1"
19+
provider_name = "netcup"
20+
datacenter = "nbg"
2121
server_type = "MEDIUM-2C-4G"
22+
23+
# Default firewall rules
24+
firewall_user_rules = [
25+
# Required system ports
26+
{
27+
"type" = "input"
28+
"port" = "22"
29+
"protocol" = "tcp"
30+
"targets" = ["0.0.0.0/0", "::/0"]
31+
},
32+
{
33+
"type" = "input"
34+
"port" = "4242"
35+
"protocol" = "udp"
36+
"targets" = ["0.0.0.0/0", "::/0"]
37+
},
38+
# Application ports
39+
{
40+
"type" = "input"
41+
"port" = "80"
42+
"protocol" = "tcp"
43+
"targets" = ["0.0.0.0/0", "::/0"]
44+
},
45+
{
46+
"type" = "input"
47+
"port" = "443"
48+
"protocol" = "tcp"
49+
"targets" = ["0.0.0.0/0", "::/0"]
50+
}
51+
]
2252
}
2353
```
2454

@@ -41,6 +71,8 @@ resource "elestio_ackee" "example" {
4171
- `custom_domain_names` (Set of String) Indicate the list of domains for which you want to activate HTTPS / TLS / SSL. You will also need to create a DNS entry on your domain name (from your registrar control panel) pointing to your service. You must create a CNAME record pointing to the service `cname` value. Alternatively, you can create an A record pointing to the service `ipv4` value.
4272
- `default_password` (String) Set the default password used by you services at **CREATION** time.</br>The password can only contain alphanumeric characters or hyphens `-`. Require at least 10 characters, one uppercase letter, one lowercase letter and one number.</br>If you don't set a password, a random one will be generated by the API.</br>This attribute will **not be synced** after the creation. Use `admin.password` or `database_admin.password` to get the current password after the creation.
4373
- `firewall_enabled` (Boolean) Service firewall state. **Default** `true`.
74+
- `firewall_remove_tool_ports` (Boolean) When `true`, removes API-managed tool ports (VS Code, Terminal, etc.) that are not explicitly defined in `firewall_user_rules`. Tool ports explicitly included in `firewall_user_rules` are user-managed and will always be preserved. **Default** `false`. Use temporarily for cleanup, then reset to `false`.
75+
- `firewall_user_rules` (Attributes Set) Firewall rules for the service. **Required ports (must use exactly `["0.0.0.0/0", "::/0"]`):** `22/tcp` (SSH), `4242/udp` (Nebula VPN), `80/tcp` (Let's Encrypt for custom domains). When `firewall_enabled` is `false`, set to `[]`. **Software default ports:** `80/tcp`, `443/tcp`. (see [below for nested schema](#nestedatt--firewall_user_rules))
4476
- `keep_backups_on_delete_enabled` (Boolean) Creates a backup and keeps all existing ones after deleting the service. If the project is deleted, the backups will be lost. **Default** `true`.
4577
- `local_field` (Dynamic) This field is dynamic and can be used to store any custom data that you want to retrieve later in your configuration. It is not used by the provider.
4678
- `local_field_sensitive` (Dynamic, Sensitive) Same as `local_field` but the value is sensitive.
@@ -81,6 +113,7 @@ resource "elestio_ackee" "example" {
81113
- `external_backups_update_type` (String) Service external backups update type.
82114
- `firewall_id` (String) Service firewall id.
83115
- `firewall_ports` (String) Service firewall ports.
116+
- `firewall_tool_rules` (Attributes Set) API-managed tool ports (VS Code, Terminal, File Explorer, etc.) that are not explicitly defined in `firewall_user_rules`. These ports are automatically managed by the API and will be preserved unless `firewall_remove_tool_ports` is set to `true`. If you want to manage a tool port yourself, include it explicitly in `firewall_user_rules`. (see [below for nested schema](#nestedatt--firewall_tool_rules))
84117
- `global_ip` (String) Service global IP.
85118
- `id` (String) Service identifier handled by the provider. The format can change.
86119
- `ipv4` (String) Service IPv4.
@@ -99,6 +132,17 @@ resource "elestio_ackee" "example" {
99132
- `traffic_incoming` (Number) Service traffic incoming.
100133
- `traffic_outgoing` (Number) Service traffic outgoing.
101134

135+
<a id="nestedatt--firewall_user_rules"></a>
136+
### Nested Schema for `firewall_user_rules`
137+
138+
Required:
139+
140+
- `port` (String) Port number (`80`, `443`) or range (`8000-9000`).
141+
- `protocol` (String) The protocol (`tcp` or `udp`).
142+
- `targets` (Set of String) CIDR blocks allowed to access this port. Use `["0.0.0.0/0", "::/0"]` to allow access from all IPv4/IPv6 addresses. **Note:** Required system ports (22/tcp/input, 4242/udp/input, and 80/tcp/input when using custom domains) must have exactly these two targets and cannot have additional target restrictions.
143+
- `type` (String) The firewall rule type. Currently only `input` is supported.
144+
145+
102146
<a id="nestedatt--ssh_keys"></a>
103147
### Nested Schema for `ssh_keys`
104148

@@ -138,6 +182,18 @@ Read-Only:
138182
- `port` (String) Service database admin port.
139183
- `user` (String) Service database admin user.
140184

185+
186+
<a id="nestedatt--firewall_tool_rules"></a>
187+
### Nested Schema for `firewall_tool_rules`
188+
189+
Read-Only:
190+
191+
- `name` (String) The tool name.
192+
- `port` (String) Port number.
193+
- `protocol` (String) The protocol.
194+
- `targets` (Set of String) CIDR blocks allowed to access this port.
195+
- `type` (String) The firewall rule type.
196+
141197
## Import
142198

143199
Import is supported using the following syntax:

‎docs/resources/activepieces.md‎

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,45 @@ description: |-
1616
resource "elestio_activepieces" "example" {
1717
project_id = "2500"
1818
version = "latest"
19-
provider_name = "hetzner"
20-
datacenter = "fsn1"
19+
provider_name = "netcup"
20+
datacenter = "nbg"
2121
server_type = "MEDIUM-2C-4G"
22+
23+
# Default firewall rules
24+
firewall_user_rules = [
25+
# Required system ports
26+
{
27+
"type" = "input"
28+
"port" = "22"
29+
"protocol" = "tcp"
30+
"targets" = ["0.0.0.0/0", "::/0"]
31+
},
32+
{
33+
"type" = "input"
34+
"port" = "4242"
35+
"protocol" = "udp"
36+
"targets" = ["0.0.0.0/0", "::/0"]
37+
},
38+
# Application ports
39+
{
40+
"type" = "input"
41+
"port" = "80"
42+
"protocol" = "tcp"
43+
"targets" = ["0.0.0.0/0", "::/0"]
44+
},
45+
{
46+
"type" = "input"
47+
"port" = "443"
48+
"protocol" = "tcp"
49+
"targets" = ["0.0.0.0/0", "::/0"]
50+
},
51+
{
52+
"type" = "input"
53+
"port" = "4792"
54+
"protocol" = "tcp"
55+
"targets" = ["0.0.0.0/0", "::/0"]
56+
}
57+
]
2258
}
2359
```
2460

@@ -41,6 +77,8 @@ resource "elestio_activepieces" "example" {
4177
- `custom_domain_names` (Set of String) Indicate the list of domains for which you want to activate HTTPS / TLS / SSL. You will also need to create a DNS entry on your domain name (from your registrar control panel) pointing to your service. You must create a CNAME record pointing to the service `cname` value. Alternatively, you can create an A record pointing to the service `ipv4` value.
4278
- `default_password` (String) Set the default password used by you services at **CREATION** time.</br>The password can only contain alphanumeric characters or hyphens `-`. Require at least 10 characters, one uppercase letter, one lowercase letter and one number.</br>If you don't set a password, a random one will be generated by the API.</br>This attribute will **not be synced** after the creation. Use `admin.password` or `database_admin.password` to get the current password after the creation.
4379
- `firewall_enabled` (Boolean) Service firewall state. **Default** `true`.
80+
- `firewall_remove_tool_ports` (Boolean) When `true`, removes API-managed tool ports (VS Code, Terminal, etc.) that are not explicitly defined in `firewall_user_rules`. Tool ports explicitly included in `firewall_user_rules` are user-managed and will always be preserved. **Default** `false`. Use temporarily for cleanup, then reset to `false`.
81+
- `firewall_user_rules` (Attributes Set) Firewall rules for the service. **Required ports (must use exactly `["0.0.0.0/0", "::/0"]`):** `22/tcp` (SSH), `4242/udp` (Nebula VPN), `80/tcp` (Let's Encrypt for custom domains). When `firewall_enabled` is `false`, set to `[]`. **Software default ports:** `80/tcp`, `443/tcp`, `4792/tcp`. (see [below for nested schema](#nestedatt--firewall_user_rules))
4482
- `keep_backups_on_delete_enabled` (Boolean) Creates a backup and keeps all existing ones after deleting the service. If the project is deleted, the backups will be lost. **Default** `true`.
4583
- `local_field` (Dynamic) This field is dynamic and can be used to store any custom data that you want to retrieve later in your configuration. It is not used by the provider.
4684
- `local_field_sensitive` (Dynamic, Sensitive) Same as `local_field` but the value is sensitive.
@@ -81,6 +119,7 @@ resource "elestio_activepieces" "example" {
81119
- `external_backups_update_type` (String) Service external backups update type.
82120
- `firewall_id` (String) Service firewall id.
83121
- `firewall_ports` (String) Service firewall ports.
122+
- `firewall_tool_rules` (Attributes Set) API-managed tool ports (VS Code, Terminal, File Explorer, etc.) that are not explicitly defined in `firewall_user_rules`. These ports are automatically managed by the API and will be preserved unless `firewall_remove_tool_ports` is set to `true`. If you want to manage a tool port yourself, include it explicitly in `firewall_user_rules`. (see [below for nested schema](#nestedatt--firewall_tool_rules))
84123
- `global_ip` (String) Service global IP.
85124
- `id` (String) Service identifier handled by the provider. The format can change.
86125
- `ipv4` (String) Service IPv4.
@@ -99,6 +138,17 @@ resource "elestio_activepieces" "example" {
99138
- `traffic_incoming` (Number) Service traffic incoming.
100139
- `traffic_outgoing` (Number) Service traffic outgoing.
101140

141+
<a id="nestedatt--firewall_user_rules"></a>
142+
### Nested Schema for `firewall_user_rules`
143+
144+
Required:
145+
146+
- `port` (String) Port number (`80`, `443`) or range (`8000-9000`).
147+
- `protocol` (String) The protocol (`tcp` or `udp`).
148+
- `targets` (Set of String) CIDR blocks allowed to access this port. Use `["0.0.0.0/0", "::/0"]` to allow access from all IPv4/IPv6 addresses. **Note:** Required system ports (22/tcp/input, 4242/udp/input, and 80/tcp/input when using custom domains) must have exactly these two targets and cannot have additional target restrictions.
149+
- `type` (String) The firewall rule type. Currently only `input` is supported.
150+
151+
102152
<a id="nestedatt--ssh_keys"></a>
103153
### Nested Schema for `ssh_keys`
104154

@@ -138,6 +188,18 @@ Read-Only:
138188
- `port` (String) Service database admin port.
139189
- `user` (String) Service database admin user.
140190

191+
192+
<a id="nestedatt--firewall_tool_rules"></a>
193+
### Nested Schema for `firewall_tool_rules`
194+
195+
Read-Only:
196+
197+
- `name` (String) The tool name.
198+
- `port` (String) Port number.
199+
- `protocol` (String) The protocol.
200+
- `targets` (Set of String) CIDR blocks allowed to access this port.
201+
- `type` (String) The firewall rule type.
202+
141203
## Import
142204

143205
Import is supported using the following syntax:

‎docs/resources/affine.md‎

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,39 @@ description: |-
1616
resource "elestio_affine" "example" {
1717
project_id = "2500"
1818
version = "stable"
19-
provider_name = "hetzner"
20-
datacenter = "fsn1"
19+
provider_name = "netcup"
20+
datacenter = "nbg"
2121
server_type = "MEDIUM-2C-4G"
22+
23+
# Default firewall rules
24+
firewall_user_rules = [
25+
# Required system ports
26+
{
27+
"type" = "input"
28+
"port" = "22"
29+
"protocol" = "tcp"
30+
"targets" = ["0.0.0.0/0", "::/0"]
31+
},
32+
{
33+
"type" = "input"
34+
"port" = "4242"
35+
"protocol" = "udp"
36+
"targets" = ["0.0.0.0/0", "::/0"]
37+
},
38+
# Application ports
39+
{
40+
"type" = "input"
41+
"port" = "80"
42+
"protocol" = "tcp"
43+
"targets" = ["0.0.0.0/0", "::/0"]
44+
},
45+
{
46+
"type" = "input"
47+
"port" = "443"
48+
"protocol" = "tcp"
49+
"targets" = ["0.0.0.0/0", "::/0"]
50+
}
51+
]
2252
}
2353
```
2454

@@ -41,6 +71,8 @@ resource "elestio_affine" "example" {
4171
- `custom_domain_names` (Set of String) Indicate the list of domains for which you want to activate HTTPS / TLS / SSL. You will also need to create a DNS entry on your domain name (from your registrar control panel) pointing to your service. You must create a CNAME record pointing to the service `cname` value. Alternatively, you can create an A record pointing to the service `ipv4` value.
4272
- `default_password` (String) Set the default password used by you services at **CREATION** time.</br>The password can only contain alphanumeric characters or hyphens `-`. Require at least 10 characters, one uppercase letter, one lowercase letter and one number.</br>If you don't set a password, a random one will be generated by the API.</br>This attribute will **not be synced** after the creation. Use `admin.password` or `database_admin.password` to get the current password after the creation.
4373
- `firewall_enabled` (Boolean) Service firewall state. **Default** `true`.
74+
- `firewall_remove_tool_ports` (Boolean) When `true`, removes API-managed tool ports (VS Code, Terminal, etc.) that are not explicitly defined in `firewall_user_rules`. Tool ports explicitly included in `firewall_user_rules` are user-managed and will always be preserved. **Default** `false`. Use temporarily for cleanup, then reset to `false`.
75+
- `firewall_user_rules` (Attributes Set) Firewall rules for the service. **Required ports (must use exactly `["0.0.0.0/0", "::/0"]`):** `22/tcp` (SSH), `4242/udp` (Nebula VPN), `80/tcp` (Let's Encrypt for custom domains). When `firewall_enabled` is `false`, set to `[]`. **Software default ports:** `80/tcp`, `443/tcp`. (see [below for nested schema](#nestedatt--firewall_user_rules))
4476
- `keep_backups_on_delete_enabled` (Boolean) Creates a backup and keeps all existing ones after deleting the service. If the project is deleted, the backups will be lost. **Default** `true`.
4577
- `local_field` (Dynamic) This field is dynamic and can be used to store any custom data that you want to retrieve later in your configuration. It is not used by the provider.
4678
- `local_field_sensitive` (Dynamic, Sensitive) Same as `local_field` but the value is sensitive.
@@ -81,6 +113,7 @@ resource "elestio_affine" "example" {
81113
- `external_backups_update_type` (String) Service external backups update type.
82114
- `firewall_id` (String) Service firewall id.
83115
- `firewall_ports` (String) Service firewall ports.
116+
- `firewall_tool_rules` (Attributes Set) API-managed tool ports (VS Code, Terminal, File Explorer, etc.) that are not explicitly defined in `firewall_user_rules`. These ports are automatically managed by the API and will be preserved unless `firewall_remove_tool_ports` is set to `true`. If you want to manage a tool port yourself, include it explicitly in `firewall_user_rules`. (see [below for nested schema](#nestedatt--firewall_tool_rules))
84117
- `global_ip` (String) Service global IP.
85118
- `id` (String) Service identifier handled by the provider. The format can change.
86119
- `ipv4` (String) Service IPv4.
@@ -99,6 +132,17 @@ resource "elestio_affine" "example" {
99132
- `traffic_incoming` (Number) Service traffic incoming.
100133
- `traffic_outgoing` (Number) Service traffic outgoing.
101134

135+
<a id="nestedatt--firewall_user_rules"></a>
136+
### Nested Schema for `firewall_user_rules`
137+
138+
Required:
139+
140+
- `port` (String) Port number (`80`, `443`) or range (`8000-9000`).
141+
- `protocol` (String) The protocol (`tcp` or `udp`).
142+
- `targets` (Set of String) CIDR blocks allowed to access this port. Use `["0.0.0.0/0", "::/0"]` to allow access from all IPv4/IPv6 addresses. **Note:** Required system ports (22/tcp/input, 4242/udp/input, and 80/tcp/input when using custom domains) must have exactly these two targets and cannot have additional target restrictions.
143+
- `type` (String) The firewall rule type. Currently only `input` is supported.
144+
145+
102146
<a id="nestedatt--ssh_keys"></a>
103147
### Nested Schema for `ssh_keys`
104148

@@ -138,6 +182,18 @@ Read-Only:
138182
- `port` (String) Service database admin port.
139183
- `user` (String) Service database admin user.
140184

185+
186+
<a id="nestedatt--firewall_tool_rules"></a>
187+
### Nested Schema for `firewall_tool_rules`
188+
189+
Read-Only:
190+
191+
- `name` (String) The tool name.
192+
- `port` (String) Port number.
193+
- `protocol` (String) The protocol.
194+
- `targets` (Set of String) CIDR blocks allowed to access this port.
195+
- `type` (String) The firewall rule type.
196+
141197
## Import
142198

143199
Import is supported using the following syntax:

0 commit comments

Comments
 (0)