Merge pull request #30 from lbrick/KAHU-Include_object_storage_user_g…

…uides

Object Storage User guides

docs/user-guides/create-and-manage-object-storage/create-and-manage-object-storage-via-cli.md

@@ -0,0 +1,134 @@
+---
+hidden: false
+label_names:
+- object storage
+- create
+- manage
+- cli
+position: 1
+title: Create and manage object storage via CLI
+---
+
+!!! note
+    The openstack CLI will need to be setup to interact with the FlexiHPC system. Please read [Setting up your CLI environment](../setting-up-your-CLI-environment/index.md) to interact with FlexiHPC to get started.
+
+## Create new container
+
+Running the below command will generate a new container within the projects object storage
+
+``` { .sh }
+openstack container create <CONTAINER_NAME>
+```
+
+You will get a response from the server that looks like the following
+
+
+``` { .sh .no-copy }
++-------------+------------------+-----------------------------+
+| account     | container        | x-trans-id                  |
++-------------+------------------+-----------------------------+
+| AUTH_<GUID> | <CONTAINER_NAME> | tx00000<X_TRANS_GUID>-akl-1 |
++-------------+------------------+-----------------------------+
+```
+
+## List containers
+
+Running the below command will list all containers within the projects object storage
+
+``` { .sh }
+openstack container list
+```
+``` { .sh .no-copy }
++------------------+
+| Name             |
++------------------+
+| a-test-container |
+| boto3-test       |
+| cli-container    |
+| terraform-state  |
++------------------+
+```
+
+The command `openstack container list` also has some additional parameters
+
+`--prefix <prefix>`
+:   Filter the list using a prefix, example if we use the prefix `a` then the only container returned would the `a-test-container`
+
+`--marker <marker>`
+:   Start anchor for paging is used when you wish to return a specified list of containers should you have a lot of them
+
+`--end-marker <end-marker>`
+:   End anchor for paging
+
+`--limit <num-containers>`
+:   Limit the number of containers returned
+
+`--long`
+:   List additional fields in output that contain the amount of space used and number of files inside the container
+
+`--all`
+:   List all containers (default is 10000)
+
+## Display container details
+
+Running the below command will display additional details about the container specified
+
+``` { .sh }
+openstack container show CONTAINER_NAME
+```
+``` { .sh .no-copy }
++----------------+---------------------------------------+
+| Field          | Value                                 |
++----------------+---------------------------------------+
+| account        | AUTH_<AUTH_TOKEN>                     |
+| bytes_used     | 0                                     |
+| container      | <CONTAINER_NAME>                      |
+| object_count   | 0                                     |
+| storage_policy | default-placement                     |
++----------------+---------------------------------------+
+```
+
+## Save container contents local
+
+Running the below command will save all the container contents to your local directory where you run the command
+
+``` { .sh }
+openstack container save CONTAINER_NAME
+```
+
+## Delete container
+
+Run the `openstack container list` command first to get the name of the container you wish to delete
+
+``` { .sh }
+openstack container list
+```
+``` { .sh .no-copy }
++------------------+
+| Name             |
++------------------+
+| a-test-container |
+| boto3-test       |
+| cli-container    |
+| terraform-state  |
++------------------+
+```
+
+Then run the below command to delete the container you wish to remove
+
+``` { .sh }
+openstack container delete CONTAINER_NAME
+```
+
+Your container should then be removed, however should you container contain any files you will get the following error
+
+``` { .sh .no-copy}
+openstack container delete a-test-container
+Conflict (HTTP 409) (Request-ID: tx00000a9dff65235cbe523-0064dadec9-a09387f-akl-1)
+```
+
+Supplying the `--recursive, -r` parameter will delete all files within that container before deleting it
+
+``` { .sh }
+openstack container delete --recursive <CONTAINER_NAME>
+```

docs/user-guides/create-and-manage-object-storage/create-and-manage-object-storage-with-the-dashboard.md

@@ -0,0 +1,129 @@
+---
+hidden: false
+label_names:
+- object storage
+- create
+- manage
+- dashboard
+position: 1
+title: Create and manage object storage via the dashboard
+---
+
+## Creating an object storage container
+
+Log into the [NeSI FlexiHPC Dashboard](https://dashboard.cloud.nesi.org.nz/)
+
+Select the project you would like to deploy the new instance too (Use the project selector on the top left-hand side):
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/project-selector.png)
+</figure>
+
+Open the `Project` tab, open the `Object Storage` tab and select the `Containers` category
+
+Click `+ Container`.
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/object-storage-overview.png)
+</figure>
+
+Within the `Create Container` dialog you have a few options
+
+`Container Name`
+:   A friendly name for your container. It must not contain “/” in its name.
+
+`Storage Policy`
+:   This defaults to default-placement and is the only option available at this time.
+
+`Container Access`
+:   You have a choice between `public` or `not-public`
+
+    A `Public` container will allow anyone with the public URL to gain access to your objects in the container
+
+Once you have given the container a name and decided if its public or private click `Submit` to create the container.
+
+## Deleting an object storage container
+
+!!! note
+    You are not able to delete a container if there are items present within it. Please delete all items before attempting to delete the container.
+
+Log into the [NeSI FlexiHPC Dashboard](https://dashboard.cloud.nesi.org.nz/)
+
+Select the project you would like to deploy the new instance too (Use the project selector on the top left-hand side):
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/project-selector.png)
+</figure>
+
+Open the `Project` tab, open the `Object Storage` tab and select the `Containers` category
+
+Select the container you would like to delete and it should highlight with blue
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/object-storage-container-overview.png)
+</figure>
+
+Hovering over the `Trashcan Icon` should show a tooltip that says *Delete Container* and clicking it should present a `Confirm Delete` dialog.
+
+If you are certain that you wish to delete the container click `Delete` and the container should be removed
+
+## Upload a file to a storage object container
+
+!!! note
+    Files uploaded into a FlexiHPC storage via the dashboard are saved as a binary/octet-stream which means they are only downloaded when they are requested via the URL.
+
+    There is also an issue where the public URL provided via the dashboard doesn't auth correctly so you are unable to view/download files. 
+
+    The URL that currently works should you wish to view/download a file from object storage looks like the following https://object.akl-1.cloud.nesi.org.nz/*CONTAINER_NAME*/*FILE_NAME*
+
+Log into the [NeSI FlexiHPC Dashboard](https://dashboard.cloud.nesi.org.nz/)
+
+Select the project you would like to deploy the new instance too (Use the project selector on the top left-hand side):
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/project-selector.png)
+</figure>
+
+Open the `Project` tab, open the `Object Storage` tab and select the `Containers` category
+
+Select the container you would like to delete and it should highlight with blue
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/object-storage-container-overview.png)
+</figure>
+
+On the far right there should be 3 icons, `Upload File` `+ Folder` and `Delete Item`
+
+Click the `Upload File` icon and within the `Upload File` dialog clicking `Choose File` should allow you to browse to the file on your local machine. You are also able to give it a different name should you so choose.
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/object-storage-upload-dialog.png)
+</figure>
+
+Clicking `Upload File` will now begin to upload that file to the object storage container. The time it takes to complete the upload will depend on the file size and the network upload speed.
+
+## Create a folder like structure in an object storage container
+
+We say folder like structure as that is what it looks like from the dashboards perspective, however under lying this the structure is flat.
+
+Log into the [NeSI FlexiHPC Dashboard](https://dashboard.cloud.nesi.org.nz/)
+
+Select the project you would like to deploy the new instance too (Use the project selector on the top left-hand side):
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/project-selector.png)
+</figure>
+
+Open the `Project` tab, open the `Object Storage` tab and select the `Containers` category
+
+Select the container you would like to delete and it should highlight with blue
+
+<figure markdown>
+  ![Alt text](../../assets/images/flexi/object-storage-container-overview.png)
+</figure>
+
+On the far right there should be 3 icons, `Upload File` `+ Folder` and `Delete Item`
+
+Clicking `+ Folder` will present you with the `Create Folder` dialog.
+
+Fill in the *Folder Name* and click `Create Folder`

docs/user-guides/create-and-manage-object-storage/index.md

@@ -0,0 +1,32 @@
+---
+hidden: false
+label_names:
+- Object Storage
+- create
+- manage
+position: 1
+title: Create and Manage Object Storage
+vote_count: 1
+vote_sum: 1
+---
+
+Object Storage within FlexiHPC is a file system storage that is primarily used for storing static data. Unlike other storage systems, object storage is independent of virtual machines and operating system type.
+
+You are able to upload and download files from anywhere with network access using a few methods.
+
+The general use case for object storage is storing data that you upload once and read or download many times. Its not the best for files that are being modified consistently.
+
+There are a few ways to create and mange object storage within FlexiHPC
+
+- [Creating and Managing object storage via the Dashboard](create-and-manage-object-storage-with-the-dashboard.md)
+
+- [Creating and Managing object storage via CLI](create-and-manage-object-storage-via-cli.md)
+
+
+Interacting with the FlexiHPC Object storage can be done a few ways outside of the dashboard. 
+
+- [Interacting with the S3 protocol with Boto3](using-boto3-to-interact-with-object-storage.md)
+
+- [Using FlexiHPC object storage for Terraform state file](../launch-and-mange-instances/deployment-of-an-instance-with-terraform.md#using-flexihpc-object-storage-to-store-the-terraform-state-file)
+
+- [Accessing object storage with Cyberduck](using-cyberduck-to-interact-with-object-storage.md)

docs/user-guides/create-and-manage-object-storage/summary.md

@@ -0,0 +1,8 @@
+* [Object Storage: Create and Manage](index.md)
+* With the Dashboard
+    * [Create and Manage](create-and-manage-object-storage-with-the-dashboard.md)
+* With the CLI
+    * [Create and Manage](create-and-manage-object-storage-via-cli.md)
+* [Interacting with the S3 protocol with Boto3](using-boto3-to-interact-with-object-storage.md)
+* [Accessing object storage with Cyberduck](using-cyberduck-to-interact-with-object-storage.md)
+* *