Using the ProfitBricks S3 Object Storage

From ProfitBricks Online Help
Jump to: navigation, search

Contents

Opening the Object Storage Management Console

The Object Storage Management Console enables you to access the ProfitBricks S3 Object Storage by means of a GUI. It helps you to manage your object storage - create and delete buckets, upload objects and manage access to them. You need to be logged on to the DCD in order to open the Management Console of ProfitBricks S3 Object Storage. It is available in English only.

Opening your own Object Storage

Pre-requisites

  • You are a contract owner or administrator.
- or -
  • You have the permission to use the ProfitBricks S3 Object Storage.
  • You are logged on to the DCD.
  • You have at least one active object storage key.
  • Your browser allows popups.

Procedure

  • In the menu bar of the DCD, click on Object Storage.
DCD-menu-bar-object-storage.png
The bucket overview of the Object Storage Management Console of your ProfitBricks S3 Object Storage is opened in a separate browser window so that you can continue working in your DCD.
Object-Storage-Management-Console.png
Depending on your permissions, you can now use ProfitBricks S3 Object Storage and its features.
  • In order to leave the Object Storage Management Console, click on Sign Out:
Object-Storage-Management-Console-logout.png

When there is no activity over a longer period of time, you are logged off automatically.

Opening the Object Storage of Another Contract Member

Contract owners and administrators can access the object storage of other members of their contract in order to manage their objects, especially of users who are no longer active.

NOTE: Before you delete a user or all of his object storage keys from your ProfitBricks account, please ensure - by adjusting the access permissions - that objects managed by this user are accessible in such a way that you can use them further or delete them. Private objects, which have not been deleted prior to deleting a user or all of his object storage keys can not be accessed. You are, however, still being charged for them. If such a case occurs, please contact the ProfitBricks Support Team.

Pre-requisites

  • You are a contract owner or administrator.
- or -
  • You have the permission to use ProfitBricks S3 Object Storage.
  • You are logged on to the DCD.
  • You have at least one active object storage key.
  • Your browser allows popups.

Procedure

  • Open the user management. (Menu bar > Manage Users > Users)
  • Select the user whose object storage you want to open.
  • In the Object Storage Keys tab, click on Manage Object Storage of User.
User-management-open-object-storage-of-another-user.png
The Buckets overview of the selected user’s object storage is opened in the Object Storage Management Console:
Object-Storage-Management-Console.png

You are logged on to the user’s object storage with full access rights.

Creating Buckets

Buckets are logical containers in which you can store objects. You can create 100 buckets per user.

Naming Rules

  • The name of a bucket needs to:
    • Be unique across the ProfitBricks S3 Object Storage. If a bucket with the selected name already exists, an error message occurs.
    • Contain at least 3 up to 63 characters,
    • Start with a letter or a number,
    • Contain lower case letters (a-z) and numbers (0-9).

The use of dash (-), periods (.), and underscores (_) is restricted as follows:

  • The bucket name must not:
    • End with a dash, period, or underscore.
    • Contain two or more adjacent periods.
    • Dashes next to periods.
    • Be in the form of an IPv4 address (e. g. 192.168.1.4).
    • Contain underscores if you want to use auto-tiering for the bucket later on.

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • In the Buckets overview click on +add new bucket.
The bucket properties open:
Object-Storage-Management-Console-create-bucket.png
  • In the Bucket Name field enter a name that is in accordance with the naming rules.
  • Leave the default values for Region and Storage Policy as is.
NOTE: Once set, storage region and storage policy cannot be changed.
  • Click on Create to create the bucket.

The bucket is created.

