Object Store Quick Start: Difference between revisions

Object Store Quick Start (view source)

Revision as of 20:54, 24 April 2025

1,912 bytes added , Thursday at 20:54

API endpoints and S3 credentials

Vrocheleau

6

edits

@@ Line 7: / Line 7: @@
 == Prerequisites ==
 * Install and configure your [[OpenStack_Client|OpenStack CLI]]
+== API endpoints ==
+{| class="wikitable"
+|+Object Store API Endpoints
+!Object Store API
+!Endpoint
+|-
+|'''Swift'''
+|<code><nowiki>https://objets.juno.calculquebec.ca/swift/v1</nowiki></code>
+|-
+|'''S3'''
+|<code><nowiki>https://objets.juno.calculquebec.ca</nowiki></code>
+|}
+{| class="wikitable"
+|+Project Specific Endpoint Patterns
+!Object Store API
+!Project endpoint pattern
+|-
+|'''Swift'''
+|<code><endpoint>/'''AUTH_<PROJECT ID>/<CONTAINER>/<OBJECT>'''</code>
+|-
+|'''S3'''
+|<code><endpoint>/'''<PROJECT ID>:<CONTAINER>/<OBJECT>'''</code>
+|}
 == Getting credentials for the object store ==
 === The Swift Api ===
-The object store maintains its own set of credentials.
+You can get access to the [https://docs.openstack.org/swift/latest/api/object_api_v1_overview.html Object Store swift Api]  directly with the same RC file credential that you created for the Openstack client in the prerequisites step, and the official [https://pypi.org/project/python-swiftclient/ Openstack Swift client].
-You can get access to the [https://docs.openstack.org/swift/latest/api/object_api_v1_overview.html Object Store swift Api]  directly with the same RC file credential that you created for the Openstack client in the perquisite step, and the official [https://pypi.org/project/python-swiftclient/ Openstack Swift client]. Not that while the S3 Api is more feture rich and has better support, some operation can only be done with the Swift Api which is the native openstack Object Store Api. For example, to get the Quota of you account:
+Note that while the S3 Api is more feature rich and has better support, some operations can only be done with the Swift Api which is the native OpenStack Object Store Api. For example, to get the Quota of you account:
 <syntaxhighlight ,lang="bash">
@@ Line 43: / Line 67: @@
 === The S3 Api ===
+While the Switft API can be accessed with the OpenStack RC file credentials, the S3 object store maintains its own set of credentials.
+To create S3 credentials for a project/user:<syntaxhighlight>
+openstack ec2 credentials create
++------------+--------------------------------------------------------------------------------------------------+
+| Field      | Value                                                                                            |
++------------+--------------------------------------------------------------------------------------------------+
+| access     | <S3 ACCESS KEY>                                                                                  |
+| links      | {'self': 'https://juno.calculquebec.ca:5000/v3/users/<USER ID>/credentials/OS-EC2/<ACCESS KEY>'} |
+| project_id | <OPENSTACK PROJECT ID>                                                                           |
+| secret     | <S3 SECRET KEY>                                                                                  |
+| trust_id   | None                                                                                             |
+| user_id    | <USER ID>                                                                                        |
++------------+--------------------------------------------------------------------------------------------------+
+</syntaxhighlight>Usage details coming soon!
 ==What an Object Store is and isn't==