Skip to content

Commit

Permalink
rename s3 occurrences with object storage correspondent names (#692)
Browse files Browse the repository at this point in the history
* rename s3 occurrences with object storage correspondent names

* fix spacing for renaming

* update gitbook

* fix small issues like all caps, grammar, more specific doc
  • Loading branch information
digna-ionos authored Oct 23, 2024
1 parent 1865b60 commit 0480ac6
Show file tree
Hide file tree
Showing 101 changed files with 729 additions and 729 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export IONOS_USERNAME="username"
export IONOS_PASSWORD="password"
```

For managing IONOS S3 STORAGE resources you need to set the following environment variables with your credentials
For managing IONOS Object Storage resources you need to set the following environment variables with your credentials
```bash
export IONOS_S3_ACCESS_KEY="accesskey"
export IONOS_S3_SECRET_KEY="secretkey"
Expand Down Expand Up @@ -104,8 +104,8 @@ See the [IonosCloud Provider documentation](https://registry.terraform.io/provid
| `IONOS_LOG_LEVEL` | Specify the Log Level used to log messages. Possible values: Off, Debug, Trace |
| `IONOS_PINNED_CERT` | Specify the SHA-256 public fingerprint here, enables certificate pinning |
| `IONOS_CONTRACT_NUMBER` | Specify the contract number on which you wish to provision. Only valid for reseller accounts, for other types of accounts the header will be ignored |
| `IONOS_S3_ACCESS_KEY` | Specify the access key used to authenticate against the IONOS S3 STORAGE API |
| `IONOS_S3_SECRET_KEY` | Specify the secret key used to authenticate against the IONOS S3 STORAGE API |
| `IONOS_S3_ACCESS_KEY` | Specify the access key used to authenticate against the IONOS Object Storage API |
| `IONOS_S3_SECRET_KEY` | Specify the secret key used to authenticate against the IONOS Object Storage API |


## Certificate pinning:
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/application_loadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ The following attributes are returned by the datasource:
- `logging_lormat` - Specifies the format of the logs.
- `flowlog` - Only 1 flow log can be configured. Only the name field can change as part of an update. Flow logs holistically capture network information such as source and destination IP addresses, source and destination ports, number of packets, amount of bytes, the start and end time of the recording, and the type of protocol – and log the extent to which your instances are being accessed.
- `action` - Specifies the action to be taken when the rule is matched. Possible values: ACCEPTED, REJECTED, ALL. Immutable, forces re-creation.
- `bucket` - Specifies the S3 IONOS bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.
- `bucket` - Specifies the IONOS Object Storage bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.
- `direction` - Specifies the traffic direction pattern. Valid values: INGRESS, EGRESS, BIDIRECTIONAL. Immutable, forces re-creation.
- `name` - Specifies the name of the flow log.
2 changes: 1 addition & 1 deletion docs/data-sources/dbaas_pgsql_backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The following attributes are returned by the datasource:
* `id` - The unique ID of the resource.
* `cluster_id` - The unique ID of the cluster
* `size` - The size of all base backups including the wal size in MB.
* `location` - The S3 location where the backups will be stored.
* `location` - The IONOS Object Storage location where the backups will be stored.
* `version` - The PostgreSQL version this backup was created from.
* `is_active` - Whether a cluster currently backs up data to this backup.
* `earliest_recovery_target_time` - The oldest available timestamp to which you can restore.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/dbaas_pgsql_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The following attributes are returned by the datasource:
* `lan_id` - The LAN to connect your cluster to.
* `cidr` - The IP and subnet for the database.
* `location` - The physical location where the cluster will be created. This will be where all of your instances live.
* `backup_location` - The S3 location where the backups will be stored.
* `backup_location` - The IONOS Object Storage location where the backups will be stored.
* `display_name` - The friendly name of your cluster.
* `maintenance_window` - A weekly 4 hour-long window, during which maintenance might occur
* `time`
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/k8s_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ The following attributes are returned by the datasource:
* `nat_gateway_ip` - the NAT gateway IP of the cluster if the cluster is private.
* `node_subnet` - the node subnet of the cluster, if the cluster is private.
* `location` - this attribute is mandatory if the cluster is private.
* `s3_buckets` - list of S3 bucket configured for K8s usage
* `s3_buckets` - list of IONOS Object Storage bucket configured for K8s usage
* `kube_config` - Kubernetes configuration
* `config` - structured kubernetes config consisting of a list with 1 item with the following fields:
* api_version - Kubernetes API Version
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/networkloadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,6 @@ The following attributes are returned by the datasource:
- `logging_lormat` - Specifies the format of the logs.
* `flowlog` - Only 1 flow log can be configured. Only the name field can change as part of an update. Flow logs holistically capture network information such as source and destination IP addresses, source and destination ports, number of packets, amount of bytes, the start and end time of the recording, and the type of protocol – and log the extent to which your instances are being accessed.
- `action` - Specifies the action to be taken when the rule is matched. Possible values: ACCEPTED, REJECTED, ALL. Immutable, forces re-creation.
- `bucket` - Specifies the S3 IONOS bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.
- `bucket` - Specifies the IONOS Object Storage bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.
- `direction` - Specifies the traffic direction pattern. Valid values: INGRESS, EGRESS, BIDIRECTIONAL. Immutable, forces re-creation.
- `name` - Specifies the name of the flow log.
2 changes: 1 addition & 1 deletion docs/data-sources/nic.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,6 @@ The following attributes are returned by the datasource:
* `pci_slot`- The PCI slot number of the Nic.
* `flowlog` - Only 1 flow log can be configured. Only the name field can change as part of an update. Flow logs holistically capture network information such as source and destination IP addresses, source and destination ports, number of packets, amount of bytes, the start and end time of the recording, and the type of protocol – and log the extent to which your instances are being accessed.
- `action` - Specifies the action to be taken when the rule is matched. Possible values: ACCEPTED, REJECTED, ALL.
- `bucket` - Specifies the S3 IONOS bucket where the flow log data will be stored. The bucket must exist.
- `bucket` - Specifies the IONOS Object Storage bucket where the flow log data will be stored. The bucket must exist.
- `direction` - Specifies the traffic direction pattern. Valid values: INGRESS, EGRESS, BIDIRECTIONAL.
- `name` - Specifies the name of the flow log.
4 changes: 2 additions & 2 deletions docs/data-sources/s3_bucket.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
subcategory: "S3"
subcategory: "Object Storage"
layout: "ionoscloud"
page_title: "IonosCloud: s3_bucket"
sidebar_current: "docs-ionoscloud-datasource-s3_bucket"
description: |-
Get information about IonosCloud S3 Buckets.
Get information about IonosCloud IONOS Object Storage Buckets.
---

# ionoscloud_s3_bucket
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/s3_bucket_policy.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
subcategory: "S3"
subcategory: "Object Storage"
layout: "ionoscloud"
page_title: "IonosCloud: s3_bucket_policy"
sidebar_current: "docs-ionoscloud-datasource-s3_bucket_policy"
description: |-
Get information about IonosCloud S3 Buckets policies.
Get information about IONOS Object Storage Buckets policies.
---

# ionoscloud_s3_bucket_policy
Expand Down
18 changes: 9 additions & 9 deletions docs/data-sources/s3_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ layout: "ionoscloud"
page_title: "IonosCloud: s3_key"
sidebar_current: "docs-resource-s3-key"
description: |-
Get Information on a IonosCloud s3 key
Get Information on a IonosCloud Object Storage key
---

# ionoscloud_s3_key

The **S3 key data source** can be used to search for and return an existing s3 key.
You can provide a string id which will be compared with provisioned s3 keys.
The **IONOS Object Storage key data source** can be used to search for and return an existing IONOS Object Storage key.
You can provide a string id which will be compared with provisioned IONOS Object Storage keys.
If a single match is found, it will be returned. If your search results in multiple matches, an error will be returned.
When this happens, please refine your search string so that it is specific enough to return only one result.

## Example Usage

```hcl
data "ionoscloud_s3_key" "example" {
id = <s3_key_id>
id = <key_id>
user_id = <user-uuid>
}
```
Expand All @@ -27,14 +27,14 @@ data "ionoscloud_s3_key" "example" {

The following arguments are supported:

- `user_id` - (Required)[string] The UUID of the user owning the S3 Key.
- `id` - (Required) ID of the s3 key you want to search for.
- `user_id` - (Required)[string] The UUID of the user owning the IONOS Object Storage Key.
- `id` - (Required) ID of the IONOS Object Storage key you want to search for.

## Attributes Reference

The following attributes are returned by the datasource:

* `id` - The id of the s3 key
* `active` - The state of the s3 key
* `id` - The id of the IONOS Object Storage key
* `active` - The state of the IONOS Object Storage key
* `user_id` - The ID of the user that owns the key
* `secret_key` - (Computed)The S3 Secret key.
* `secret_key` - (Computed)The IONOS Object Storage Secret key.
4 changes: 2 additions & 2 deletions docs/data-sources/s3_object.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
subcategory: "S3"
subcategory: "Object Storage"
layout: "ionoscloud"
page_title: "IonosCloud: s3_object"
sidebar_current: "docs-ionoscloud-datasource-s3_object"
description: |-
Get information about IonosCloud S3 Objects.
Get information about IONOS Object Storage Objects.
---

# ionoscloud_s3_object
Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/s3_objects.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
subcategory: "S3"
subcategory: "Object Storage"
layout: "ionoscloud"
page_title: "IonosCloud: s3_objects"
sidebar_current: "docs-ionoscloud-datasource-s3_objects"
description: |-
Get information about IonosCloud S3 Objects.
Get information about IONOS Object Storage Objects.
---

# ionoscloud_s3_objects
Expand Down
10 changes: 5 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can set the environment variables for HTTP basic authentication:
export IONOS_USERNAME="username"
export IONOS_PASSWORD="password"
```
For managing IONOS S3 STORAGE resources you need to set the following environment variables with your credentials
For managing IONOS Object Storage resources you need to set the following environment variables with your credentials
```bash
export IONOS_S3_ACCESS_KEY="accesskey"
export IONOS_S3_SECRET_KEY="secretkey"
Expand Down Expand Up @@ -123,9 +123,9 @@ The following arguments are supported:

- `contract_number` - "To be set only for reseller accounts. Allows to run terraform on a contract number under a reseller account.",

- `s3_access_key` - Required for managing IONOS S3 STORAGE resources.
- `s3_access_key` - Required for managing IONOS Object Storage resources.

- `s3_secret_key` - Required for managing IONOS S3 STORAGE resources.
- `s3_secret_key` - Required for managing IONOS Object Storage resources.

### Environment Variables

Expand All @@ -138,8 +138,8 @@ The following arguments are supported:
| `IONOS_LOG_LEVEL` | Specify the Log Level used to log messages. Possible values: Off, Debug, Trace |
| `IONOS_PINNED_CERT` | Specify the SHA-256 public fingerprint here, enables certificate pinning |
| `IONOS_CONTRACT_NUMBER` | Specify the contract number on which you wish to provision. Only valid for reseller accounts, for other types of accounts the header will be ignored |
| `IONOS_S3_ACCESS_KEY` | Specify the access key used to authenticate against the IONOS S3 STORAGE API |
| `IONOS_S3_SECRET_KEY` | Specify the secret key used to authenticate against the IONOS S3 STORAGE API |
| `IONOS_S3_ACCESS_KEY` | Specify the access key used to authenticate against the IONOS Object Storage API |
| `IONOS_S3_SECRET_KEY` | Specify the secret key used to authenticate against the IONOS Object Storage API |

## Resource Timeout

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/application_loadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The following arguments are supported:
- `logging_lormat` - (Optional)[string] Specifies the format of the logs.
- `flowlog` - (Optional)[list] Only 1 flow log can be configured. Only the name field can change as part of an update. Flow logs holistically capture network information such as source and destination IP addresses, source and destination ports, number of packets, amount of bytes, the start and end time of the recording, and the type of protocol – and log the extent to which your instances are being accessed.
- `action` - (Required)[string] Specifies the action to be taken when the rule is matched. Possible values: ACCEPTED, REJECTED, ALL. Immutable, forces re-creation.
- `bucket` - (Required)[string] Specifies the S3 IONOS bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.
- `bucket` - (Required)[string] Specifies the IONOS Object Storage bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.
- `direction` - (Required)[string] Specifies the traffic direction pattern. Valid values: INGRESS, EGRESS, BIDIRECTIONAL. Immutable, forces re-creation.
- `name` - (Required)[string] Specifies the name of the flow log.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/autoscaling_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ The following arguments are supported:
- `type` - (Optional)[string] The type of firewall rule. If is not specified, it will take the default value INGRESS.
- `flow_log` - (Optional)[list] Only 1 flow log can be configured. Only the name field can change as part of an update. Flow logs holistically capture network information such as source and destination IP addresses, source and destination ports, number of packets, amount of bytes, the start and end time of the recording, and the type of protocol – and log the extent to which your instances are being accessed.
- `action` - (Required)[string] Specifies the action to be taken when the rule is matched. Possible values: ACCEPTED, REJECTED, ALL. Immutable, forces re-creation.
- `bucket` - (Required)[string] Specifies the S3 IONOS bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.
- `bucket` - (Required)[string] Specifies the IONOS Object Storage bucket where the flow log data will be stored. The bucket must exist. Immutable, forces re-creation.
- `direction` - (Required)[string] Specifies the traffic direction pattern. Valid values: INGRESS, EGRESS, BIDIRECTIONAL. Immutable, forces re-creation.
- `name` - (Required)[string] Specifies the name of the flow log.
- `target_group` - (Optional)[list] In order to link VM to ALB, target group must be provided
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dbaas_pgsql_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ resource "random_password" "cluster_password" {
* `lan_id` - (Required)[true] The LAN to connect your cluster to.
* `cidr` - (Required)[true] The IP and subnet for the database. Note the following unavailable IP ranges: 10.233.64.0/18, 10.233.0.0/18, 10.233.114.0/24. Please enter in the correct format like IP/Subnet, exp: 192.168.10.0/24. See [Private IPs](https://www.ionos.com/help/server-cloud-infrastructure/private-network/private-ip-address-ranges/) and [Configuring the network](https://docs.ionos.com/cloud/compute-engine/networks/how-tos/configure-networks).
* `location` - (Required)[string] The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation. Possible values are: `de/fra`, `de/txl`, `gb/lhr`, `es/vit`, `us/ewr`, `us/las`. This attribute is immutable(disallowed in update requests).
* `backup_location` - (Optional)(Computed)[string] The S3 location where the backups will be stored. Possible values are: `de`, `eu-south-2`, `eu-central-2`. This attribute is immutable (disallowed in update requests).
* `backup_location` - (Optional)(Computed)[string] The IONOS Object Storage location where the backups will be stored. Possible values are: `de`, `eu-south-2`, `eu-central-2`. This attribute is immutable (disallowed in update requests).
* `display_name` - (Required)[string] The friendly name of your cluster.
* `maintenance_window` - (Optional)(Computed)[string] A weekly 4 hour-long window, during which maintenance might occur
* `time` - (Required)[string]
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/k8s_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ resource "ionoscloud_k8s_cluster" "example" {
}
api_subnet_allow_list = ["1.2.3.4/32"]
s3_buckets {
name = "globally_unique_s3_bucket_name"
name = "globally_unique_bucket_name"
}
}
```
Expand Down Expand Up @@ -54,7 +54,7 @@ resource "ionoscloud_k8s_cluster" "example" {
}
api_subnet_allow_list = ["1.2.3.4/32"]
s3_buckets {
name = "globally_unique_s3_bucket_name"
name = "globally_unique_bucket_name"
}
location = "de/fra"
nat_gateway_ip = ionoscloud_ipblock.k8sip.ips[0]
Expand All @@ -74,7 +74,7 @@ The following arguments are supported:
- `day_of_the_week` - (Required)[string] Day of the week when maintenance is allowed
- `viable_node_pool_versions` - (Computed)[list] List of versions that may be used for node pools under this cluster
- `api_subnet_allow_list` - (Optional)[list] Access to the K8s API server is restricted to these CIDRs. Cluster-internal traffic is not affected by this restriction. If no allowlist is specified, access is not restricted. If an IP without subnet mask is provided, the default value will be used: 32 for IPv4 and 128 for IPv6.
- `s3_buckets` - (Optional)[list] List of S3 bucket configured for K8s usage. For now it contains only an S3 bucket used to store K8s API audit logs.
- `s3_buckets` - (Optional)[list] List of IONOS Object Storage buckets configured for K8s usage. For now it contains only an IONOS Object Storage bucket used to store K8s API audit logs.
- `public` - (Optional)[boolean] Indicates if the cluster is public or private. This attribute is immutable.
- `nat_gateway_ip` - (Optional)[string] The NAT gateway IP of the cluster if the cluster is private. This attribute is immutable. Must be a reserved IP in the same location as the cluster's location. This attribute is mandatory if the cluster is private.
- `node_subnet` - (Optional)[string] The node subnet of the cluster, if the cluster is private. This attribute is optional and immutable. Must be a valid CIDR notation for an IPv4 network prefix of 16 bits length.
Expand Down
Loading

0 comments on commit 0480ac6

Please sign in to comment.