Skip to content

Commit 3feca45

Browse files
poespaspoespas
authored
Merge pull request #374 from ByteInternet/improve-objectstorage-cli-docs
Improve Hypernode Object Storage CLI docs
2 parents 0edebf6 + 25c298a commit 3feca45

File tree

7 files changed

+350
-45
lines changed

7 files changed

+350
-45
lines changed

‎docs/hypernode-platform/object-storage.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,5 @@ glob:
3131
object-storage/getting-started
3232
object-storage/*
3333
```
34+
35+
To get started with Hypernode Object Storage, check out our [Getting started](object-storage/getting-started.md) guide for a detailed overview of the system architecture and features.

‎docs/hypernode-platform/object-storage/basic-commands.md‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: Learn about the basic commands for managing Hypernode Object Storage
5+
title: Hypernode Object Storage | Basic Commands
6+
---
7+
8+
# Basic Commands
9+
10+
This guide covers the fundamental commands for managing your Hypernode Object Storage workspace. These commands allow you to create, view, update, and cancel your object storage workspace.
11+
12+
## Creating a Workspace
13+
14+
The `create` command initializes a new Object Storage workspace.
15+
16+
```console
17+
hypernode-object-storage create
18+
```
19+
20+
### Options
21+
22+
- `--name`: Specify a custom name for your workspace
23+
- `--plan`: Select a storage plan (e.g., OS50GB, OS200GB)
24+
- `--coupon`: Apply a coupon code for discounts
25+
26+
### Example
27+
28+
```console
29+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage create --name my-storage --plan OS200GB
30+
```
31+
32+
## Viewing Workspace Information
33+
34+
The `info` command displays details about your current Object Storage workspace.
35+
36+
```console
37+
hypernode-object-storage info
38+
```
39+
40+
### Options
41+
42+
- `--with-credentials`: Display sensitive credentials
43+
- `--verbose`: Show detailed debug information
44+
- `-F {text,json}`: Choose output format (text or JSON)
45+
46+
### Example Output
47+
48+
```console
49+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage info
50+
UUID | d8770125-6c90-4770-b00f-1716f699990a
51+
Name | example-storage
52+
Plan | OS200GB
53+
Versioning | Disabled
54+
Hypernodes | example
55+
Endpoint URL | **sensitive**
56+
Access Key | **sensitive**
57+
Secret Key | **sensitive**
58+
```
59+
60+
### JSON Output Example
61+
62+
```console
63+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage info -F json
64+
{
65+
"UUID": "2667238b-9976-437f-98f5-cd7491b76fd8",
66+
"Name": "my workspace",
67+
"Plan": {
68+
"code": "OS200GB",
69+
"name": "Growth Node",
70+
"description": "Great for expanding stores",
71+
"price": 2000,
72+
"storage_size_in_gb": 200,
73+
"is_popular": true
74+
},
75+
"Versioning": false,
76+
"Hypernodes": "example",
77+
"Credentials": {
78+
"management_url": "**sensitive**",
79+
"access_key": "**sensitive**",
80+
"secret_key": "**sensitive**"
81+
}
82+
}
83+
```
84+
85+
## Updating Workspace Settings
86+
87+
The `update` command allows you to modify your Object Storage workspace settings.
88+
89+
```console
90+
hypernode-object-storage update
91+
```
92+
93+
### Options
94+
95+
- `--enable-versioning`: Enable object versioning
96+
- `--disable-versioning`: Disable object versioning
97+
98+
### Example
99+
100+
```console
101+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage update --enable-versioning
102+
Enabling versioning...
103+
Versioning enabled successfully!
104+
```
105+
106+
```{note}
107+
Enabling versioning increases storage usage as each version of an object is stored separately. Consider your storage plan size when enabling this feature.
108+
```
109+
110+
## Canceling a Workspace
111+
112+
The `cancel` command initiates the cancellation process for your Object Storage workspace.
113+
114+
```console
115+
hypernode-object-storage cancel
116+
```
117+
118+
### Important Notes
119+
120+
1. **Cancellation Timing**
121+
122+
- Cancellation takes effect at the end of the current billing period
123+
- You will be billed for the full period
124+
125+
1. **Data Retention**
126+
127+
- Data remains accessible for 7 days after cancellation
128+
- Use this period to retrieve any needed data
129+
130+
### Example
131+
132+
```console
133+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage cancel
134+
Are you sure you want to cancel your Object Storage workspace? [y/N]: y
135+
Cancellation initiated. Your workspace will be canceled at the end of the current billing period.
136+
Data will remain accessible for 7 days after cancellation.
137+
```

‎docs/hypernode-platform/object-storage/cancellation.md‎

Lines changed: 0 additions & 15 deletions
This file was deleted.

‎docs/hypernode-platform/object-storage/dynamic-upscaling.md‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,46 @@ When Dynamic Upscaling is enabled, the system monitors your usage and upgrades y
1515

1616
## Managing Dynamic Upscaling
1717

18-
Dynamic Upscaling can be enabled or disabled through the Control Panel.
18+
### Control Panel
1919

20-
Go to the Control Panel, select the Object Storage workspace you want to enable/disable Dynamic Upscaling for, and toggle the Dynamic Upscaling switch.
20+
Dynamic Upscaling can be enabled or disabled through the Control Panel:
21+
22+
1. Go to the Control Panel
23+
1. Select the Object Storage workspace
24+
1. Toggle the Dynamic Upscaling switch
25+
26+
### Command Line Interface
27+
28+
You can also manage Dynamic Upscaling using the CLI. First, ensure you have the basic commands set up as described in [Basic Commands](basic-commands.md#updating-workspace-settings).
29+
30+
To enable Dynamic Upscaling:
31+
32+
```console
33+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage update --enable-dynamic-upscaling
34+
Enabling dynamic upscaling...
35+
Dynamic upscaling enabled successfully!
36+
```
37+
38+
To disable Dynamic Upscaling:
39+
40+
```console
41+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage update --disable-dynamic-upscaling
42+
Disabling dynamic upscaling...
43+
Dynamic upscaling disabled successfully!
44+
```
45+
46+
To check the current status of Dynamic Upscaling:
47+
48+
```console
49+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage info
50+
UUID | d8770125-6c90-4770-b00f-1716f699990a
51+
Name | example-storage
52+
Plan | OS200GB
53+
Versioning | Disabled
54+
Dynamic Upscaling | Enabled
55+
Hypernodes | example
56+
```
57+
58+
```{note}
59+
When Dynamic Upscaling is enabled, your plan will automatically upgrade when you reach 99% of your current storage limit. This may result in higher costs, so monitor your usage regularly.
60+
```

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,13 @@ Secret Key | **sensitive**
6262
1. Click your workspace.
6363
1. Click the **Show credentials** button in the top-right corner.
6464

65+
## Setting up your application
66+
6567
You can use the credentials and the URL now to configure remote storage for your application with the help of the following articles:
6668

6769
1. [How to configure remote storage for Magento 2.x](../../ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md)
6870
1. [How to configure remote storage for Shopware 6.x](../../ecommerce-applications/shopware-6/how-to-configure-remote-storage-for-shopware-6-x.md)
71+
72+
## Setting up Nginx
73+
74+
After setting up Object Storage, you will want to configure your Nginx to serve assets directly from your storage bucket. Learn how to do this using Hypernode Managed Vhosts in our [Object Storage and Hypernode Managed Vhosts](../nginx/hypernode-managed-vhosts.md#object-storage-and-hypernode-managed-vhosts) article.

‎docs/hypernode-platform/object-storage/interactive-explorer.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
myst:
3+
html_meta:
4+
description: Learn how to use the interactive explorer of Hypernode Object Storage
5+
title: Hypernode Object Storage | Interactive Explorer
6+
---
7+
8+
# Interactive Explorer
9+
10+
Hypernode Object Storage provides an interactive terminal interface for exploring and managing your objects. The `explore` command launches a user-friendly terminal UI that makes it easy to navigate through your storage, view object versions, and perform common operations.
11+
12+
## Explore
13+
14+
Launch the interactive explorer with:
15+
16+
```console
17+
hypernode-object-storage explore
18+
```
19+
20+
This opens a terminal UI that looks like this:
21+
22+
![](_res/stu_screenshot.png)

0 commit comments

Comments
 (0)