-
Notifications
You must be signed in to change notification settings - Fork 36
Add object storage docs #334
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
Merged
Merged
Changes from 5 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
cf22bbe
Add object storage docs
hrithikkothari1234 2a3b5b6
mdformat
hrithikkothari1234 f4624a0
update doc
hrithikkothari1234 5816842
Merge branch 'master' into object-storage-docs
hrithikkothari1234 4463677
fix warning
hrithikkothari1234 1eb2e5a
review comments
hrithikkothari1234 b85d965
tiny changes
hrithikkothari1234 f8d910f
update hypernode name
hrithikkothari1234 606b95a
update description and put 'comin soon'
hrithikkothari1234 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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/* | ||
| ``` |
67 changes: 67 additions & 0 deletions
67
docs/hypernode-platform/object-storage/getting-started-with-object-storage.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| 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? | ||
|
|
||
| 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 | ||
hrithikkothari1234 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| +--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+ | ||
| | 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 | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm a bit hesitant of maybe removing this as it doesnt apply for now. What do you think?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wanna keep it so customers know it is coming 😅 |
||
|
|
||
| TBD | ||
Empty file modified
0
docs/hypernode-platform/tools/how-to-use-the-hypernode-systemctl-cli-tool.md
100755 → 100644
Empty file.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.