Skip to content

Commit ee6870b

Browse files
yfodilyfodil
committed
add docs
1 parent 591e9f0 commit ee6870b

File tree

5 files changed

+291
-0
lines changed

5 files changed

+291
-0
lines changed

‎docs/resources/edge_services_backend_stage.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
subcategory: "Edge Services"
3+
page_title: "Scaleway: scaleway_edge_services_backend_stage"
4+
---
5+
6+
# Resource: scaleway_edge_services_backend_stage
7+
8+
Creates and manages Scaleway Edge Services Backend Stages.
9+
10+
## Example Usage
11+
12+
### Basic
13+
14+
```terraform
15+
resource "scaleway_object_bucket" "main" {
16+
name = "my-bucket-name"
17+
tags = {
18+
foo = "bar"
19+
}
20+
}
21+
22+
resource "scaleway_edge_services_backend_stage" "main" {
23+
s3_backend_config {
24+
bucket_name = scaleway_object_bucket.main.name
25+
bucket_region = "fr-par"
26+
}
27+
}
28+
```
29+
30+
### Custom Certificate
31+
32+
```terraform
33+
```
34+
35+
## Argument Reference
36+
37+
- `s3_backend_config` - (Required) The Scaleway Object Storage origin bucket (S3) linked to the backend stage.
38+
- `bucket_name` - The name of the Bucket.
39+
- `bucket_region` - The region of the Bucket.
40+
- `is_website` - Defines whether the bucket website feature is enabled.
41+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the backend stage is associated with.
42+
43+
## Attributes Reference
44+
45+
In addition to all arguments above, the following attributes are exported:
46+
47+
- `id` - The ID of the backend stage (UUID format).
48+
- `created_at` - The date and time of the creation of the backend stage.
49+
- `updated_at` - The date and time of the last update of the backend stage.
50+
- `pipeline_id` - The pipeline ID the backend stage belongs to.
51+
52+
## Import
53+
54+
Backend stages can be imported using the `{id}`, e.g.
55+
56+
```bash
57+
$ terraform import scaleway_edge_services_backend_stage.basic 11111111-1111-1111-1111-111111111111
58+
```

‎docs/resources/edge_services_cache_stage.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
subcategory: "Edge Services"
3+
page_title: "Scaleway: scaleway_edge_services_cache_stage"
4+
---
5+
6+
# Resource: scaleway_edge_services_cache_stage
7+
8+
Creates and manages Scaleway Edge Services Cache Stages.
9+
10+
## Example Usage
11+
12+
### Basic
13+
14+
```terraform
15+
resource "scaleway_edge_services_cache_stage" "main" {
16+
backend_stage_id = scaleway_edge_services_backend_stage.main.id
17+
}
18+
```
19+
20+
### Purge request
21+
22+
```terraform
23+
resource "scaleway_edge_services_cache_stage" "main" {
24+
backend_stage_id = scaleway_edge_services_backend_stage.main.id
25+
26+
purge {
27+
pipeline_id = scaleway_edge_services_pipeline.main.id
28+
all = true
29+
}
30+
}
31+
```
32+
33+
## Argument Reference
34+
35+
- `backend_stage_id` - (Optional) The backend stage ID the cache stage will be linked to.
36+
- `fallback_ttl` - (Optional) The Time To Live (TTL) in seconds. Defines how long content is cached.
37+
- `refresh_cache` - (Optional) Trigger a refresh of the cache by changing this field's value.
38+
- `purge_requests` - (Optional) The Scaleway Object Storage origin bucket (S3) linked to the backend stage.
39+
- `pipeline_id` - The pipeline ID in which the purge request will be created.
40+
- `assets` - The list of asserts to purge.
41+
- `all` - Defines whether to purge all content.
42+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the cache stage is associated with.
43+
44+
## Attributes Reference
45+
46+
In addition to all arguments above, the following attributes are exported:
47+
48+
- `id` - The ID of the cache stage (UUID format).
49+
- `created_at` - The date and time of the creation of the cache stage.
50+
- `updated_at` - The date and time of the last update of the cache stage.
51+
- `pipeline_id` - The pipeline ID the cache stage belongs to.
52+
53+
## Import
54+
55+
Cache stages can be imported using the `{id}`, e.g.
56+
57+
```bash
58+
$ terraform import scaleway_edge_services_cache_stage.basic 11111111-1111-1111-1111-111111111111
59+
```

‎docs/resources/edge_services_dns_stage.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
subcategory: "Edge Services"
3+
page_title: "Scaleway: scaleway_edge_services_dns_stage"
4+
---
5+
6+
# Resource: scaleway_edge_services_dns_stage
7+
8+
Creates and manages Scaleway Edge Services DNS Stages.
9+
10+
## Example Usage
11+
12+
### Basic
13+
14+
```terraform
15+
resource "scaleway_edge_services_dns_stage" "main" {
16+
fqdns = ["subdomain.example.com"]
17+
}
18+
```
19+
20+
## Argument Reference
21+
22+
- `backend_stage_id` - (Optional) The backend stage ID the DNS stage will be linked to.
23+
- `tls_stage_id` - (Optional) The TLS stage ID the DNS stage will be linked to.
24+
- `cache_stage_id` - (Optional) The cache stage ID the DNS stage will be linked to.
25+
- `fqdns` - (Optional) Fully Qualified Domain Name (in the format subdomain.example.com) to attach to the stage.
26+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the DNS stage is associated with.
27+
28+
## Attributes Reference
29+
30+
In addition to all arguments above, the following attributes are exported:
31+
32+
- `id` - The ID of the DNS stage (UUID format).
33+
- `type` - The type of the stage.
34+
- `created_at` - The date and time of the creation of the DNS stage.
35+
- `updated_at` - The date and time of the last update of the DNS stage.
36+
- `pipeline_id` - The pipeline ID the DNS stage belongs to.
37+
38+
## Import
39+
40+
DNS stages can be imported using the `{id}`, e.g.
41+
42+
```bash
43+
$ terraform import scaleway_edge_services_dns_stage.basic 11111111-1111-1111-1111-111111111111
44+
```

‎docs/resources/edge_services_pipeline.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
subcategory: "Edge Services"
3+
page_title: "Scaleway: scaleway_edge_services_pipeline"
4+
---
5+
6+
# Resource: scaleway_edge_services_pipeline
7+
8+
Creates and manages Scaleway Edge Services Pipelines.
9+
10+
## Example Usage
11+
12+
### Basic
13+
14+
```terraform
15+
resource "scaleway_edge_services_pipeline" "main" {
16+
name = "pipeline-name"
17+
description = "pipeline description"
18+
}
19+
```
20+
21+
### Complete pipeline
22+
23+
```terraform
24+
resource "scaleway_edge_services_backend_stage" "main" {
25+
s3_backend_config {
26+
bucket_name = "my-bucket-name"
27+
bucket_region = "fr-par"
28+
}
29+
}
30+
31+
resource "scaleway_edge_services_tls_stage" "main" {
32+
cache_stage_id = scaleway_edge_services_cache_stage.main.id
33+
managed_certificate = true
34+
}
35+
36+
resource "scaleway_edge_services_dns_stage" "main" {
37+
tls_stage_id = scaleway_edge_services_tls_stage.main.id
38+
fqdns = ["subdomain.example.com"]
39+
}
40+
41+
resource "scaleway_edge_services_pipeline" "main" {
42+
name = "my-edge_services-pipeline"
43+
dns_stage_id = scaleway_edge_services_dns_stage.main.id
44+
}
45+
46+
resource "scaleway_edge_services_cache_stage" "main" {
47+
backend_stage_id = scaleway_edge_services_backend_stage.main.id
48+
}
49+
```
50+
51+
## Argument Reference
52+
53+
- `name` - (Optional) The name of the pipeline.
54+
- `description` - (Optional) The description of the pipeline.
55+
- `dns_stage_id` - (Optional) The DNS stage ID the pipeline will be attached to.
56+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the pipeline is associated with.
57+
58+
## Attributes Reference
59+
60+
In addition to all arguments above, the following attributes are exported:
61+
62+
- `id` - The ID of the pipeline (UUID format).
63+
- `created_at` - The date and time of the creation of the pipeline.
64+
- `updated_at` - The date and time of the last update of the pipeline.
65+
- `status` - The status of user pipeline.
66+
67+
## Import
68+
69+
Pipelines can be imported using the `{id}`, e.g.
70+
71+
```bash
72+
$ terraform import scaleway_edge_services_pipeline.basic 11111111-1111-1111-1111-111111111111
73+
```

‎docs/resources/edge_services_tls_stage.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
subcategory: "Edge Services"
3+
page_title: "Scaleway: scaleway_edge_services_tls_stage"
4+
---
5+
6+
# Resource: scaleway_edge_services_tls_stage
7+
8+
Creates and manages Scaleway Edge Services TLS Stages.
9+
10+
## Example Usage
11+
12+
### Managed
13+
14+
```terraform
15+
resource "scaleway_edge_services_tls_stage" "main" {
16+
managed_certificate = true
17+
}
18+
```
19+
20+
### With a certificate stored in Scaleway Secret Manager.
21+
22+
```terraform
23+
resource "scaleway_edge_services_tls_stage" "main" {
24+
secrets {
25+
secret_id = "11111111-1111-1111-1111-111111111111"
26+
region = "fr-par"
27+
}
28+
}
29+
```
30+
31+
## Argument Reference
32+
33+
- `backend_stage_id` - (Optional) The backend stage ID the TLS stage will be linked to.
34+
- `cache_stage_id` - (Optional) The cache stage ID the TLS stage will be linked to.
35+
- `managed_certificate` - (Optional) Set to true when Scaleway generates and manages a Let's Encrypt certificate for the TLS stage/custom endpoint.
36+
- `secrets` - (Optional) The TLS secrets.
37+
- `bucket_name` - The ID of the secret.
38+
- `region` - The region of the secret.
39+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the TLS stage is associated with.
40+
41+
## Attributes Reference
42+
43+
In addition to all arguments above, the following attributes are exported:
44+
45+
- `id` - The ID of the TLS stage (UUID format).
46+
- `certificate_expires_at` - The expiration date of the certificate.
47+
- `created_at` - The date and time of the creation of the TLS stage.
48+
- `updated_at` - The date and time of the last update of the TLS stage.
49+
- `pipeline_id` - The pipeline ID the TLS stage belongs to.
50+
51+
## Import
52+
53+
TLS stages can be imported using the `{id}`, e.g.
54+
55+
```bash
56+
$ terraform import scaleway_edge_services_tls_stage.basic 11111111-1111-1111-1111-111111111111
57+
```

0 commit comments

Comments
 (0)