ECS 2.1 – Configure support for CAS SDK applications with the ECS Portal

Table of Contents

Setting up CAS support in ECS

Introduces CAS (content addressable storage) support in ECS.

ECS CAS allows CAS SDK-based client applications to store, retrieve, and delete fixed content objects from ECS storage.

The underlying ECS storage must be provisioned before you can configure your ECS set up. Provisioning is usually completed when a new ECS rack is installed. This includes setting up a storage pool, VDC, and replication group. In ECS CAS, there are no CAS-specific features in these objects, so you can use the standard documentation if you need to create or edit these objects to support CAS. See Configure storage pools, VDCs, and replication groups.

Next, set up your namespaces, users, and buckets, using the standard documentation:

This document describes how to modify your basic configuration to support CAS:

Back to Top

CAS retention in ECS

A CAS C-Clip can have a retention period that governs the length of time the associated object is retained in ECS storage before an application can delete it.

Retention periods

Retention periods are assigned in the C-Clip for the object by the CAS application.

For example, if a financial document must be retained for three years from its creation date, then a three-year retention period is specified in the C-Clip associated with the financial document. It is also possible to specify that the document is retained indefinitely.

Retention policies (retention classes)

Retention policies enable retention use cases to be captured and applied to C-Clips. For example, different types of documents could have different retention periods. You could require the following retention periods:

When a retention policy is applied to a number of C-Clips, by changing the policy, the retention period changes for all objects to which the policy applies.

Retention policies are associated with namespaces in ECS and are recognized by the CAS application as retention classes.

Bucket-level retention not recommended for CAS

ECS provides bucket-level retention for all object services. Since bucket-level retention overrides all CAS object-level retention, it will likely interfere with the external CAS application.

CAS precedence

When multiple retention periods are applied to a CAS object in ECS, the retention period with the higher value has precedence no matter how the retention was applied.

How to apply CAS retention

You can define retention polices (retention classes) to namespaces in the ECS Portal or with the ECS REST API. See Set up namespace retention policies.

Your external CAS application can assign a fixed retention period or a retention class to the C-Clip during its creation.

When applying retention periods through APIs, specify the period in seconds.

Note that ECS CAS takes the creation time of the C-Clip for all retention related calculations and not the migration time.

How to create retention policies with the ECS REST API.

You can create retention periods and policies using the ECS Management REST API, a summary of which is provided below.

You can find more information about the REST API here: Use the ECS Management REST API. The online reference is here: ECS Management REST API Reference.

Back to Top

Set up namespace retention policies

Provides CAS-specific set up instructions for namespace retention policies.

The Retention Policy feature for namespace provides a way to define and manage CAS retention classes for all C-Clips created in the namespace.

A namespace can have many retention polices, where each policy defines a retention period. By applying a retention policy to a number of C-Clips (with the API), a change to the retention policy changes the retention period for all objects associated with the policy. For CAS, retention classes are applied to an object's C-Clip by the application. If an object is under a retention period, requests to modify the object are not allowed.

Procedure

  1. At the ECSportal, select Manage > Namespace.
  2. To edit the configuration of an existing namespace, choose the Edit action associated with the existing namespace.
  3. Add and Configure Retention Policies.
    1. In the Retention Policies area, select Add to add a new policy.
    2. Enter a name for the policy.
    3. Specify the period for the Retention Policy.
      Select the Infinite checkbox to ensure that objects with this policy are never deleted.

      New Retention Policy

  4. Select Save.

    Retention policies for a namespace

Back to Top

Set up a bucket for CAS

Configure a bucket to support CAS.

Note Image
Bucket-level retention policies are not recommended for CAS.

Procedure

  1. At the ECSportal, select Manage > Bucket.
  2. To edit the configuration of an existing bucket, choose the Edit Bucket action associated with the existing bucket.
  3. Select the CAS On control to enable CAS for the bucket.
  4. Select Save.
Back to Top

Set up a CAS object user

Set up an object user to use CAS.

When you set up an object user, you can assign CAS features to the profile that make up the elements of a CAS profile. You will be able to view the resulting PEA file for use in your CAS applications.

Procedure

  1. At the ECSportal, select Manage > Users.
  2. To edit the configuration of an existing object user, choose the Edit action associated with the user.

    CAS settings for object users

  3. In the CAS area, type a password (secret) or choose Generate to have the portal create one for you.
  4. Choose Set Password.
  5. Choose Generate PEA File to generate the PEA file your application will need to authenticate to the CAS storage on ECS.
  6. By setting a default bucket, every action the user takes that does not specify a bucket will use the specified default bucket. Type the name of the default bucket and chooseSet Bucket.
  7. Choose Add Attribute to add a metadata tag to the user.
  8. Add the metadata tag name and value.
    See the CAS SDK documentation for more info on metadata tags.
  9. Choose Save Metadata.
Back to Top

Set up bucket ACLs for a user

Edit a bucket's access control list to limit a user's access.

Edit bucket ACLs for CAS users. Some ECS bucket ACLs map to CAS permissions and some have no meaning for CAS data.

Procedure

  1. At the ECSportal, select Manage > Bucket.
  2. To edit the ACLs of an existing bucket, choose the Edit ACL action associated with the existing bucket.

    Edit bucket ACL

  3. Choose the Edit associated with the user.

    Bucket ACLs Management

  4. Modify the permissions.
    Note Image
    Other ECS ACLs have no meaning to CAS.

  5. Select Save.
  6. You can also edit the ACLs at the group level. Groups are predefined and membership in the group is automatic based on user criteria. Choose Group ACLs.
  7. Choose Add.
  8. Select the group you want to edit from the Group Name list.
  9. Edit the ACLs and select Save.
Back to Top

ECS REST APIs that support CAS users

Describes ECS REST API resources that you can use to manage CAS user and profile settings.

The ECS Management REST API contains resources for managing CAS-specific data for a user.

REST API resource descriptions:

See the ECS Management REST API Reference for more information.

Back to Top