Bucket management
Buckets are containers that store your data on HCP for cloud scale. Contained within buckets are objects, which are the documents and files that you intend on storing in the cloud. Each bucket can also be assigned its own custom configuration and can be set with a unique set of permissions.
To further define objects in a bucket, policies can be added. Rules (where both tags and prefixes can be added as filters) define which objects in the bucket that the policy applies to.
For more information about the different available policies, see Policy management. For more information about tags, see Tags. For more information about prefixes, see Prefixes.
On the Buckets page, performance metrics are displayed regarding general bucket utilization and usage. You can also view the following information:
- Bucket name: The name of the bucket
- Objects: The number of objects and object versions stored in the bucket
- Size: The size of the bucket and all of its objects and object versions
- Storage class: The selected storage class for the bucketNoteS3 Standard is currently the only supported storage class.
- Access type: The level of authentication required to use and view the bucket
- Private: Only you have access to this bucket
- Authenticated: Lets you grant access to this bucket for any user with an account on the system
- Unauthenticated: Lets you grant public access to this bucket for anyone and allows you to assign read or read/write privileges
- Created: The date and time the bucket was made
By clicking a bucket's more icon (
), you can find additional options for interacting with your bucket:
- Browse: Takes you directly to the bucket's Browse page
- Overview: Takes you directly to the bucket's Overview page
- Properties: Takes you directly to the bucket's Properties page
- Delete: Deletes the bucket
Additionally, you can search for a specific bucket by using the search field.
Buckets
From a bucket's main page, you are provided with the following options for interacting with it:
- Browse: Where you can view the objects stored within the bucket. Selected by default.
- Overview: Where you can view a graphical representation of the bucket's data usage.
- Properties: Where you can set the access level and policies for the bucket.
Creating a bucket
To create a bucket:
Procedure
From the Buckets page, click + Create Bucket.
The Create bucket page appears.In the Name field, enter a name for your bucket.
TipBucket names can only contain lowercase letters, numbers, periods, and hyphens.In the Access level section, select your required level of security.
- Private: Only you have access to this bucket.
- Authenticated: Lets you grant access to this bucket for any user with an account on the system.
- Unauthenticated: Lets you grant public access to this bucket for anyone. You can choose to assign Read or Read/Write privileges.
In the Bucket policies section, chose your preferred policy using the selection slider.
- Expiration Lifecycle policy: Lets you define when objects expire.
- Sync-to Replication: Lets you enable automatic copying of objects to remote buckets. You cannot apply both Sync-to and Sync-from replications to the same bucket.
- Sync-from Replication: Lets you enable automatic copying of objects from remote buckets. You cannot apply both Sync-to and Sync-from replications to the same bucket.
To add rules to your selected policy:
- On your selected policy, click Configure.
- On the Configure page, click + Add rule.
- To add the rule to a subset of your objects, click Filter objects and add tags and prefixes. Additionally, you can have the rule apply to all objects in a bucket by selecting All objects.
- When you are finished configuring your rule, click Done.
When you are finished configuring your policy, click Create.
You are returned to the Buckets page and a message confirming the creation of the new bucket is displayed.To view your new bucket, select it by clicking its name from the Bucket name column.
A confirmation message appears to let you know the bucket was created successfully. The bucket page is then displayed and an overview of your bucket is provided.
Creating a bucket with object lock
When applying object lock to a bucket, you can then enable compliance mode to set a retention period to its contents. Additionally, when object lock is applied, legal hold can be set on a version of an object. See Setting legal hold on a version of an object.
To create a bucket with object lock:
Procedure
From the Buckets page, click + Create Bucket.
The Create bucket page appears.In the Name field, enter a name for your bucket.
Click the Object lock toggle to enable it.
In the Access level section, select your required level of security.
- Private: Only you have access to this bucket.
- Authenticated: Lets you grant access to this bucket for any user with an account on the system.
- Unauthenticated: Lets you grant public access to this bucket for anyone. You can choose to assign Read or Read/Write privileges.
In the Bucket policies section, choose Object Lock.
Click Configure on the Object Lock policy to set retention.
Click the Default retention toggle to enable it and set the retention period.
Click Update.
When you are finished configuring your bucket, click Update.
To view your new bucket, select it by clicking its name from the Bucket name column.
A confirmation message appears to let you know the bucket was created successfully. The bucket page is then displayed and an overview of your bucket is provided.
Deleting a bucket
To delete a bucket:
Procedure
From the Buckets page, navigate to the bucket you want to delete.
Delete all objects from the bucket. See Deleting an object.
From the Buckets page, click the more icon for your bucket and then select Delete.
A confirmation message appears.Click Confirm Delete.
Directories
Directories are folders within a bucket that house objects and help to provide organization.
Creating a directory
To create a directory for a bucket:
Procedure
From the Buckets page, select the bucket you want to create a directory in.
Click Create Directory.
Give your new directory a name and click Save.
Deleting directories
When you delete a directory, all of the files contained within it are also deleted. A delete marker is created for the directory, which can be used to restore it and all of its contents at a later time. See Displaying deleted objects and directories.
Deleting a directory
To delete a directory:
Procedure
From the Buckets page, select the bucket containing the directory you want to delete.
Click the more icon at the righthand side of the directory.
Click Delete.
The directory is deleted.
Deleting multiple directories
To delete multiple objects:
Procedure
From the Buckets page, select the bucket containing the directories you want to delete.
Click the checkboxes associated with the directories.
From the righthand side of the object selection bar, click Delete.
The directories are deleted from the bucket.
Deleting an empty directory
An empty directory is characterized as a folder that doesn't have any listed objects, even though some objects may have the delete marker as the current version.
After deleting an empty directory, the object list is refreshed to show the change.
To delete an empty directory:
Procedure
From the Buckets page, navigate to the directory you want to delete.
Click the more icon at the righthand side of the directory.
A warning message appears regarding the deletion of the bucket.To confirm the delete, click Confirm.
The directory is deleted.
Restoring directories
To restore a deleted directory, you must first enable it to view its delete marker. See Displaying deleted objects and directories. When you restore a directory, all of the files contained within it are also restored.
Restoring a deleted directory
To restore a deleted directory:
Procedure
From the Buckets page, select the bucket containing the directory you want to restore.
Click the Show deleted objects box.
Your deleted directories now display with a trashcan icon next to them.Click the more icon at the righthand side of the directory, noted by its trashcan icon.
Click Restore.
The directory is restored to the bucket.
Restoring multiple deleted directories
To restore multiple deleted directories:
Procedure
From the Buckets page, select the bucket containing the directories you want to restore.
Click the Show deleted objects box.
Your deleted directories now display with a trashcan icon next to them.Click the checkboxes associated with the deleted directories.
From the righthand side of the object selection bar, click Restore.
The directories are now restored to your bucket.
Destroying directories
When you destroy a directory, all versions of the directory are completely removed. All objects in the directory must first be deleted and its object count must be at 0 in order to take this action.
Destroying a directory
To destroy a deleted directory:
Procedure
From the Buckets page, select the bucket containing the directory you want to destroy.
Click the Show deleted objects box.
Your deleted directory is now displayed with a trashcan icon next to it.Click the more icon at the righthand side of the directory.
Click Destroy.
Type YES and then click Confirm Destroy.
The directory is permanently removed from the bucket.
Rules
Rules can be applied to the objects in a bucket using either prefixes, tags, or a combination of both. They can also be helpful if want to set object expiration for current and non-current versions of objects. Policies can support up to 1,000 rules at a time.
Adding rules to policies
To add a new rule to a policy:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on the policy.
Click + Add rule.
The Add Rule page appears.To add tags to your rule, click + Add tag.
To apply actions (for the expiration lifecycle policy) or to change configuration settings for your rule, scroll to the bottom of the page.
When finished, click Done.
The rule is added to the selected policy's Configure policy page.From the Rules table, select the rule(s) you want to add to your policy using the checkbox column.
Click Done.
You are returned to the Create bucket page and your rules are noted in the Configured rules section of your selected policy.
Editing a rule
To edit a rule:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on the policy.
Click the more button for your rule and then select Edit.
Click Done.
Deleting rules from a policy
To delete a rule from a policy:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on the policy.
Click the more button for your rule and then select Delete.
Click Okay.
Filters
All rules can be assigned a filters. Filters help you identify which objects in a bucket the rule applies to.
Prefixes
Prefixes are an S3 concept that represent the path to a virtual folder. They are a way to help you visualize the concept of cloud storage and storage, given that no actual folders truly exist, and allow you to group objects by using common strings.
For example, setting a rule that applies to the /foo prefix would apply to all objects that start with /foo, such as /foo/bar, /foo/bar1/bar2, etc.
Adding a prefix filter to a policy
To add a prefix filter to a policy:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on the policy.
Click + Add rule.
The Add Rule page appears.Click Filter objects.
The Prefix field and Tags list appear.In the Prefix field, enter your prefix.
Click Done.
Editing a prefix filter
To edit a prefix filter on a policy:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on the policy.
The Rules page appears.Click the more icon for your prefix filter and select Edit.
Removing a prefix filter from a policy
To remove a prefix filter from a policy:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on the policy.
The Rules page appears.Click the more icon for your prefix filter and select Delete.
Tags
Tags are independent of prefixes and are represented as key-value pairs. You can create a rule only using tags without adding a prefix. A rule with tags means that it only applies to objects with matching values.
Adding tags to rules
To add a tag to a rule:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on your selected policy.
Click + Add rule.
Click Filter objects.
The Prefix field and Tags list appear.To add tags to your rule, click + Add tag.
The Add tag window appears.In the Key and Value fields, enter your tagging information.
When finished, click Save.
(Optional) To add additional tags, click the Add another tag box and then click Save.
On the Add rule page, click Done.
Editing a tag
To edit a tag which is part of a current rule:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on your selected policy.
On the Configure policy page, click the more icon for the rule containing your tag and then select Edit.
The Add Rule page appears.Click Filter objects.
The Prefix field and Tags list appear.To edit a tag, click its more icon from the Tags list and then select Edit.
In the Key and Value fields, update your tagging information.
When finished, click Save.
To finalize your changes, on the Add rule page, click Done.
Deleting a tag filter
To delete a tag from a rule:
Procedure
From the Buckets page, select your bucket.
Click the Properties tag.
Click Configure on your selected policy.
On the Configure policy page, click the more icon for the rule containing your tag and then select Delete.
Bucket retention management
Setting retention on an object version protects it from deletion for a set amount of time. Once the retention period ends, that version of the object can then deleted.
Setting retention on a version of an object
To set legal hold on a version of an object within a bucket:
Procedure
From the Buckets page, click the name of the bucket in which the object resides.
Navigate to the object you want to view and then click its more icon.
Select View versions.
All versions of the selected object are displayed.Click the more icon at the righthand side of the object you want to add retention to.
To set retention on an object, click Set Retention.
In the Date and Time fields, set your values for your object's retention length.
Click Save.
Retention is set on that version of the object.
Restoring a version of an object
To restore a version of an object:
Procedure
From the Buckets page, select the bucket containing the object version you want to restore.
Navigate to the object and then click its more icon.
Select View versions.
All versions of the selected object are displayed.Click the more icon at the righthand side of the version you want to restore and select Restore Data.
The object version is now restored to your bucket.