Skip to content

Commit 2fa3bdd

Browse files
committed
fixup: review iteration
1 parent 7b752a3 commit 2fa3bdd

File tree

2 files changed

+29
-26
lines changed

2 files changed

+29
-26
lines changed

docs/admin/guides/configure-pulp/configure-storages.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ See the reference for the [`STORAGES` settings](site:pulpcore/docs/admin/referen
88
The settings can be updated via the `settings.py` file or through environment variables
99
and have support to dynaconf merge features (learn more on the [Settings Introduction](site:pulpcore/docs/admin/guides/configure-pulp/introduction/)).
1010

11-
To learn where and how to modify the files and envvars, refer to the appropriate installation method documentation:
11+
To learn where and how to modify the files and environment variables, refer to the appropriate installation method documentation:
1212

1313
* [Container (single-process) quickstart](site:pulp-oci-images/docs/admin/tutorials/quickstart/#single-container)
1414
* [Container (multi-process) quickstart](site:pulp-oci-images/docs/admin/tutorials/quickstart/#podman-or-docker-compose)
@@ -37,7 +37,7 @@ Notes:
3737

3838
* The [`MEDIA_ROOT`](site:pulpcore/docs/admin/reference/settings/#media_root) setting specifies where Pulp
3939
will save the files.
40-
* Pulp customizes Django's default class, `django.core.files.storage.FileSystemStorage`.
40+
* Pulp customizes Django's default class, `django.core.files.storage.FileSystemStorage`. The original can't be used.
4141
* There are some other related global definitions provided by django:
4242
* `MEDIA_URL`
4343
* `FILE_UPLOAD_PERMISSIONS`
@@ -46,9 +46,9 @@ will save the files.
4646
Comprehensive options for Local Filesystem can be found in
4747
[Django docs](https://docs.djangoproject.com/en/4.2/ref/files/storage/#django.core.files.storage.FileSystemStorage).
4848

49-
### Amazon S3
49+
## Amazon S3
5050

51-
#### Setup
51+
### Setup
5252

5353
Before you can configure Amazon S3 storage to use with Pulp, ensure that you complete the following steps
5454
(consult the official Amazon S3 docs for precise steps).
@@ -58,7 +58,7 @@ Before you can configure Amazon S3 storage to use with Pulp, ensure that you com
5858
3. In AWS Identity and Access Management (IAM), create a user that Pulp can use to access your S3 bucket.
5959
4. Save the access key id and secret access key.
6060

61-
#### Example
61+
### Example
6262

6363
In this example, the storage uses a bucket called `pulp3` that is hosted in region `eu-central-1`:
6464

@@ -89,9 +89,16 @@ Notes:
8989
Comprehensive options for Amazon S3 can be found in
9090
[`django-storages` docs](https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html#configuration-settings).
9191

92-
### Azure Blob storage
92+
## S3 Compatible
93+
94+
The same `storages.backends.s3.S3Storage` backend can be used for S3 Compatible API services, such [Minio](https://min.io/), [Ceph/RADOS](https://docs.ceph.com/en/reef/man/8/rados/) and [Backblaze B2](https://www.backblaze.com/cloud-storage).
95+
96+
The [django-storages](https://django-storages.readthedocs.io/en/latest/backends/s3_compatible/index.html) documentation
97+
provides a reference for setting up some of these services.
9398

94-
#### Setup
99+
## Azure Blob storage
100+
101+
### Setup
95102

96103
Before you can configure Azure Blob storage to use with Pulp, ensure that you complete the following steps
97104
(consult the official Azure documentation for precise steps).
@@ -101,7 +108,7 @@ Before you can configure Azure Blob storage to use with Pulp, ensure that you co
101108
3. Obtain the access credentials so that you can later configure Pulp to access your Azure Blob storage. You can find the access credentials
102109
at the storage account level, at Access keys (these are automatically generated).
103110

104-
#### Example
111+
### Example
105112

106113
In this example, the storage uses a container called `pulp3` with the `pulp-account` username.
107114

docs/admin/reference/settings.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -87,34 +87,30 @@ instructions on how to configure the database, refer to `database installation <
8787
Pulp uses [django-storages](https://django-storages.readthedocs.io/en/latest/index.html) to support multiple storage backends.
8888
If no backend is configured, Pulp will by default use the local filesystem (`pulpcore.app.models.storage.FileSystem`).
8989

90-
To use another backend storage, you'll need to:
91-
92-
1. Setup your storage and gather required credentials and specific configs.
93-
2. Ensure the `django-storage[s3|google|azure]` python package is installed. This depends on the installation method.
94-
3. Configure the default `BACKEND` storage class.
95-
4. Configure available `OPTIONS` for that backend.
96-
97-
Learn more on the
98-
[Configure Storages](site:pulpcore/docs/admin/guides/configure-pulp/configure-storages/) guide.
99-
100-
As an example, an Amazon S3 might look like this:
90+
The storage setting has the form:
10191

10292
```python
10393
STORAGES = {
10494
"default": {
105-
"BACKEND": "storages.backends.s3.S3Storage",
95+
"BACKEND": "{storage-class}",
10696
"OPTIONS": {
107-
"access_key": 'AKIAIT2Z5TDYPX3ARJBA',
108-
"secret_key": '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',
109-
"bucket_name": 'pulp3',
110-
"signature_version": "s3v4",
111-
"addressing_style": "path",
112-
"region_name": "eu-central-1",
97+
"{option-key}": "{option-value}",
98+
...
11399
},
114100
},
115101
}
116102
```
117103

104+
To use another backend storage, you'll need to:
105+
106+
1. Setup your storage and gather required credentials and specific configs.
107+
2. Ensure the `django-storage[s3|google|azure]` python package is installed. This depends on the installation method.
108+
3. Configure the default `BACKEND` storage class.
109+
4. Configure available `OPTIONS` for that backend.
110+
111+
Learn more on the
112+
[Configure Storages](site:pulpcore/docs/admin/guides/configure-pulp/configure-storages/) guide.
113+
118114
Overview of the integration with Pulp:
119115

120116
- **Supported**: We support (test) Amazon S3 and Azure.

0 commit comments

Comments
 (0)