Skip to content

Commit b2c6927

Browse files
committed
add info about hypernode-object-storage objects to getting-started-with-object-storage
1 parent c090c3a commit b2c6927

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

docs/hypernode-platform/object-storage/getting-started-with-object-storage.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,56 @@ app@testhypernode ~ # hypernode-object-storage info
6363

6464
You can use the credentials and the URL now to configure remote storage for your application with the help of [this document](../../ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md).
6565

66+
### Managing objects in object storage
67+
68+
You can manage your objects using the `hypernode-object-storage objects` subcommand.
69+
It supports all common operations--listing, copying, moving, and deleting files--while also allowing you to sync files in the background and monitor the progress of an ongoing sync.
70+
71+
```console
72+
app@testhypernode ~ # hypernode-object-storage objects --help
73+
usage: hypernode-object-storage objects [-h] {sync,cp,ls,mv,rm,show} ...
74+
75+
Manage objects in object storage
76+
77+
positional arguments:
78+
{sync,cp,ls,mv,rm,show}
79+
sync Synchronize files between a local directory and an object storage location
80+
cp Copy a file or object from one location to another
81+
ls List objects in an S3 bucket or folder
82+
mv Move or rename a file or object
83+
rm Delete an object from S3
84+
show Display the current status of an ongoing sync process
85+
86+
options:
87+
-h, --help show this help message and exit
88+
```
89+
90+
It is important to note that `hypernode-object-storage objects` supports all optional flags available in `aws s3`, allowing you to customize its behavior for advanced configurations.
91+
92+
#### Syncing files and monitoring progress
93+
94+
Syncing files between your local directory and object storage is simple. Run the following command:
95+
96+
```console
97+
app@testhypernode ~ # hypernode-object-storage objects sync /example/local/path/ s3://example/bucket/uri/
98+
Syncing objects from /example/local/path/ to s3://example/bucket/uri/...
99+
Sync process started with PID 1234 in the background.
100+
```
101+
102+
The `sync` operation runs in the background, and you can monitor its progress by using the `show` command, for example:
103+
104+
```console
105+
app@testhypernode ~ # hypernode-object-storage objects show 1234
106+
Completed 9.7 GiB/~30.0 GiB (118.2 MiB/s) with ~5 file(s) remaining (calculating...)
107+
```
108+
109+
If you run the `show` command after the sync operation has finished, you’ll see output like this:
110+
111+
```console
112+
app@testhypernode ~ # hypernode-object-storage objects show 1234
113+
Process 1234 does not exist anymore
114+
```
115+
66116
## UI option - Control Panel
67117

68118
Coming soon

0 commit comments

Comments
 (0)