You can now:

  • Check and change - where possible - the bucket’s properties:
    • Region - region in which ProfitBricks S3 Object Storage is located.
    • Bucket Permissions and Canned ACL - defines access to the bucket.
    • Storage Policy - defines the data protection level of the object storage
    • Lifecycle Policy - enables the definition of rules for automatic handling of objects; auto-tiering is currently not supported
    • Static Website Hosting - enables access to objects by means of a web-browser (instead of an S3 client application),
    • Cross-Region Replication: enables geo-redundant backups; currently not supported.
    • Versioning - enables versioning of objects
    • Logging - enables tracking of bucket access
  • Create folders,
  • Upload objects,
  • Create more buckets.

Creating Folders

Folders are logical containers within buckets to help you structure and organize your objects - much like you know it from a hierarchical file system. A bucket can contain multiple folders, and folders can contain further folders.

You cannot define any properties or access permissions for a folder. This is done at the bucket or object level. For Folders the same naming rules apply as for objects.

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • Open the bucket in which you want to create the folder by simply clicking on its name.
  • The Objects overview opens:
Object-Storage-Management-Console-objects.png
  • In order to create a new folder, click on + Create Folder.
The respective dialog box opens:
Object-Storage-Management-Console-create-folder.png
  • In the Folder Name field, enter a name that is in accordance with the naming rules.
  • Click Ok to apply your settings.

The folder is created and displayed in the bucket.

Uploading Objects

You can upload objects of any format.

Naming Rules

Object names need to adhere to the following rules, otherwise a “400 Bad Request” will be the result:

  • Characters an object name may not contain:
    • 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A ("\n"), 0x0B, 0x0C, 0x0D ("\r"), 0x0E, 0x0F, 0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F
    • 0xBF at the end of an object name
    • Any combination of “.” and “/” or “..” and “/”.
    • The name may not consist only of “.” or “..”

Examples of character sequences that will be stored under a different name:

Input Stored value
./a a
./a/ a/
a//b a/b
a/./b a/b
a/../b b


Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • Open the bucket or folder to which you want to upload files.
  • Click on Upload File.
The Upload Files dialog box opens:
Object-Storage-Management-Console-upload-objects.png
  • Click on + Add files… in order to select the files from your local drive.
  • (Optional) Activate the Store encrypted checkbox so that the files are encrypted on the server-side increasing security. When downloaded, they are decrypted automatically.
  • In order to begin the upload:
    • All files: Click on Start upload.
    • Single files: Click on Start.
The progress of the upload is displayed:
Object-Storage-Management-Console-upload-progress.png
  • (Optional) If you want to stop the upload, click on Cancel upload.
  • Close the dialog box.

The files (objects) are available in the bucket or folder to which you uploaded them.

You can now:

  • Manage access to objects,
  • Delete objects,
  • Upload more files,
  • Download objects or object versions by clicking on the name of the object. Object versions are displayed after clicking + Show Versions.

Sharing Buckets and Objects

Sharing Through Permissions

You can define who can access the buckets and objects in your object storage by applying permissions or pre-defined access profiles (“canned ACLs”). By default, buckets and objects are private and can only be accessed and managed by the bucket owner.

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • Open the Properties of the bucket, object or object version that you want to share.
  • You have the following options of granting access:
> In the Bucket Canned ACL resp. Object Canned ACL tab select the pre-defined access profile that matches your requirements.
Example: public read enables any user to access the content without being able to change anything.
- or -
> In the Bucket Permissions resp. General Permissions tab select the grantee and assign them the permission(s) that match your requirements.
Example: Grantee=Authenticated Users, writable allows all users of the ProfitBricks S3 Object Storage (even outside of your own contract) to access and change the objects that are shared with them.
  • Apply your settings by clicking Save.

The content is shared with users according to your settings.

Sharing with Selected Users (“ACL Sharing”)

If you want to share your buckets and their content with ProfitBricks S3 Object Storage users outside your own contract, you can use ACL sharing. All you need is the user’s “object storage user ID” which consists of contract number and user ID (contract number|userID).

Pre-requisites You have the required permission.

  • The Object Storage Management Console is opened.
  • You have the object storage user ID of the user with whom you want to share your bucket content.

