Skip to content
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.

Sign up for GitHub

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

Alibaba OSS usage docs. #1101

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Alibaba OSS usage docs. #1101

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3a105e9
Add document for alibaba oss backend.
Jan 9, 2022
939b455
Minor docs fixes.
Jan 9, 2022
c2789a3
Merge branch 'jschneier:master' into master
anyidea Mar 5, 2022
68ceaeb
Merge branch 'jschneier:master' into master
anyidea Apr 6, 2022
061dac7
Merge branch 'jschneier:master' into master
anyidea Aug 25, 2022
242cb49
Merge branch 'jschneier:master' into master
anyidea Oct 20, 2023
4653e10
Merge branch 'jschneier:master' into master
anyidea Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/backends/alibaba-oss.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Alibaba OSS
=============

Alibaba Cloud Object Storage Service is compatible with the S3 protocol. To use it follow the instructions in the :doc:`Amazon S3 docs <amazon-S3>` with the important caveats that you must:

- Set ``AWS_S3_ADDRESSING_STYLE`` to ``virtual`` (For security reasons, OSS supports only virtual hosted style access)
- Set ``AWS_S3_REGION_NAME`` to your OSS region (such as ``oss-cn-shanghai`` or ``oss-cn-hangzhou``)
- Set ``AWS_S3_ENDPOINT_URL`` to the value of ``https://${AWS_S3_REGION_NAME}.aliyuncs.com``
- Set the values of ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY`` to the corresponding values from OSS

Notes
*****

Be aware Alibaba OSS are not fully compatible so there are some difference between them.

- See `Use S3 API operations to access OSS after migration`_.
- See `Compatible S3 API operations`_.

.. _Use S3 API operations to access OSS after migration: https://www.alibabacloud.com/help/doc-detail/64919.htm#title-zhf-v8d-71i
.. _Compatible S3 API operations: https://www.alibabacloud.com/help/doc-detail/64919.htm#title-cds-fai-yxp
.. _