j-arun / cf-s3-demo

Basic demo using S3 as a user-provided service

CF S3 Demo

This is a simple example of using Amazon S3 (or a different S3-compatible service) for asset storage. It is an image catalog to which you can upload images and see them on the main page.

Running Locally

• Create a file called application.yml in src/main/resources. It should have the following structure (replace the values with those appropriate for your environment):

s3:
  aws_access_key: your-aws-access-key
  aws_secret_key: your-aws-secret-key
  region: the-region-where-your-buckets-are
  bucket: the-bucket-name-you-want-to-use
  endpoint: s3-compatible-endpoint (optional)
  base-url: public-base-url-for-uploaded-objects (optional)
  path-style-access: true-or-false (optional, default: false)
mysql:
  driver: com.mysql.jdbc.Driver
  url: jdbc:mysql://localhost:3306/mysql_db
  username: mysql_db
  password: mysql_pw</code></pre>

• Assemble the app.

$ ./gradlew assemble

• Run it.

$ java -jar build/libs/cf-s3-demo.jar

• Browse to http://localhost:8080

Running on Cloud Foundry

Assuming you already have an account at http://run.pivotal.io:

• Create a ClearDB service.

$ cf create-service cleardb spark mysql-service

• Create a user-provided service, making sure its name begins with "s3". It should have the following credentials (assign values appropriate for your environment):
  • accessKey
  • secretKey
  • region
  • bucket
  • endpoint (optional)
  • baseUrl (optional)
  • pathStyleAccess (optional, default: false)

$ cf create-user-provided-service s3-service -p '{"accessKey":"1234","secretKey":"5678","region":"us-west-1","bucket":"cf-s3-bucket"}'

• Compile the app.

$ ./gradlew assemble

• Push it to Pivotal Cloud Foundry. It will fail because services are not bound yet.

$ cf push cf-s3-123 -p build/libs/cf-s3-demo.jar

• Bind services to the app.

$ cf bind-service cf-s3-123 mysql-service
$ cf bind-service cf-s3-123 s3-service

• Restage the app.

$ cf restage cf-s3-123

• Browse to the given URL (e.g. http://cf-s3-123.cfapps.io).