Procedure

  • Open the Properties of the bucket, object or object version that you want to share.
  • In the General Permissions tab, click on + ADD NEW.
A new row opens.
  • In the text field of the Grantee column, enter the object storage user ID.
TIP: If you want share something with all members of a specific contract, simply enter the contract number as follows: contract number| (e. g. 1234567|)
NOTE: Please note that the system does not check the validity of the IDs. Invalid IDs have no effect.
  • Set the permission for the user by selecting the appropriate checkbox.
  • Confirm your entries by clicking Save.

The selected bucket or object is shared according to your settings.

Sharing Through a Public URL

If you want to share content with users who do not have access to an S3 client application, you can share an object by making it publicly available through a URL.

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • In the Objects overview open the Properties of the object or object version that you want to share.
  • Open the Public URL Access Tab.
  • Select the Enable Public URL Access checkbox.
More entry fields appear:
Object-Storage-Management-Console-public-URL.png
  • Define the maximum number of downloads in the Maximum Downloads field.
TIP: If you want to allow unlimited access, enter -1.
  • (Optional) Activate the Secure URL (Https) checkbox in order to have an SSL-encrypted URL generated.
  • (Optional) Change the expiration date of the URL in the Expiration Date/Time field.
  • In order to have the URL generated, click on Apply.
The URL is generated and displayed:
Object-Storage-Management-Console-public-URL-access.png

You can now copy and distribute the URL or send them by e-mail by clicking on MAIL TO.

NOTE: If you want to use the MAIL TO button, your browser needs to be configured to open your default web-based e-mail program.

The file you have shared through a public URL can be opened and downloaded with any web-browser. The link is no longer accessible after the URL is expired, or when its expiration date or download number are changed and a new URL is generated. Instead, an error message occurs (“AccessDenied”).

Hosting a Static Website

If you want to share content with users who do not have access to an S3 client application, you can configure a bucket as a website, which can be accessed using a standard web browser. This website needs to be static; it cannot deliver personalised content or run server-side scripts. This feature is useful for sharing a collection of objects. The default website address is created as follows http://<Bucketname>.<S3WebsiteEndpoint>/<Index Document>

Objects and further web pages are available at http://<Bucketname>.<S3WebsiteEndpoint>/<Objectname>, where <Objectname> can also contain folder structures.

S3WebsiteEndpoint:

S3-website-de-central.profitbricks.com

NOTE: Please note that content made available through a bucket that is configured as a website can only be accessed through HTTP. HTTPS (SSL) is not supported. Objects need to be public, otherwise they cannot be accessed.

Example

The bucket mywebsite is used as a container for your website. “Static Website Hosting” has been enabled in its properties. It contains the start page (default.htm) and the optional error page (404.htm).

Object-Storage-Management-Console-static-website-example-bucket.png

The bucket contains an img folder, in which image files such as test0.png are stored.

Object-Storage-Management-Console-static-website-example-img.png

The file is available at http://mywebsite.S3-website-de-central.profitbricks.com/img/test0.png

Object-Storage-Management-Console-static-website-example-img-address.png

That way you can build a website using static HTML-pages and other contents. Files can be linked with each other through relative paths. If you want to link from default.htm at the bucket (root) level to test0.png, which is located in the img folder of the mywebsite bucket, you can refer to it with href=”img/test0.png”.


Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • Create a bucket in which you want to store the files of your static website (html-pages, images and more). (see also: Creating Buckets)

NOTE: The bucket name is part of the URL of your static website. Please note that naming rules need to be applied. Upload all files required for your website to the bucket, including a start page (usually index.htm) and an optional error page (usually 404.htm).

  • In the Properties of the bucket open the Static Website Hosting tab.
