Cloud Foundry Service Broker for EMC ECS Object Storage
Java
Latest commit d25b958 Jul 6, 2016 @spiegela spiegela committed on GitHub Merge pull request #66 from emccode/ecs-cf-service-broker-65
quota format is "warn" not "warning"
Permalink
Failed to load latest commit information.
gradle/wrapper
src
.gitignore
.travis.yml
LICENSE
README.md
build.gradle
gradlew
gradlew.bat
manifest.yml.default

README.md

ECS Cloud Foundry Service Broker

Build Status Codacy Badge

Description

This service broker enables Cloud Foundry applications to create, delete and modify EMC ECS (Elastic Cloud Storage) object storage buckets & namespaces; and bind multiple applications to the same resources.

Features

This service broker supports a number of Cloud Foundry and ECS features including:

  • Create and Delete Object Storage Buckets
  • Create and Delete Object Storage Namespaces
  • Bind one or more Cloud Foundry applications to a bucket or namespace, with unique credentials and permissions for each application
  • Support quota enforced plans for buckets to limit the amount of capacity
  • Support for encryption and retention of namespaces
  • Change plans of an existing bucket
  • Browse Cloud Foundry instance and binding metadata through an internal bucket
  • Specify an ECS namespace and replication group for provisioning
  • Provide a string prefix for bucket and user names
  • Support a self-signed SSL certificate for the ECS management API
  • Configure offered services & plans through a YAML based configuration

Build

To build, make sure that you have a Java 8 runtime environment, and use Gradle.

# The ecs-simulator starts automatically when the test-suite is run
./gradlew test

# Then build the project
./gradlew assemble

Configuration

ECS Configuration

The service broker supports a number of configuration parameters that are available as environment variables or through Spring configuration. All parameters are prefixed with the broker-config. string. Default parameters point to the bundled ECS simulator. For more info, check the default config.

Parameter Default Value Required Description
managementEndpoint - true ECS management API URI (https://:)
replicationGroup - true Name (not ID) of replication group
namespace - true Default ECS Namespace name
baseUrl - false ECS Base URL name (otherwise, a default is picked)
objectEndpoint - false Override endpoint for the object endpoint
repositoryEndpoint objectEndpoint false Override endpoint for broker metadata storage
repositoryUser user false Username to authenticate to intenal bucket
username root false Username to authenticate to ECS management API
password ChangeMe false Password to authenticate to ECS management API
repositoryBucket repository false Internal bucket for metadata storage
prefix ecs-cf-broker- false Prefix to prepend to ECS buckets and users
brokerApiVersion 2.8 false Version of the CF broker API to advertise
certificate localhost.pem false ECS SSL public key cert file

If running within Eclipse, you can also set the environment variables using "Run Configuration" and "Environment" tabs.

The ECS Simulator

The ECS Simulator is helpful for ensuring that the application starts up, without actually having an ECS cluster accessible. You'll find the simulator in the test-suite. Just run this file as a Java program, and the broker will be able to initialize against the "mocked" API calls.

You can also start the simulator from the command-line:

./gradlew simulate

The simulator is also useful when running certain JUnit tests outside of the TestSuite provided. To run an individual test that references the ECS API, just start the simulator, and then execute a test.

Self-signed certificates

To load a self-signed certificate for an ECS system, just provide a PEM formatted certificate file named localhost.pem into the src/main/resources directory.

Deploying your broker

Follow the documentation to register the broker to Cloud Foundry.

End-user Broker Usage

CLoud Foundry end-users can create and bind services to their applications using the cf CLI application.

cf create-service ecs-bucket unlimited my_bucket

This creates a bucket of the ecs-bucket service with the unlimited plan and the name: my-bucket. To bind an application to this bucket:

cf bind-service my-app my-bucket

The default will give my-app "full control" of the bucket. To give a reduced set of permissions, you can provide additional configuration parameters with the -c flag:

cf bind-service my-app my-bucket -c '{"permissions": ["read", "write"]}'

Valid permissions include:

  • read
  • read_acl
  • write
  • write_acl
  • execute
  • full_control
  • privileged_write
  • delete
  • none

Broker Catalog and Plan Configuration

The service broker catalog can be configured through YAML based configuration. You can create the file manually, via PCF or another build tool. Just add a catalog section to the src/main/resources/application.yml file:

The following feature flags are supported by the bucket & namespace. All parameters are optional, and can be set at the service or plan level in the service-settings block. Parameters are observed with the following precedence: service-definition (in the catalog), plan and then in command-line parameters. While buckets don't currently support service-settings or command-line parameters for retention, this will be added soon.

Resource Parameter Default Type Description
bucket encrypted false Boolean Enable encryption of namespace
bucket access-during-outage false Boolean Enable potentially stale data during outage
bucket file-access false Boolean Enable file-access (NFS, HDFS) for bucket
bucket head-type s3 String Specify object type (s3, swift) for bucket
bucket quota* - JSON Map Quota applied to bucket
bucket binding base-url - String Base URL name for object URI
bucket binding use-ssl false Boolean Use SSL for object endpoint
bucket binding permissions - JSON List List of permissions for user in bucket ACL
namespace domain-group-admins - JSON List List of domain admins to be added to namespace
namespace encrypted false Boolean Enable encryption of namespace
namespace compliance-enabled false Boolean Enable compliance adhearance of retention
namespace access-during-outage false Boolean Enable potentially stale data during outage
namespace default-bucket-quota -1 Integer Default quota applied to bucket (-1 for none)
namespace quota* - JSON Map Quota applied to namespace
namespace retention** - JSON Map Retention policies applied to namespace
namespace binding base-url - String Base URL name for object URI
namespace binding use-ssl false Boolean Use SSL for object endpoint

* Quotas are defined with the following format: {quota: {limit: <int>, warn: <int>}}

** Retention policies are defined with the following format: {retention: {<policy name>: <seconds retained>}}

For more info, check the default config.

Broker security

By default the broker is secured with a dynamically generated password ala Spring Security. In order to register with Cloud Foundry, a user would need to view the output logs, and grab the password with each restart.

To statically set a broker password, simple add the following to the src/main/resources/application.yml file:

...
security:
  user:
    password: <password>
...

Testing

Local test suite can be run with either a live ECS platform, or using the included simulator. Configuration variables can be found and/or changed via the EcsActionTest class.

You can then run the test-suite with gradle:

/gradlew test

TODOs

Up to date tasks are on our Github issues page.