Skip to content

Commit 7c59b8d

Browse files
committed
chore(gen): s3 tools update (not finished)
1 parent 77ddda7 commit 7c59b8d

File tree

1 file changed

+36
-33
lines changed

1 file changed

+36
-33
lines changed

storage/object/api-cli/managing-lifecycle-cliv2.mdx

Lines changed: 36 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ categories:
1414
- object-storage
1515
---
1616

17-
[Scaleway Object Storage](/storage/object/concepts/#object-storage) is a service based on the Amazon S3 protocol. It allows you to store different types of objects (documents, images, videos, etc.) and distribute them instantly, anywhere in the world. You can create and manage your Object Storage resources from the [console](https://console.scaleway.com/login), or via the [Scaleway Command Line Interface](/developer-tools/scaleway-cli/quickstart/) that uses external tools such as `rclone`, `s3cmd` and `mc`.
17+
[Scaleway Object Storage](/storage/object/concepts/#object-storage) is a service based on the Amazon S3 protocol. It allows you to store different types of objects (documents, images, videos, etc.) and distribute them instantly, anywhere in the world. You can create and manage your Object Storage resources from the [console](https://console.scaleway.com/login), or via the [Scaleway Command Line Interface](/developer-tools/scaleway-cli/quickstart/) that uses external tools such as [S3cmd](https://github.com/s3tools/s3cmd), [Rclone](https://rclone.org/downloads/) or [MinIO Client (mc)](https://github.com/minio/mc).
1818

1919
## Scaleway Command Line Interface Overview
2020

@@ -27,14 +27,11 @@ categories:
2727
- A valid [API key](/identity-and-access-management/iam/how-to/create-api-keys/)
2828
- An [Object Storage bucket](/storage/object/how-to/create-a-bucket/)
2929
- Installed and initialized the [Scaleway CLI](/developer-tools/scaleway-cli/quickstart/)
30-
- Downloaded [S3cmd](https://github.com/s3tools/s3cmd), [rclone](https://rclone.org/downloads/) and [mc](https://github.com/minio/mc)
30+
- Downloaded [S3cmd](https://github.com/s3tools/s3cmd), [Rclone](https://rclone.org/downloads/) and [MinIO Client (mc)](https://github.com/minio/mc)
3131

32+
## Previewing an Object Storage configuration file for the Scaleway CLI
3233

33-
## Creating an Object Storage configuration file for the Scaleway CLI
34-
35-
<Message type="important">
36-
Unless you add a region argument to your commands, the configuration file will be set for the default region.
37-
</Message>
34+
The `scw object config get` command allows you to output the content of the configuration file in a terminal and preview the different fields.
3835

3936
<Message type="note">
4037
For more information about generating a configuration file, type the following command in your terminal:
@@ -43,16 +40,13 @@ categories:
4340
```
4441
</Message>
4542

46-
### Configuration file for Rclone
47-
48-
Run the following command in a terminal to create a configuration file with `rclone`:
49-
43+
<Tabs>
44+
<TabsTab label="Rclone">
45+
Run the following command in a terminal to preview the configuration file for Rclone:
5046
```
5147
scw object config get type=rclone
5248
```
53-
5449
An output similar to the following displays:
55-
5650
```
5751
# Generated by scaleway-cli command
5852
# Configuration file for rclone https://rclone.org/s3/#scaleway
@@ -70,10 +64,9 @@ Run the following command in a terminal to create a configuration file with `rcl
7064
server_side_encryption =
7165
storage_class =
7266
```
73-
74-
### Configuration file for s3cmd
75-
76-
Run the following command in a terminal to create a configuration file with `s3cmd`:
67+
</TabsTab>
68+
<TabsTab label="S3cmd">
69+
Run the following command in a terminal to preview the configuration file for S3cmd:
7770

7871
```
7972
scw object config get type=s3cmd
@@ -92,48 +85,58 @@ Run the following command in a terminal to create a configuration file with `s3c
9285
secret_key = 12345678-1234-1234-4321-123456789123
9386
use_https = True
9487
```
95-
96-
### Configuration file for MinIO Client
97-
98-
3. Run the following command in a terminal to create a configuration file with `mc`:
88+
</TabsTab>
89+
<TabsTab label="MinIO Client (mc)">
90+
Run the following command in a terminal to preview the configuration file for MinIO Client (mc):
9991
```
10092
scw object config get type=mc
10193
```
102-
10394
An output similar to the following displays:
104-
10595
```
10696
{"version":"9","hosts":{"scaleway":{"url":"https://s3.nl-ams.scw.cloud","accessKey":"SCW1111111111111","secretKey":"12345678-1234-1234-4321-123456789123","api":"S3v4"}}}
10797
```
108-
98+
</TabsTab>
99+
</Tabs>
109100

110101
## Installing a configuration file for Amazon S3-compatible tools (s3cmd, rclone, and mc)
111102

112-
1. Run the following command in a terminal to install a configuration file for `s3cmd`:
103+
The `scw object config install` allows you to create a configuration file for the selected third party tool based on your [AWS configuration](/storage/object/api-cli/object-storage-aws-cli/).
104+
105+
<Message type="important">
106+
Creating a new configuration file using `scw object config install` will overwrite the existing one for the specified third party tool. To update an existing configuration, [generate a preview](#previewing-an-object-storage-configuration-file-for-the-scaleway-cli) and manually edit the configuration file.
107+
</Message>
108+
109+
<Tabs>
110+
<TabsTab label="Rclone">
111+
2. Run the following command in a terminal to install a configuration file for Rclone:
112+
113113
```
114-
scw object config install type=s3cmd
114+
scw object config install type=rclone
115115
```
116116

117117
An output similar to the following displays:
118118

119119
```
120-
Configuration file successfully installed at /Users/yourusername/.s3cfg.
120+
Configuration file successfully installed at /Users/yourusername/.config/rclone/rclone.conf.
121121
```
122-
2. Run the following command in a terminal to install a configuration file for `rclone`:
123-
122+
</TabsTab>
123+
<TabsTab label="S3cmd">
124+
Run the following command in a terminal to install a configuration file for `s3cmd`:
124125
```
125-
scw object config install type=rclone
126+
scw object config install type=s3cmd
126127
```
127128

128129
An output similar to the following displays:
129130

130131
```
131-
Configuration file successfully installed at /Users/yourusername/.config/rclone/rclone.conf.
132+
Configuration file successfully installed at /Users/yourusername/.s3cfg.
132133
```
133-
3. Run the following command in a terminal to install a configuration file for `mc`:
134+
</TabsTab>
135+
<TabsTab label="MinIO Client (mc)">
136+
3. Run the following command in a terminal to install a configuration file for MinIO Client (mc):
134137

135138
```
136-
scw object config install type=mc`
139+
scw object config install type=mc
137140
```
138141

139142
An output similar to the following displays:

0 commit comments

Comments
 (0)