Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: change naming for Scaleway Object Storage #4236

Merged
merged 1 commit into from
Oct 29, 2024
Merged
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
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Export a snapshot to a specified S3 bucket in the same region.
Export a snapshot to a specified Object Storage bucket in the same region.

USAGE:
scw instance snapshot export [arg=value ...]

EXAMPLES:
Export a snapshot to an S3 bucket
Export a snapshot to an Object Storage bucket
scw instance snapshot export zone=fr-par-1 snapshot-id=11111111-1111-1111-1111-111111111111 bucket=my-bucket key=my-qcow2-file-name

ARGS:
[bucket] S3 bucket name
[key] S3 object key
[bucket] Object Storage bucket name
[key] Object key
snapshot-id Snapshot ID
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Multiple kinds of routes can be created, such as:
<b>You need to manage the database by yourself</b>.
- REST Route.
Create a route that will call a REST API on received subscribed MQTT messages.
- S3 Routes.
Create a route that will put subscribed MQTT messages into an S3 bucket.
- Amazon S3 Routes.
Create a route that will put subscribed MQTT messages into an Object Storage bucket.
You need to create the bucket yourself and grant write access.
Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ ARGS:
[timeout-tunnel=15m] Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout)
[on-marked-down-action] Action to take when a backend server is marked as down (on_marked_down_action_none | shutdown_sessions)
[proxy-protocol] Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software (proxy_protocol_unknown | proxy_protocol_none | proxy_protocol_v1 | proxy_protocol_v2 | proxy_protocol_v2_ssl | proxy_protocol_v2_ssl_cn)
[failover-host] Scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud
[failover-host] Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud
[ssl-bridging] Defines whether to enable SSL bridging between the Load Balancer and backend servers
[ignore-ssl-server-verify] Defines whether the server certificate verification should be ignored
[redispatch-attempt-count] Whether to use another backend server on each attempt
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ARGS:
[timeout-tunnel=15m] Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout)
[on-marked-down-action] Action to take when a backend server is marked as down (on_marked_down_action_none | shutdown_sessions)
[proxy-protocol] Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software (proxy_protocol_unknown | proxy_protocol_none | proxy_protocol_v1 | proxy_protocol_v2 | proxy_protocol_v2_ssl | proxy_protocol_v2_ssl_cn)
[failover-host] Scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud
[failover-host] Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud
[ssl-bridging] Defines whether to enable SSL bridging between the Load Balancer and backend servers
[ignore-ssl-server-verify] Defines whether the server certificate verification should be ignored
[redispatch-attempt-count] Whether to use another backend server on each attempt
Expand Down
8 changes: 4 additions & 4 deletions docs/commands/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -2531,7 +2531,7 @@ scw instance snapshot delete 11111111-1111-1111-1111-111111111111 zone=fr-par-1

### Export a snapshot

Export a snapshot to a specified S3 bucket in the same region.
Export a snapshot to a specified Object Storage bucket in the same region.

**Usage:**

Expand All @@ -2544,16 +2544,16 @@ scw instance snapshot export [arg=value ...]

| Name | | Description |
|------|---|-------------|
| bucket | | S3 bucket name |
| key | | S3 object key |
| bucket | | Object Storage bucket name |
| key | | Object key |
| snapshot-id | Required | Snapshot ID |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config |


**Examples:**


Export a snapshot to an S3 bucket
Export a snapshot to an Object Storage bucket
```
scw instance snapshot export zone=fr-par-1 snapshot-id=11111111-1111-1111-1111-111111111111 bucket=my-bucket key=my-qcow2-file-name
```
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/iot.md
Original file line number Diff line number Diff line change
Expand Up @@ -590,8 +590,8 @@ Multiple kinds of routes can be created, such as:
<b>You need to manage the database by yourself</b>.
- REST Route.
Create a route that will call a REST API on received subscribed MQTT messages.
- S3 Routes.
Create a route that will put subscribed MQTT messages into an S3 bucket.
- Amazon S3 Routes.
Create a route that will put subscribed MQTT messages into an Object Storage bucket.
You need to create the bucket yourself and grant write access.
Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).

Expand Down
4 changes: 2 additions & 2 deletions docs/commands/lb.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ scw lb backend create [arg=value ...]
| timeout-tunnel | Default: `15m` | Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout) |
| on-marked-down-action | One of: `on_marked_down_action_none`, `shutdown_sessions` | Action to take when a backend server is marked as down |
| proxy-protocol | One of: `proxy_protocol_unknown`, `proxy_protocol_none`, `proxy_protocol_v1`, `proxy_protocol_v2`, `proxy_protocol_v2_ssl`, `proxy_protocol_v2_ssl_cn` | Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software |
| failover-host | | Scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud |
| failover-host | | Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud |
| ssl-bridging | | Defines whether to enable SSL bridging between the Load Balancer and backend servers |
| ignore-ssl-server-verify | | Defines whether the server certificate verification should be ignored |
| redispatch-attempt-count | | Whether to use another backend server on each attempt |
Expand Down Expand Up @@ -488,7 +488,7 @@ scw lb backend update <backend-id ...> [arg=value ...]
| timeout-tunnel | Default: `15m` | Maximum allowed tunnel inactivity time after Websocket is established (takes precedence over client and server timeout) |
| on-marked-down-action | One of: `on_marked_down_action_none`, `shutdown_sessions` | Action to take when a backend server is marked as down |
| proxy-protocol | One of: `proxy_protocol_unknown`, `proxy_protocol_none`, `proxy_protocol_v1`, `proxy_protocol_v2`, `proxy_protocol_v2_ssl`, `proxy_protocol_v2_ssl_cn` | Protocol to use between the Load Balancer and backend servers. Allows the backend servers to be informed of the client's real IP address. The PROXY protocol must be supported by the backend servers' software |
| failover-host | | Scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud |
| failover-host | | Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud |
| ssl-bridging | | Defines whether to enable SSL bridging between the Load Balancer and backend servers |
| ignore-ssl-server-verify | | Defines whether the server certificate verification should be ignored |
| redispatch-attempt-count | | Whether to use another backend server on each attempt |
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ require (
github.com/mattn/go-isatty v0.0.20
github.com/moby/buildkit v0.13.2
github.com/opencontainers/go-digest v1.0.0
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241025151430-736ebc291485
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241028153617-2a48843b5fcb
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
github.com/spf13/cobra v1.8.1
github.com/spf13/pflag v1.0.5
Expand Down
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -465,8 +465,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241025151430-736ebc291485 h1:pio5yJbu5NPDTB4qRsQTf/w/9XwBZS/Vud0oXqVAZIA=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241025151430-736ebc291485/go.mod h1:3jrRJM7638J+P33hKy9MBvfOBxNo8pEGNQQoIv65Ihg=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241028153617-2a48843b5fcb h1:OsRpbw60numCy/+3FS7UhZzkdiTu6OZwq29bb4b3gNo=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241028153617-2a48843b5fcb/go.mod h1:3jrRJM7638J+P33hKy9MBvfOBxNo8pEGNQQoIv65Ihg=
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,8 @@ Region fr-par
"sandbox": "unknown_sandbox",
"local_storage_limit": 0,
"scaling_option": null,
"created_at": null,
"updated_at": null,
"ready_at": null,
"region": "fr-par"
}
8 changes: 4 additions & 4 deletions internal/namespaces/instance/v1/instance_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -1605,7 +1605,7 @@ func instanceSnapshotDelete() *core.Command {
func instanceSnapshotExport() *core.Command {
return &core.Command{
Short: `Export a snapshot`,
Long: `Export a snapshot to a specified S3 bucket in the same region.`,
Long: `Export a snapshot to a specified Object Storage bucket in the same region.`,
Namespace: "instance",
Resource: "snapshot",
Verb: "export",
Expand All @@ -1614,14 +1614,14 @@ func instanceSnapshotExport() *core.Command {
ArgSpecs: core.ArgSpecs{
{
Name: "bucket",
Short: `S3 bucket name`,
Short: `Object Storage bucket name`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "key",
Short: `S3 object key`,
Short: `Object key`,
Required: false,
Deprecated: false,
Positional: false,
Expand All @@ -1645,7 +1645,7 @@ func instanceSnapshotExport() *core.Command {
},
Examples: []*core.Example{
{
Short: "Export a snapshot to an S3 bucket",
Short: "Export a snapshot to an Object Storage bucket",
ArgsJSON: `{"bucket":"my-bucket","key":"my-qcow2-file-name","snapshot_id":"11111111-1111-1111-1111-111111111111","zone":"fr-par-1"}`,
},
},
Expand Down
4 changes: 2 additions & 2 deletions internal/namespaces/iot/v1/iot_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -1173,8 +1173,8 @@ func iotRouteCreate() *core.Command {
<b>You need to manage the database by yourself</b>.
- REST Route.
Create a route that will call a REST API on received subscribed MQTT messages.
- S3 Routes.
Create a route that will put subscribed MQTT messages into an S3 bucket.
- Amazon S3 Routes.
Create a route that will put subscribed MQTT messages into an Object Storage bucket.
You need to create the bucket yourself and grant write access.
Granting can be done with s3cmd (` + "`" + `s3cmd setacl s3://<my-bucket> --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031` + "`" + `).`,
Namespace: "iot",
Expand Down
4 changes: 2 additions & 2 deletions internal/namespaces/lb/v1/lb_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -1041,7 +1041,7 @@ func lbBackendCreate() *core.Command {
},
{
Name: "failover-host",
Short: `Scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud`,
Short: `Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -1242,7 +1242,7 @@ func lbBackendUpdate() *core.Command {
},
{
Name: "failover-host",
Short: `Scaleway S3 bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud`,
Short: `Scaleway Object Storage bucket website to be served as failover if all backend servers are down, e.g. failover-website.s3-website.fr-par.scw.cloud`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down
Loading