Skip to content

Improve Hypernode Object Storage CLI docs #374

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

Open
wants to merge 1 commit into
base: update-suggest-changes-to-v2
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions docs/hypernode-platform/object-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ glob:
object-storage/getting-started
object-storage/*
```

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.
137 changes: 137 additions & 0 deletions docs/hypernode-platform/object-storage/basic-commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
---
myst:
html_meta:
description: Learn about the basic commands for managing Hypernode Object Storage
title: Hypernode Object Storage | Basic Commands
---

# Basic Commands

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.

## Creating a Workspace

The `create` command initializes a new Object Storage workspace.

```console
hypernode-object-storage create
```

### Options

- `--name`: Specify a custom name for your workspace
- `--plan`: Select a storage plan (e.g., OS50GB, OS200GB)
- `--coupon`: Apply a coupon code for discounts

### Example

```console
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage create --name my-storage --plan OS200GB
```

## Viewing Workspace Information

The `info` command displays details about your current Object Storage workspace.

```console
hypernode-object-storage info
```

### Options

- `--with-credentials`: Display sensitive credentials
- `--verbose`: Show detailed debug information
- `-F {text,json}`: Choose output format (text or JSON)

### Example Output

```console
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage info
UUID | d8770125-6c90-4770-b00f-1716f699990a
Name | example-storage
Plan | OS200GB
Versioning | Disabled
Hypernodes | example
Endpoint URL | **sensitive**
Access Key | **sensitive**
Secret Key | **sensitive**
```

### JSON Output Example

```console
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage info -F json
{
"UUID": "2667238b-9976-437f-98f5-cd7491b76fd8",
"Name": "my workspace",
"Plan": {
"code": "OS200GB",
"name": "Growth Node",
"description": "Great for expanding stores",
"price": 2000,
"storage_size_in_gb": 200,
"is_popular": true
},
"Versioning": false,
"Hypernodes": "example",
"Credentials": {
"management_url": "**sensitive**",
"access_key": "**sensitive**",
"secret_key": "**sensitive**"
}
}
```

## Updating Workspace Settings

The `update` command allows you to modify your Object Storage workspace settings.

```console
hypernode-object-storage update
```

### Options

- `--enable-versioning`: Enable object versioning
- `--disable-versioning`: Disable object versioning

### Example

```console
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage update --enable-versioning
Enabling versioning...
Versioning enabled successfully!
```

```{note}
Enabling versioning increases storage usage as each version of an object is stored separately. Consider your storage plan size when enabling this feature.
```

## Canceling a Workspace

The `cancel` command initiates the cancellation process for your Object Storage workspace.

```console
hypernode-object-storage cancel
```

### Important Notes

1. **Cancellation Timing**

- Cancellation takes effect at the end of the current billing period
- You will be billed for the full period

1. **Data Retention**

- Data remains accessible for 7 days after cancellation
- Use this period to retrieve any needed data

### Example

```console
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage cancel
Are you sure you want to cancel your Object Storage workspace? [y/N]: y
Cancellation initiated. Your workspace will be canceled at the end of the current billing period.
Data will remain accessible for 7 days after cancellation.
```
15 changes: 0 additions & 15 deletions docs/hypernode-platform/object-storage/cancellation.md

This file was deleted.

44 changes: 42 additions & 2 deletions docs/hypernode-platform/object-storage/dynamic-upscaling.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,46 @@ When Dynamic Upscaling is enabled, the system monitors your usage and upgrades y

## Managing Dynamic Upscaling

Dynamic Upscaling can be enabled or disabled through the Control Panel.
### Control Panel

Go to the Control Panel, select the Object Storage workspace you want to enable/disable Dynamic Upscaling for, and toggle the Dynamic Upscaling switch.
Dynamic Upscaling can be enabled or disabled through the Control Panel:

1. Go to the Control Panel
1. Select the Object Storage workspace
1. Toggle the Dynamic Upscaling switch

### Command Line Interface

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).

To enable Dynamic Upscaling:

```console
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage update --enable-dynamic-upscaling
Enabling dynamic upscaling...
Dynamic upscaling enabled successfully!
```

To disable Dynamic Upscaling:

```console
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage update --disable-dynamic-upscaling
Disabling dynamic upscaling...
Dynamic upscaling disabled successfully!
```

To check the current status of Dynamic Upscaling:

```console
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage info
UUID | d8770125-6c90-4770-b00f-1716f699990a
Name | example-storage
Plan | OS200GB
Versioning | Disabled
Dynamic Upscaling | Enabled
Hypernodes | example
```

```{note}
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.
```
6 changes: 6 additions & 0 deletions docs/hypernode-platform/object-storage/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,13 @@ Secret Key | **sensitive**
1. Click your workspace.
1. Click the **Show credentials** button in the top-right corner.

## Setting up your application

You can use the credentials and the URL now to configure remote storage for your application with the help of the following articles:

1. [How to configure remote storage for Magento 2.x](../../ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md)
1. [How to configure remote storage for Shopware 6.x](../../ecommerce-applications/shopware-6/how-to-configure-remote-storage-for-shopware-6-x.md)

## Setting up Nginx

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.
22 changes: 22 additions & 0 deletions docs/hypernode-platform/object-storage/interactive-explorer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
myst:
html_meta:
description: Learn how to use the interactive explorer of Hypernode Object Storage
title: Hypernode Object Storage | Interactive Explorer
---

# Interactive Explorer

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.

## Explore

Launch the interactive explorer with:

```console
hypernode-object-storage explore
```

This opens a terminal UI that looks like this:

![](_res/stu_screenshot.png)
Loading