Object-Storage-Management-Console-static-website-hosting.png
  • Select the Enable Website Hosting tab.
  • In the next dialog box, confirm that you want all objects the bucket contains to be public by clicking Ok.
  • In the Index Document field, enter the name of the start page you have uploaded before (e. g. index.htm)
  • (Optional) In the Error Document field, enter the name of the error page you have uploaded before (e. g. 404.htm).
  • When you upload further objects to this bucket, please ensure they are public.
  • Save your settings by clicking Save.

The website is now available at http://<Bucketname>.<S3WebsiteEndpoint>/<Index Document> Object-Storage-Management-Console-static-website-example.png

Public objects (including further web pages) the buckets contains are available at http://<Bucketname>.<S3WebsiteEndpoint>/<ObjectName>

Versioning

From the moment versioning is enabled for a bucket, not only an uploaded object, but also its previous versions are saved. This is useful for storing multiple statuses of a document, for instance. The object always needs to have the same name and needs to be uploaded to the same place for making use of this kind of version tracking. By default, versioning is not enabled.

NOTE: Please note that using this feature increases your storage usage.

When you disable versioning, existing object versions are not affected - they are not deleted unless you delete them yourself.

Objects that had been uploaded to the bucket before you activated versioning for a bucket can be recognised by their object ID null.

Object-Storage-Management-Console-Object-Version-null.png

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • In the Buckets overview, open the bucket’s properties by clicking on Properties.
  • Open the Versioning tab.
Object-Storage-Management-Console-versioning.png
  • To activate versioning, click on Enable.
  • To deactivate versioning, click on Suspend.
  • Versioning is activated or deactivated accordingly.
  • To display available object versions, click on Show Versions in the Objects tab:
Object-Storage-Management-Console-show-versions.png
The object versions are displayed:
Object-Storage-Management-Console-versions.png

Object versions can be deleted and shared just like objects.

Logging

Logging allows you to track access to a bucket. When enabled, every ten minutes a log file is generated (provided the bucket, on which logging is enabled, has been accessed) and stored in a designated bucket. The log file is compliant with Amazon S3 bucket logging.

By default, logging is not enabled.

Pre-requisites

  • You are the owner of the bucket in which log files are to be stored (“destination bucket”).
  • The Object Storage Management Console is opened.

Procedure

  • (Optional) Create a bucket in which you want to store log files (“destination bucket”). Alternatively, you can use the bucket for which you want to enable logging as destination bucket.
  • Assign the required write permissions for the Log Delivery Group to the destination bucket as follows:
> Bucket Properties > Bucket Canned ACL: Log Delivery Write,
- or -
> Bucket Properties > Bucket Permissions: Log Delivery - writable, acp writable.
  • Open the Properties tab of the bucket for which you want to set logging.
  • Open the Logging tab.
Object-Storage-Management-Console-logging.png
  • In order to activate logging, select the Enable Logging checkbox.
  • In the Destination Bucket field, enter the name of the bucket in which the log files are stored. Source and destination bucket can be the same, but it is recommendable to use a designated bucket.

NOTE: Write permission for Log Delivery needs to be assigned on the destination bucket before you activate logging. You need to be the owner of the destination bucket.

  • (Optional) In the Target Prefix field, enter the file prefix for the generated logs so that they can be found and sorted more easily (e. g. log_). When no prefix is defined, the timestamp is taken as filename.
- or -
  • In order to de-activate logging, de-activate the Enable Logging checkbox.
  • Save your setting by clicking Save.

The log files are named according to your settings and stored in the destination bucket as defined. Object-Storage-Management-Console-logs.png You can change the logging for a bucket any time in the Logging tab of its Properties. When changing or deactivating logging, existing log files will not be affected. Like objects, they can be deleted and shared.

Searching for Objects

You can look for files using their prefix or entire file name. For technical reasons, it is not possible to search for objects across buckets or folders.

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • Open the bucket or folder in which you want to search for the object or object version.
  • Click on + Search by Prefix.
  • In the next dialog box, enter the prefix or entire file name and click OK.
Object-Storage-Management-Console-search.png

