Skip to content

Commit 0ea4ca4

Browse files
committed
remote_storage: General improvements
- Better markdown semantics - More information on Magento 2.x - More coherency between object storage and application articles - Better consistency for console examples - Other minor tweaks
1 parent 7d7bc25 commit 0ea4ca4

File tree

5 files changed

+39
-19
lines changed

5 files changed

+39
-19
lines changed

docs/ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ This can be useful for many reasons, such as:
2222

2323
Configuring Magento 2 to start storing files in your bucket is done using a single command.
2424

25+
Before configuring remote storage, make sure that the deprecated database media storage backend is disabled.
26+
27+
```bash
28+
bin/magento setup:config:set system/media_storage_configuration/media_storage 0
29+
```
30+
2531
**Hypernode Object Storage and other S3 compatible providers**
2632

2733
If you're using Hypernode Object Storage or a different provider than AWS S3, you need to specify the `--remote-storage-endpoint` option.
@@ -39,7 +45,7 @@ bin/magento setup:config:set \
3945
For Hypernode Object Storage, use `main` as the bucket name and `EU` as the region. You can retrieve the remaining parameters by running `hypernode-object-storage info --with-credentials`.
4046

4147
```console
42-
app@testapp ~ # hypernode-object-storage info --with-credentials
48+
app@abcdef-example-magweb-cml:~$ hypernode-object-storage info --with-credentials
4349
+--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+
4450
| UUID | Name | Plan | Hypernodes | Management URL | Access Key | Secret Key |
4551
+--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+
@@ -93,6 +99,10 @@ aws s3 sync var/import_export s3://my_bucket_name/import_export
9399

94100
Both methods are significantly faster than Magento’s built-in sync, as aws s3 sync handles uploads concurrently.
95101

102+
```{tip}
103+
More information about the `hypernode-object-storage` command can be found in the [Object Storage article](../../hypernode-platform/object-storage/getting-started-with-object-storage.md).
104+
```
105+
96106
## The storage flag file in the bucket
97107

98108
Magento's S3 implementation creates a test file called `storage.flag`, which is basically created to test if the connection works. So this is not a magic file to mark anything ([source](https://github.com/magento/magento2/blob/6f4805f82bb7511f72935daa493d48ebda3d9039/app/code/Magento/AwsS3/Driver/AwsS3.php#L104)).
@@ -121,6 +131,12 @@ If you’re using Amazon S3, ensure that your S3 bucket policies are properly co
121131
}
122132
```
123133

