Skip to content

Commit 281676a

Browse files
authored
Documentation for Object Storage feature (#338)
Added documentation for Object Storage feature, apache/cloudstack#7752
1 parent c0fc875 commit 281676a

File tree

5 files changed

+79
-0
lines changed

5 files changed

+79
-0
lines changed
31.9 KB
Loading
22.8 KB
Loading

source/adminguide/storage.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1070,6 +1070,36 @@ primary storage see :ref:`add-primary-storage`.
10701070
For protocol choose ``Linstor`` and as server specify the controller REST-API URL e.g.: ``http://127.0.0.1:3370``
10711071
and use the resource group name you added in the LINSTOR cluster.
10721072
1073+
Object Storage
1074+
---------------
1075+
1076+
This section gives technical details about CloudStack
1077+
object storage. For more information about the concepts behind object storage
1078+
see :ref:`about-object-storage` . For information about how to install and configure
1079+
object storage through the CloudStack UI, see the in the Installation Guide.
1080+
1081+
1082+
Creating a New Bucket
1083+
~~~~~~~~~~~~~~~~~~~~~
1084+
1085+
Buckets are logical containers for storing objects. To create a New Bucket:
1086+
1087+
#. Log in to the CloudStack UI as a user or administrator.
1088+
1089+
#. In the left navigation bar, click Storage.
1090+
1091+
#. In Select View, choose Buckets.
1092+
1093+
To create a new bucket, click create Bucket, provide the following details, and click OK.
1094+
1095+
#. Name: Give the bucket a unique name.
1096+
1097+
#. Object Store: Select the object store where you want the Bucket to reside
1098+
1099+
Based on the selected Object Store, you can specify additional details like quota, encryption, policy.
1100+
1101+
|Createbucket.png|
1102+
10731103
10741104
.. |AttachDiskButton.png| image:: /_static/images/attach-disk-icon.png
10751105
:alt: Attach Disk Button.
@@ -1089,3 +1119,5 @@ and use the resource group name you added in the LINSTOR cluster.
10891119
:alt: Volume metrics
10901120
.. |volume-from-snap.png| image:: /_static/images/volume-from-snap.png
10911121
:alt: Offering is needed when creating a volume from the ROOT Volume Snapshot.
1122+
.. |Createbucket.png| image:: /_static/images/add-bucket.png
1123+
:alt: Create Bucket

source/conceptsandterminology/concepts.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,15 @@ cloud.
502502
you cannot set up multiple zones, one using NFS secondary and the other
503503
using S3 or Swift secondary.
504504

505+
.. _about-object-storage:
506+
507+
About Object Storage
508+
~~~~~~~~~~~~~~~~~~~~~~~
509+
Object storage (also known as object-based storage) is a data storage that manages data as objects.
510+
CloudStack admin can setup supported Object Storage systems and add them to CloudStack as an Object Storage Pool.
511+
Users can create buckets within the object storage pool.
512+
The basic storage units of Object Store are objects. Any type of data, regardless of content type, is stored as an object.
513+
Buckets are logical containers for storing objects.
505514

506515
About Physical Networks
507516
~~~~~~~~~~~~~~~~~~~~~~~

source/installguide/configuration.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1584,6 +1584,43 @@ zone:
15841584
- Path. The path to the zone's Secondary Staging Store.
15851585

15861586

1587+
Adding Object Storage
1588+
~~~~~~~~~~~~~~~~~~~~~~~~
1589+
1590+
You can add object storage pools at any time to add more capacity or providers to CloudStack
1591+
1592+
1593+
1594+
#. Make sure you have installed supported Object Storage provider and the Object Store is accessible from CloudStack Management Server
1595+
1596+
1597+
#. Log in to the CloudStack UI as root administrator.
1598+
1599+
#. In the left navigation bar, click Infrastructure.
1600+
1601+
#. In Object Storage, click View All.
1602+
1603+
#. Click Add Object Storage.
1604+
1605+
#. Fill in the following fields:
1606+
1607+
- Name. Give the object store a descriptive name.
1608+
1609+
- Provider. Choose provider and then fill in the related
1610+
fields which appear. The fields will vary depending on the object storage
1611+
provider; for more information, consult the provider's
1612+
documentation (such as the MinIO website).
1613+
1614+
- URL: API endpoint of the object storage server
1615+
1616+
- Access key: Credentials with access to admin API of the object storage server
1617+
1618+
- Secret key: Credentials with access to admin API of the object storage server
1619+
1620+
|AddObjectStore.png: Add Object Storage|
1621+
1622+
See https://min.io/docs/minio/linux/index.html for MinIO Documentation
1623+
15871624
.. _initialize-and-test:
15881625

15891626
Initialize and Test
@@ -1785,3 +1822,4 @@ zone denied.routes Routes that
17851822
.. |addcluster.png: add a cluster| image:: /_static/images/add-cluster.png
17861823
.. |add-Host.png: Adding a KVM Host| image:: /_static/images/add-Host.png
17871824
.. |ConsoleButton.png: button to launch a console| image:: /_static/images/console-icon.png
1825+
.. |AddObjectStore.png: Add Object Storage| image:: /_static/images/add-object-store.png

0 commit comments

Comments
 (0)