Files matching your search criteria are displayed.

Downloading Objects

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • Open the bucket containing the object you want to download.
  • (Optional) When logging is activated for the bucket, you can retrieve available object versions by clicking on Show Versions in the Objects tab.
  • Click on the object or object version you want to download.
- or -
  • If the object was shared through a public URL, open and download it through your browser.
  • If no specific object version was selected, the latest version of the object is downloaded.

Deleting Objects

Manually

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • Open the bucket or folder containing the objects you want to delete.
  • In order to delete selected versions of an object, click on Show Versions.
  • To delete only one object or object version, click on Delete at the of the entry.
  • To delete multiple objects, object versions, or folders, select their respective checkboxes.
Object-Storage-Management-Console-delete-objects.png
NOTE: Unlike buckets, folders do not need to be empty to be deleted.
  • Click on Delete.
  • Confirm your action in the next dialog box.

The objects you selected are deleted. Folders and their contents are deleted.

Automatically

In order to make the process of deleting multiple objects more efficient or if you want to delete objects (log files, for instance) on a regular basis, you can automate the deletion by defining rules and a schedule. Automatic deletion takes places within a few hours.

Pre-requisites

  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • In the Buckets tab, open the bucket properties by clicking on Properties.
  • Open the Lifecycle Policy tab.
Object-Storage-Management-Console-auto-delete-objects.png
  • Click on + ADD NEW RULE.
  • (Optional) In the Rule Name field, enter a descriptive name for the rule (e. g. “delete all”).
  • In the Object Prefix field, enter the complete path to the objects that you want to delete automatically. Folders are separated by / (example: 2015/ deletes all objects in the folder named “2015” including sub-folders.)
TIP: Leave this field empty if you want to delete all objects in a bucket.
  • Activate the Expire Objects checkbox.
Further entry fields are opened:
Object-Storage-Management-Console-rule-for-auto-deletion.png
  • First select the type of object version you want to delete:
> For buckets with versioning enabled:
Current Version: the latest version
Previous Version: any version that is not the current version
> When no versioning is enabled, select Current Version.
  • Define the time of deletion. The following options are available:
Current Version
  1. Fix date: Select date and time in the After Date field. No further settings required.
  2. Number of days after creation: First select the Use Creation Date/Time field. Then define the number of days in the Days After Creation Date field.
  3. Number of days after last access: First select the Use Last Access Time field. Then define the number of days in the Days After Last Access Date/Time.
NOTE: When you create multiple rules for different objects in a bucket, all rules need to use the same type of schedule (1., 2., or 3.).
Previous Version: Number of days since this version turned non-current
  • If you want to fully remove objects that were deleted, activate the Clean Up Expired Object Delete Markers checkbox.
NOTE: For technical reasons it's not possible to delete the current version of an object and have its deleted previous versions removed at the same time. (Deleted objects are marked with a "delete marker", which you can recognise by the following icon: ) This clean-up cannot be applied when you have defined an auto-deletion rule for current version. In this case, the checkbox is de-activated and a note "You cannot enable clean up expired object delete markers if you enable Expiration" is displayed.
  • If you want to remove incomplete parts of a multi-part upload, activate the Clean Up Incomplete Multipart Uploads checkbox.
  • Confirm your entries by clicking Save.

The rule is saved and the objects it affects are going to be deleted according to schedule.

Deleting Buckets

Pre-requisites

  • The bucket you want to delete does not contain any objects.
  • You have the required permission.
  • The Object Storage Management Console is opened.

Procedure

  • Open the Buckets tab.
  • Click on the Buckets Delete button.
  • Confirm this action by clicking OK in the next dialog box.

The bucket is deleted and cannot be restored.

Personal tools
Namespaces

Variants
Actions
Online Help
Introduction
First Steps in the Data Center Designer
Elements and Functions
Information
Tutorials
FAQ
DevOps Central Website
Tools