[PULP-265] Add docs about STORAGES settings #6158
Conversation
pedro-psb
changed the title
pedro-psb
changed the title
pedro-psb
force-pushed
the
add-storage-docs
branch
from
bf24d89 to
232986a
Compare
pedro-psb
force-pushed
the
add-storage-docs
branch
from
232986a to
b14cc7e
Compare
pedro-psb
force-pushed
the
add-storage-docs
branch
from
b14cc7e to
7b752a3
Compare
|
|
||
| * The [`MEDIA_ROOT`](site:pulpcore/docs/admin/reference/settings/#media_root) setting specifies where Pulp | ||
| will save the files. | ||
| * Pulp customizes Django's default class, `django.core.files.storage.FileSystemStorage`. |
There was a problem hiding this comment.
Does that mean "Don't use the original one!"?
There was a problem hiding this comment.
Yes. Should I add this explicitly?
Pulp customizes Django's default class, `django.core.files.storage.FileSystemStorage`.
Don't use the original one.
| The settings can be updated via the `settings.py` file or through environment variables | ||
| and have support to dynaconf merge features (learn more on the [Settings Introduction](site:pulpcore/docs/admin/guides/configure-pulp/introduction/)). | ||
|
|
||
| To learn where and how to modify the files and envvars, refer to the appropriate installation method documentation: |
There was a problem hiding this comment.
s/envvars/environment variables/
| [Django docs](https://docs.djangoproject.com/en/4.2/ref/files/storage/#django.core.files.storage.FileSystemStorage). | ||
|
|
||
| ### Amazon S3 | ||
|
|
There was a problem hiding this comment.
I'm missing a note that other storage technologies that provide an S3 api will work too.
I'm thinking of Ceph/RADOS and minio here.
There was a problem hiding this comment.
That's useful, will mention that.
docs/admin/reference/settings.md
Outdated
| As an example, an Amazon S3 might look like this: | ||
|
|
||
| ```python | ||
| STORAGES = { | ||
| "default": { | ||
| "BACKEND": "storages.backends.s3.S3Storage", | ||
| "OPTIONS": { | ||
| "access_key": 'AKIAIT2Z5TDYPX3ARJBA', | ||
| "secret_key": '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', | ||
| "bucket_name": 'pulp3', | ||
| "signature_version": "s3v4", | ||
| "addressing_style": "path", | ||
| "region_name": "eu-central-1", | ||
| }, | ||
| }, | ||
| } | ||
| ``` |
There was a problem hiding this comment.
This is a copy from the very location you just linked. I would not do that, as it has the tendency to be outdated and forgotten when the one other place where it rightfully lives gets an update.
(personaly, my general advice: Don't duplicate anything in the docs. Rely on the power of hyperlinks. [we do check for broken links in the docs, right?])
There was a problem hiding this comment.
Fair.
we do check for broken links in the docs, right?
🙈
There was a problem hiding this comment.
I have experimented with a link checker. Will prioritize adding that to CI
pedro-psb
force-pushed
the
add-storage-docs
branch
from
2fa3bdd to
eb3ec55
Compare
pedro-psb
force-pushed
the
add-storage-docs
branch
from
eb3ec55 to
28961f1
Compare
|
Squashed |
Depends on this to make sense: #6058
TODO: