Skip to content

Commit

Permalink
CloudDataverse User & Install Guides [ref: #3747]
Browse files Browse the repository at this point in the history
Wrote new sections on Cloud Dataverse for user guide and added a note
about file restrictions in Swift to the Installation Config guide.
  • Loading branch information
dlmurphy committed May 15, 2017
1 parent b010eca commit 2172603
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
4 changes: 3 additions & 1 deletion doc/sphinx-guides/source/installation/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,9 @@ File Storage: Local Filesystem vs. Swift

By default, a Dataverse installation stores data files (files uploaded by end users) on the filesystem at ``/usr/local/glassfish4/glassfish/domains/domain1/files`` but this path can vary based on answers you gave to the installer (see "Running the Dataverse Installer" under the :doc:`installation-main` section) or afterward by reconfiguring the ``dataverse.files.directory`` JVM option described below.

Alternatively, rather than storing data files on the filesystem, you can opt for a experimental setup with a `Swift Object Storage <http://swift.openstack.org>`_ backend. Each dataset users create gets a corresponding "container" on the Swift side and each data file is saved as a file within that container.
Alternatively, rather than storing data files on the filesystem, you can opt for a experimental setup with a `Swift Object Storage <http://swift.openstack.org>`_ backend. Each dataset that users create gets a corresponding "container" on the Swift side, and each data file is saved as a file within that container.

Note: At present, any file restrictions that users apply in Dataverse will not be honored in Swift. This means that a user without proper permissions could bypass intended restrictions by accessing the restricted file through Swift.

In order to configure a Swift installation, there are two steps you need to complete:

Expand Down
9 changes: 7 additions & 2 deletions doc/sphinx-guides/source/user/dataset-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,15 @@ There are several advanced options available for certain file types.

.. _cloud-storage:

Cloud Storage & Computing
-------------------------

Some Dataverse installations are specifically set up to facilitate cloud-based computing. While vanilla Dataverse uses a traditional file system for storing data, Cloud Dataverse uses a Swift object storage database. This allows users to perform computations on data using an integrated cloud computing environment. You'll know you're using Cloud Dataverse if you see a "Compute" button on dataset and file pages. Clicking that Compute button will take you directly to the cloud computing environment that is integrated with Cloud Dataverse, allowing you to perform computations on the file or dataset you were just viewing.

Cloud Storage Access
--------------------
~~~~~~~~~~~~~~~~~~~~

Cloud Storage Access is the container name for this dataset needed to access files in cloud storage.
If you need to access a dataset in a more flexible way than Dataverse's Compute button provides, then you can use the Cloud Storage Access box on the dataset page to copy the dataset's container name. This unique identifer can then be pasted into whatever script or field you may be running, to allow direct access to the dataset.

Edit Files
==========
Expand Down

0 comments on commit 2172603

Please sign in to comment.