Skip to content

Commit cbba4a0

Browse files
committed
Merge branch 'master' into object-nightly-migration
2 parents f9a5222 + a11594f commit cbba4a0

39 files changed

+3743
-156
lines changed

.github/workflows/spelling.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Spelling
2+
3+
permissions:
4+
contents: read
5+
6+
on: [pull_request]
7+
8+
9+
jobs:
10+
spelling:
11+
name: Spell Check with Typos
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout Actions Repository
15+
uses: actions/checkout@v4
16+
- name: Spell Check Repo
17+
uses: crate-ci/[email protected]
18+
env:
19+
CLICOLOR: 1

_typos.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[files]
2+
extend-exclude = [
3+
"**.cassette.yaml",
4+
"**.go",
5+
"CHANGELOG.md",
6+
"go.mod"
7+
]
8+
9+
[default.extend-words]
10+
pn = "pn"
11+
thi = "thi"

docs/data-sources/object.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
subcategory: "Object Storage"
3+
page_title: "Scaleway: scaleway_object"
4+
---
5+
6+
# scaleway_object
7+
8+
The `scaleway_object` data source is used to retrieve information about an Object Storage object.
9+
10+
Refer to the Object Storage [documentation](https://www.scaleway.com/en/docs/object-storage/how-to/create-a-bucket/) for more information.
11+
12+
## Retrieve an Object Storage object
13+
14+
The following example demonstrates how to retrieve metadata about an object stored in a bucket:
15+
16+
```hcl
17+
resource "scaleway_object_bucket" "main" {
18+
name = "bucket.test.com"
19+
}
20+
21+
resource "scaleway_object" "example" {
22+
bucket = scaleway_object_bucket.main.name
23+
key = "example.txt"
24+
content = "Hello world!"
25+
}
26+
27+
data "scaleway_object" "selected" {
28+
bucket = scaleway_object.example.bucket
29+
key = scaleway_object.example.key
30+
}
31+
```
32+
33+
## Argument Reference
34+
35+
This section lists the arguments that you can provide to the `scaleway_object` data source to filter and retrieve the desired Object Storage bucket. Each argument has a specific purpose:
36+
37+
## Argument Reference
38+
39+
This section lists the arguments that you can provide to the `scaleway_object` data source to filter and retrieve the desired Object Storage bucket. Each argument has a specific purpose:
40+
41+
- `bucket` - (Required) The name of the bucket, or its terraform ID (`{region}/{name}`)
42+
- `key` - (Required) The key (path or filename) of the object within the bucket.
43+
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#zones) in which the bucket exists.
44+
- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project with which the bucket is associated.
45+
46+
## Attributes Reference
47+
48+
The `scaleway_object` data source exports certain attributes once the object information is retrieved. These attributes can be referenced in other parts of your Terraform configuration.
49+
50+
In addition to all above arguments, the following attribute is exported:
51+
52+
* `id` - The unique identifier of the object.
53+
54+
~> **Important**: Object IDs are regional, and follow the format {region}/{bucket}/{key}, e.g. fr-par/bucket-name/example.txt.
55+

docs/guides/regions_and_zones.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ page_title: "Scaleway Zones and Regions"
66

77
Scaleway's products are deployed across multiple datacenter in the world.
88

9-
For technical and legal reasons, some products are splitted by Region or by Availability Zones.
9+
For technical and legal reasons, some products are split by Region or by Availability Zones.
1010
When using such product, you can choose the location that better fits your need (country, latency, ...).
1111

1212
## Regions

docs/resources/block_snapshot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ In addition to all arguments above, the following attributes are exported:
9797

9898
- `id` - The ID of the snapshot.
9999

100-
~> **Important:** The IDs of Block Storage volumes snapshots are [zoned](../guides/regions_and_zones.md#resource-ids), meaning that the zone is part of the ID, in the form `{zone}/{id}`. For example, a snapshot ID migt be `fr-par-1/11111111-1111-1111-1111-111111111111`.
100+
~> **Important:** The IDs of Block Storage volumes snapshots are [zoned](../guides/regions_and_zones.md#resource-ids), meaning that the zone is part of the ID, in the form `{zone}/{id}`. For example, a snapshot ID might be `fr-par-1/11111111-1111-1111-1111-111111111111`.
101101

102102
## Import
103103

docs/resources/cockpit_grafana_user.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This section lists the arguments that are supported:
3434

3535
- `login` - (Required) The username of the Grafana user. The `admin` user is not yet available for creation. You need your Grafana username to log in to Grafana and access your dashboards.
3636
- `role` - (Required) The role assigned to the Grafana user. Must be `editor` or `viewer`.
37-
- `project_id` - (Defaults to Project ID speficied in the [provider configuration](../index.md#project_id)) The ID of the Project the Cockpit is associated with.
37+
- `project_id` - (Defaults to Project ID specified in the [provider configuration](../index.md#project_id)) The ID of the Project the Cockpit is associated with.
3838

3939
## Attributes Reference
4040

docs/resources/domain_record.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Refer to the Domains and DNS [product documentation](https://www.scaleway.com/en
1313

1414
### Create basic DNS records
1515

16-
The folllowing commands allow you to:
16+
The following commands allow you to:
1717

1818
- create an A record for the `www.domain.tld` domain, pointing to `1.2.3.4` and another one pointing to `1.2.3.5`
1919

@@ -57,7 +57,7 @@ resource "scaleway_domain_record" "mx2" {
5757

5858
### Create dynamic records
5959

60-
The folllowing commands allow you to:
60+
The following commands allow you to:
6161

6262
- create a Geo IP record for `images.domain.tld` that points to different IPs based on the user's location: `1.2.3.5` for users in France (EU), and `4.3.2.1` for users in North America (NA)
6363

docs/resources/iot_hub.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The following arguments are supported:
3030

3131
~> **Important:** Updates to `product_plan` will recreate the IoT Hub Instance.
3232

33-
- `enabled` - (Optional) Wether the IoT Hub instance should be enabled or not.
33+
- `enabled` - (Optional) Whether the IoT Hub instance should be enabled or not.
3434

3535
~> **Important:** Updates to `enabled` will disconnect eventually connected devices.
3636

@@ -54,7 +54,7 @@ In addition to all arguments above, the following attributes are exported:
5454
- `device_count` - The number of registered devices in the Hub.
5555
- `connected_device_count` - The current number of connected devices in the Hub.
5656
- `mqtt_ca_url` - The MQTT ca url
57-
- `mqtt_ca` - The MQTT certificat content
57+
- `mqtt_ca` - The MQTT certificate content
5858

5959

6060
## Import

docs/resources/ipam_ip.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ The following arguments are supported:
115115
- `private_network_id` - The Private Network of the IP (if the IP is a private IP).
116116
- `subnet_id` - The Private Network subnet of the IP (if the IP is a private IP).
117117
- `is_ipv6` - (Optional) Defines whether to request an IPv6 address instead of IPv4.
118-
- `custome_resource` - (Optional) The custom resource to attach to the IP being reserved. An example of a custom resource is a virtual machine hosted on an Elastic Metal server.
118+
- `custom_resource` - (Optional) The custom resource to attach to the IP being reserved. An example of a custom resource is a virtual machine hosted on an Elastic Metal server.
119119
- `mac_address` - The MAC address of the custom resource.
120120
- `name` - When the resource is in a Private Network, a DNS record is available to resolve the resource name.
121121
- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) of the IP.

docs/resources/k8s_pool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The following arguments are supported:
5656

5757
- `tags` - (Optional) The tags associated with the pool.
5858

59-
-> Note: As mentionned in [this document](https://github.com/scaleway/scaleway-cloud-controller-manager/blob/master/docs/tags.md#taints), taints of a pool's nodes are applied using tags. (e.g.: `"taint=taintName=taintValue:Effect"`)
59+
-> Note: As mentioned in [this document](https://github.com/scaleway/scaleway-cloud-controller-manager/blob/master/docs/tags.md#taints), taints of a pool's nodes are applied using tags. (e.g.: `"taint=taintName=taintValue:Effect"`)
6060

6161
- `placement_group_id` - (Optional) The [placement group](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-create-a-placement-group) the nodes of the pool will be attached to.
6262

0 commit comments

Comments
 (0)