134+
## Remote storage tweaks module
135+
136+
After configuring remote storage for Magento 2, you might run into some slower pages in the admin product grid. This is caused by an inefficient image loading mechanism found in the Magento core code. For now we have written a Magento 2 module to fix this performance problem.
137+
138+
You can find the module on [GitHub](https://github.com/ByteInternet/magento2-remote-storage-tweaks/) and [Packagist](https://packagist.org/packages/hypernode/magento2-remote-storage-tweaks).
139+
124140
## Magento remote storage documentation
125141

126142
- [Configure Remote Storage](https://experienceleague.adobe.com/en/docs/commerce-operations/configuration-guide/storage/remote-storage/remote-storage)

docs/ecommerce-applications/shopware-6/how-to-configure-remote-storage-for-shopware-6-x.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ shopware:
4343
You can get the required management URL, access key, and secret key by running `hypernode-object-storage info` with the `--with-credentials` flag:
4444

4545
```console
46-
app@testapp ~ # hypernode-object-storage info --with-credentials
46+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage info --with-credentials
4747
+--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+
4848
| UUID | Name | Plan | Hypernodes | Management URL | Access Key | Secret Key |
4949
+--------------------------------------+----------------+---------+-------------+-------------------------------------+---------------+---------------+
@@ -95,6 +95,10 @@ Alternatively, you can use the AWS CLI directly:
9595
aws s3 sync public/media/ s3://bucket_name/media/
9696
```
9797

98+
```{tip}
99+
More information about the `hypernode-object-storage` command can be found in the [Object Storage article](../../hypernode-platform/object-storage/getting-started-with-object-storage.md).
100+
```
101+
98102
## Serving assets from your S3 bucket
99103

100104
To serve media assets directly from your S3 bucket, you need to adjust your nginx configuration.

docs/hypernode-platform/autoscaling/how-to-enable-horizontal-autoscaling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The upgrade is effective as long the extra resources are needed and being used.
3232
1. Toggle Horizontal autoscaling. This will enable the form to choose the thresholds and the applications you would like to autoscale with. You can choose the certain conditions when autoscaling should be initiated. By default we recommend when the load on the server is higher than 70 for more than 15 minutes
3333
Note: You can also choose the specific time window in which autoscaling should be initiated, if you prefer not to autoscale 24/7. ( E.g. if you have a cron running at 4am that will increase the load on the server but you dont want that to trigger autoscaling, you can choose the autoscaling window to be 5AM-3AM. This will avoid autoscaling between 3AM-5AM)
3434
![Autoscaling toggled](_res/autoscaling-toggled.png)
35-
1. Now click on applications to check if your Hypernode and all the applications on that Hypernode are eligibile for horizontal autoscaling. We have a list of requirements that your Hypernode and it's applications must meet for you to be able to enable horizontal autoscaling. You can see the list [here](https://www.hypernode.com/).
35+
1. Now click on applications to check if your Hypernode and all the applications on that Hypernode are eligibile for horizontal autoscaling. We have a list of requirements that your Hypernode and it's applications must meet for you to be able to enable horizontal autoscaling. You can see the list [here](how-does-horizontal-autoscaling-work.md).
3636
![Autoscaling eligibility checks](_res/autoscaling-eligchecks.png)
3737
1. If an application is not supported, you can either unselect that application so that its not a part of horizontal autoscaling. Or you can update your application as required to make it eligible and re-run the checks.
3838
1. After you have decided the thresholds and choosen the eligible applications, you can now click save changes at the top right corner. This will enable horizontal autoscaling, charge you for the autoscaling license and now your Hypernode will be monitored 24/7 against the conditions you have set.

docs/hypernode-platform/nginx/basic-authentication-on-hypernode-development-plans.md

100755100644
File mode changed.

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ With Object Storage you get:
2525

2626
## CLI option
2727

28-
```console
28+
You can run the CLI command with the `--help` command to find out about all the options and arguments.
29+
30+
```bash
2931
hypernode-object-storage --help
3032
```
3133

@@ -38,45 +40,43 @@ hypernode-object-storage --help
3840

3941
Note: You can use one object storage across multiple Hypernodes. But you can only use one object storage space per Hypernode.
4042

41-
If you receive this error, please make sure to enable "Allow billing through CLI in the relevant Hypernode settings page"
42-
43-
```
44-
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
45-
```
46-
4743
### Retrieve object storage
4844

4945
1. Run `hypernode-object-storage info`
5046
1. If you want to retrieve your credentials for the workspace pass in the flag `--with-credentials`.
5147

52-
The output should look like this
48+
The output should look like the following:
5349

5450
```console
55-
app@testhypernode ~ # hypernode-object-storage info
56-
51+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage info
5752
+--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+
5853
| UUID | Name | Plan | Hypernodes | Management URL | Access Key | Secret Key |
5954
+--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+
6055
| d8770125-6c90-4770-b00f-1716f699990a | test-storage | OS50GB | testnode12 | **sensitive** | **sensitive** | **sensitive** |
6156
+--------------------------------------+--------------+--------+------------+----------------+---------------+---------------+
6257
```
6358

64-
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).
59+
You can use the credentials and the URL now to configure remote storage for your application with the help of the following articles:
60+
61+
1. [How to configure remote storage for Magento 2.x](../../ecommerce-applications/magento-2/how-to-configure-remote-storage-for-magento-2-x.md)
62+
1. [How to configure remote storage for Shopware 6.x](../../ecommerce-applications/shopware-6/how-to-configure-remote-storage-for-shopware-6-x.md)
6563

6664
### Cancel/Delete Object Storage
6765

6866
To cancel an Object Storage, you can ssh into the Hypernode that is linked to that Object Storage and run `hypernode-object-storage cancel`
6967

70-
Note: The cancellation will be in effect from the end of the month.
68+
```{note}
69+
The cancellation will be in effect from the end of the month.
7170
Also if you change your mind or forgot to pull some data. It will still be available for 7 days after the cancellation. You can always reach out to the support team for help if that happens.
71+
```
7272

7373
### Managing objects in object storage
7474

7575
You can manage your objects using the `hypernode-object-storage objects` subcommand.
7676
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.
7777

7878
```console
79-
app@testhypernode ~ # hypernode-object-storage objects --help
79+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage objects --help
8080
usage: hypernode-object-storage objects [-h] {sync,cp,ls,mv,rm,show} ...
8181

8282
Manage objects in object storage
@@ -101,22 +101,22 @@ It is important to note that `hypernode-object-storage objects` supports all opt
101101
Syncing files between your local directory and object storage is simple. Run the following command:
102102

103103
```console
104-
app@testhypernode ~ # hypernode-object-storage objects sync /example/local/path/ s3://example/bucket/uri/
104+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage objects sync /example/local/path/ s3://example/bucket/uri/
105105
Syncing objects from /example/local/path/ to s3://example/bucket/uri/...
106106
Sync process started with PID 1234 in the background.
107107
```
108108

109109
The `sync` operation runs in the background, and you can monitor its progress by using the `show` command, for example:
110110

111111
```console
112-
app@testhypernode ~ # hypernode-object-storage objects show 1234
112+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage objects show 1234
113113
Completed 9.7 GiB/~30.0 GiB (118.2 MiB/s) with ~5 file(s) remaining (calculating...)
114114
```
115115

116116
If you run the `show` command after the sync operation has finished, you’ll see output like this:
117117

118118
```console
119-
app@testhypernode ~ # hypernode-object-storage objects show 1234
119+
app@abcdef-example-magweb-cmbl:~$ hypernode-object-storage objects show 1234
120120
Process 1234 does not exist anymore
121121
```
122122

0 commit comments

Comments
 (0)