You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ki...@apache.org on 2023/08/08 06:30:17 UTC

[cloudstack-documentation] 01/01: Documentation for Object Storage feature

This is an automated email from the ASF dual-hosted git repository.

kishan pushed a commit to branch objectstore
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git

commit 9ede33056fd8ab05a8ff49753734562b367ba4c5
Author: Kishan Kavala <ki...@apache.org>
AuthorDate: Tue Aug 8 11:52:31 2023 +0530

    Documentation for Object Storage feature
---
 source/adminguide/storage.rst              | 29 ++++++++++++++++++++++++++
 source/conceptsandterminology/concepts.rst |  7 +++++++
 source/installguide/configuration.rst      | 33 ++++++++++++++++++++++++++++++
 3 files changed, 69 insertions(+)

diff --git a/source/adminguide/storage.rst b/source/adminguide/storage.rst
index bee232e..826ae4b 100644
--- a/source/adminguide/storage.rst
+++ b/source/adminguide/storage.rst
@@ -958,6 +958,35 @@ 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 etc.
+
+
 
 .. |AttachDiskButton.png| image:: /_static/images/attach-disk-icon.png
    :alt: Attach Disk Button.
diff --git a/source/conceptsandterminology/concepts.rst b/source/conceptsandterminology/concepts.rst
index d938b91..c18d78c 100644
--- a/source/conceptsandterminology/concepts.rst
+++ b/source/conceptsandterminology/concepts.rst
@@ -503,6 +503,13 @@ cloud.
    you cannot set up multiple zones, one using NFS secondary and the other 
    using S3 or Swift secondary.
 
+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 049fe74..dc98fe5 100644
--- a/source/installguide/configuration.rst
+++ b/source/installguide/configuration.rst
@@ -1583,6 +1583,39 @@ zone:
 
    -  Path. The path to the zone's Secondary Staging Store.
 
+Adding Object Storage
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can add  storage object pools at any time to add more capacity or providers to CloudStack
+
+
+
+#. Make sure you have installed supported Object Storage provider and 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
+
 
 .. _initialize-and-test: