From cf22bbe5f91af71e8a440181c8331550bb812e6c Mon Sep 17 00:00:00 2001 From: Hritik Kothari Date: Fri, 7 Feb 2025 14:42:50 +0100 Subject: [PATCH 1/8] Add object storage docs --- docs/hypernode-platform/object-storage.md | 20 +++++++++++++++++++ .../getting-started-with-object-storage.md | 18 +++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/hypernode-platform/object-storage.md create mode 100644 docs/hypernode-platform/object-storage/getting-started-with-object-storage.md diff --git a/docs/hypernode-platform/object-storage.md b/docs/hypernode-platform/object-storage.md new file mode 100644 index 00000000..c18e8a3b --- /dev/null +++ b/docs/hypernode-platform/object-storage.md @@ -0,0 +1,20 @@ +--- +myst: + html_meta: + description: This table of contents gives you a summary of all Hypernode platform + knowledge base articles that include information about Object Storage. + title: Object Storage | Hypernode platform +redirect_from: + - /en/hypernode/object-storage/ +--- + +# Object Storage + +```{toctree} +--- +caption: Table of Contents +maxdepth: 1 +glob: +--- +object-storage/* +``` diff --git a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md new file mode 100644 index 00000000..4d992f39 --- /dev/null +++ b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md @@ -0,0 +1,18 @@ +--- +myst: + html_meta: + description: Getting started with Object Storage + title: Hypernode Object Storage | Getting Started +redirect_from: + - /en/hypernode/object-storage/getting-started-with-object-storage/ +--- + + +# What is Hypernode Object Storage? + + +# How does Object Storage work? + + +# How to enable Object Storage and use it with your Hypernode? + From 2a3b5b6e7cb3d7ba00f758016052722ccffffde2 Mon Sep 17 00:00:00 2001 From: Hritik Kothari Date: Fri, 7 Feb 2025 14:44:14 +0100 Subject: [PATCH 2/8] mdformat --- .../object-storage/getting-started-with-object-storage.md | 4 ---- .../tools/how-to-use-the-hypernode-systemctl-cli-tool.md | 0 2 files changed, 4 deletions(-) mode change 100755 => 100644 docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md diff --git a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md index 4d992f39..6f4a87a8 100644 --- a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md +++ b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md @@ -7,12 +7,8 @@ redirect_from: - /en/hypernode/object-storage/getting-started-with-object-storage/ --- - # What is Hypernode Object Storage? - # How does Object Storage work? - # How to enable Object Storage and use it with your Hypernode? - diff --git a/docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md b/docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md old mode 100755 new mode 100644 From f4624a07a286288d3e8067a527c0a494351a1be2 Mon Sep 17 00:00:00 2001 From: Hritik Kothari Date: Tue, 11 Feb 2025 14:34:43 +0100 Subject: [PATCH 3/8] update doc --- .../getting-started-with-object-storage.md | 55 ++++++++++++++++++- 1 file changed, 54 insertions(+), 1 deletion(-) diff --git a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md index 6f4a87a8..ce64026d 100644 --- a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md +++ b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md @@ -9,6 +9,59 @@ redirect_from: # What is Hypernode Object Storage? -# How does Object Storage work? +Hypernode Object Storage provides an option to store media files in a persistent, remote storage container. + +By default, media files are stored in the same filesystem that contains the application. This is inefficient for complex, multi-server configurations, and can result in degraded performance when sharing resources. + +Object storage eliminates redundancy and provides a centralized, scalable solution for storing application assets, session data, and backups. + +With Object Storage you get - + +- Effortless Data Sharing – Seamless access across all Hypernodes +- Full Access Control & Security – Secure and manage your data with ease +- Safe Backup & Monitoring – Ensure reliability with built-in insights # How to enable Object Storage and use it with your Hypernode? + +## CLI option + +``` +hypernode-object-storage --help +``` + +#### Creating a Hypernode Object Storage Workspace + +1. SSH into your server. +1. Run `hypernode-object-storage create` +1. Fill in the prompts with a name and desired storage. +1. Confirm your order and give it a few minutes before your storage is ready. + +Note: You can use one object storage across multiple Hypernodes. But you can only use one object storage space per Hypernode. + +If you receive this error, please make sure to enable "Allow billing through CLI in the relevant Hypernode settings page" + +``` +You do not have permission to order object storage for this Hypernode. Please ask the Hypernode owner to enable 'Allow billing through the CLI' in the Control Panel settings or via the API +``` + +#### Retrieve object storage + +1. Run `hypernode-object-storage info` +1. If you want to retrieve your credentials for the workspace pass in the flag `--with-credentials`. + +The output should look like this + +``` +root@levkxf-hntesthehe-magweb-cmbl ~ # hypernode-object-storage info ++--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ +| UUID | Name | Plan | Hypernodes | Management URL | Access Key | Secret Key | ++--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ +| fdb95093-6e5e-4cf7-a128-26e376ffb77b | hntesthehe14 | OS50GB | hntesthehe | **sensitive** | **sensitive** | **sensitive** | ++--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ +``` + +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). + +## UI option - Control Panel + +TBD From 4463677c4b80a495ab5427c68005d06f124e7e13 Mon Sep 17 00:00:00 2001 From: Hritik Kothari Date: Tue, 11 Feb 2025 15:00:46 +0100 Subject: [PATCH 4/8] fix warning --- .../object-storage/getting-started-with-object-storage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md index ce64026d..d9c6257b 100644 --- a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md +++ b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md @@ -29,7 +29,7 @@ With Object Storage you get - hypernode-object-storage --help ``` -#### Creating a Hypernode Object Storage Workspace +### Creating a Hypernode Object Storage Workspace 1. SSH into your server. 1. Run `hypernode-object-storage create` @@ -44,7 +44,7 @@ If you receive this error, please make sure to enable "Allow billing through CLI You do not have permission to order object storage for this Hypernode. Please ask the Hypernode owner to enable 'Allow billing through the CLI' in the Control Panel settings or via the API ``` -#### Retrieve object storage +### Retrieve object storage 1. Run `hypernode-object-storage info` 1. If you want to retrieve your credentials for the workspace pass in the flag `--with-credentials`. From 1eb2e5adf2ff0103546ede852a82cc44c551ff31 Mon Sep 17 00:00:00 2001 From: Hritik Kothari Date: Thu, 13 Feb 2025 14:41:35 +0100 Subject: [PATCH 5/8] review comments --- .../object-storage/getting-started-with-object-storage.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md index d9c6257b..6cfca5f6 100644 --- a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md +++ b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md @@ -15,7 +15,7 @@ By default, media files are stored in the same filesystem that contains the appl Object storage eliminates redundancy and provides a centralized, scalable solution for storing application assets, session data, and backups. -With Object Storage you get - +With Object Storage you get: - Effortless Data Sharing – Seamless access across all Hypernodes - Full Access Control & Security – Secure and manage your data with ease @@ -52,7 +52,8 @@ You do not have permission to order object storage for this Hypernode. Please as The output should look like this ``` -root@levkxf-hntesthehe-magweb-cmbl ~ # hypernode-object-storage info +app@hntesthehe ~ # hypernode-object-storage info + +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ | UUID | Name | Plan | Hypernodes | Management URL | Access Key | Secret Key | +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ From b85d96514ab27ef9bba18f3dc106e98065e78d2c Mon Sep 17 00:00:00 2001 From: Hritik Kothari Date: Thu, 13 Feb 2025 14:48:25 +0100 Subject: [PATCH 6/8] tiny changes --- .../object-storage/getting-started-with-object-storage.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md index 6cfca5f6..0ed2b9d8 100644 --- a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md +++ b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md @@ -21,11 +21,11 @@ With Object Storage you get: - Full Access Control & Security – Secure and manage your data with ease - Safe Backup & Monitoring – Ensure reliability with built-in insights -# How to enable Object Storage and use it with your Hypernode? +# Getting started with Object Storage ## CLI option -``` +```console hypernode-object-storage --help ``` @@ -52,12 +52,12 @@ You do not have permission to order object storage for this Hypernode. Please as The output should look like this ``` -app@hntesthehe ~ # hypernode-object-storage info +app@testhypernode ~ # hypernode-object-storage info +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ | UUID | Name | Plan | Hypernodes | Management URL | Access Key | Secret Key | +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ -| fdb95093-6e5e-4cf7-a128-26e376ffb77b | hntesthehe14 | OS50GB | hntesthehe | **sensitive** | **sensitive** | **sensitive** | +| d8770125-6c90-4770-b00f-1716f699990a | test-storage | OS50GB | hntesthehe | **sensitive** | **sensitive** | **sensitive** | +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ ``` From f8d910f2d18bb0c3feed0210185f254412ee5f72 Mon Sep 17 00:00:00 2001 From: Hritik Kothari Date: Thu, 13 Feb 2025 14:49:14 +0100 Subject: [PATCH 7/8] update hypernode name --- .../object-storage/getting-started-with-object-storage.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md index 0ed2b9d8..5b3706c6 100644 --- a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md +++ b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md @@ -51,13 +51,13 @@ You do not have permission to order object storage for this Hypernode. Please as The output should look like this -``` +```console app@testhypernode ~ # hypernode-object-storage info +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ | UUID | Name | Plan | Hypernodes | Management URL | Access Key | Secret Key | +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ -| d8770125-6c90-4770-b00f-1716f699990a | test-storage | OS50GB | hntesthehe | **sensitive** | **sensitive** | **sensitive** | +| d8770125-6c90-4770-b00f-1716f699990a | test-storage | OS50GB | testnode12 | **sensitive** | **sensitive** | **sensitive** | +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ ``` From 606b95a49c3979bd7cb197b8e05c5a17ae18ea4b Mon Sep 17 00:00:00 2001 From: Hritik Kothari Date: Thu, 13 Feb 2025 15:00:19 +0100 Subject: [PATCH 8/8] update description and put 'comin soon' --- .../object-storage/getting-started-with-object-storage.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md index 5b3706c6..77f27b1d 100644 --- a/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md +++ b/docs/hypernode-platform/object-storage/getting-started-with-object-storage.md @@ -9,12 +9,12 @@ redirect_from: # What is Hypernode Object Storage? -Hypernode Object Storage provides an option to store media files in a persistent, remote storage container. - -By default, media files are stored in the same filesystem that contains the application. This is inefficient for complex, multi-server configurations, and can result in degraded performance when sharing resources. +Hypernode Object Storage provides an option to store media files, assets, backups, documents, etc in a persistent, remote storage container. Object storage eliminates redundancy and provides a centralized, scalable solution for storing application assets, session data, and backups. +By default, media files are stored in the same filesystem that contains the application. This is inefficient for complex, multi-server configurations, and can result in degraded performance when sharing resources. + With Object Storage you get: - Effortless Data Sharing – Seamless access across all Hypernodes @@ -65,4 +65,4 @@ You can use the credentials and the URL now to configure remote storage for your ## UI option - Control Panel -TBD +Coming soon