diff --git a/source/_static/images/add-bucket.png b/source/_static/images/add-bucket.png new file mode 100644 index 0000000000..988a7e48c0 Binary files /dev/null and b/source/_static/images/add-bucket.png differ diff --git a/source/_static/images/add-object-store.png b/source/_static/images/add-object-store.png new file mode 100644 index 0000000000..a0222f7b09 Binary files /dev/null and b/source/_static/images/add-object-store.png differ diff --git a/source/adminguide/storage.rst b/source/adminguide/storage.rst index 84bbe6224d..be12bd9fce 100644 --- a/source/adminguide/storage.rst +++ b/source/adminguide/storage.rst @@ -1070,6 +1070,36 @@ primary storage see :ref:`add-primary-storage`. For protocol choose ``Linstor`` and as server specify the controller REST-API URL e.g.: ``http://127.0.0.1:3370`` and use the resource group name you added in the LINSTOR cluster. +Object Storage +--------------- + +This section gives technical details about CloudStack +object storage. For more information about the concepts behind object storage +see :ref:`about-object-storage` . For information about how to install and configure +object storage through the CloudStack UI, see the in the Installation Guide. + + +Creating a New Bucket +~~~~~~~~~~~~~~~~~~~~~ + +Buckets are logical containers for storing objects. To create a New Bucket: + +#. Log in to the CloudStack UI as a user or administrator. + +#. In the left navigation bar, click Storage. + +#. In Select View, choose Buckets. + +To create a new bucket, click create Bucket, provide the following details, and click OK. + +#. Name: Give the bucket a unique name. + +#. Object Store: Select the object store where you want the Bucket to reside + +Based on the selected Object Store, you can specify additional details like quota, encryption, policy. + +|Createbucket.png| + .. |AttachDiskButton.png| image:: /_static/images/attach-disk-icon.png :alt: Attach Disk Button. @@ -1089,3 +1119,5 @@ and use the resource group name you added in the LINSTOR cluster. :alt: Volume metrics .. |volume-from-snap.png| image:: /_static/images/volume-from-snap.png :alt: Offering is needed when creating a volume from the ROOT Volume Snapshot. +.. |Createbucket.png| image:: /_static/images/add-bucket.png + :alt: Create Bucket diff --git a/source/conceptsandterminology/concepts.rst b/source/conceptsandterminology/concepts.rst index 3babaf9584..467b6b94fa 100644 --- a/source/conceptsandterminology/concepts.rst +++ b/source/conceptsandterminology/concepts.rst @@ -502,6 +502,15 @@ cloud. you cannot set up multiple zones, one using NFS secondary and the other using S3 or Swift secondary. +.. _about-object-storage: + +About Object Storage +~~~~~~~~~~~~~~~~~~~~~~~ +Object storage (also known as object-based storage) is a data storage that manages data as objects. +CloudStack admin can setup supported Object Storage systems and add them to CloudStack as an Object Storage Pool. +Users can create buckets within the object storage pool. +The basic storage units of Object Store are objects. Any type of data, regardless of content type, is stored as an object. +Buckets are logical containers for storing objects. About Physical Networks ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/installguide/configuration.rst b/source/installguide/configuration.rst index 016994cc79..1b23cd127f 100644 --- a/source/installguide/configuration.rst +++ b/source/installguide/configuration.rst @@ -1584,6 +1584,43 @@ zone: - Path. The path to the zone's Secondary Staging Store. +Adding Object Storage +~~~~~~~~~~~~~~~~~~~~~~~~ + +You can add object storage pools at any time to add more capacity or providers to CloudStack + + + +#. Make sure you have installed supported Object Storage provider and the Object Store is accessible from CloudStack Management Server + + +#. Log in to the CloudStack UI as root administrator. + +#. In the left navigation bar, click Infrastructure. + +#. In Object Storage, click View All. + +#. Click Add Object Storage. + +#. Fill in the following fields: + + - Name. Give the object store a descriptive name. + + - Provider. Choose provider and then fill in the related + fields which appear. The fields will vary depending on the object storage + provider; for more information, consult the provider's + documentation (such as the MinIO website). + + - URL: API endpoint of the object storage server + + - Access key: Credentials with access to admin API of the object storage server + + - Secret key: Credentials with access to admin API of the object storage server + + |AddObjectStore.png: Add Object Storage| + +See https://min.io/docs/minio/linux/index.html for MinIO Documentation + .. _initialize-and-test: Initialize and Test @@ -1785,3 +1822,4 @@ zone denied.routes Routes that .. |addcluster.png: add a cluster| image:: /_static/images/add-cluster.png .. |add-Host.png: Adding a KVM Host| image:: /_static/images/add-Host.png .. |ConsoleButton.png: button to launch a console| image:: /_static/images/console-icon.png +.. |AddObjectStore.png: Add Object Storage| image:: /_static/images/add-object-store.png