Enable S3 Storage

Singleton Service now supports to store the translation bundle files on AWS S3.

This page will introduce the details about Singleton Service S3 build.

How to generate Singleton Service S3 build?

The steps to generate S3 build:

1. Clone Singleton Service code using Git.

git clone git@github.com:vmware/singleton.git

2. Update the complie configuration file in singleton/g11n-ws/gradle.properties

datatype=bundle

to

datatype=s3

3. Update the below s3 config items according to your requirements in singleton/g11n-ws/vip-manager-i18n/src/main/resources/application-s3.properties

#S3 store config
s3.keysEncryptEnable=true
#The decode public key file path
s3.publicKey=public.key
s3.accessKey=#####
s3.secretkey=######
s3.region=######
s3.bucketName=######

For S3 keys, you can define plain text, or encrypted text:

• Plain text: Set s3.keysEncryptEnable=false, only provide s3.accessKey and s3.secretkey;
• Encrypted text: Set s3.keysEncryptEnable=true, and refer to Enable S3 Key Encrypted for the details.

4. Complie a build using Gradle wrapper under ./gradlew build Jar files will be generated to

singleton/publish (Eg. singleton/publish/singleton-0.1.0.jar)

The translation bundle structure in AWS S3:

[bucket name]/l10n/bundles/[product name]/[version]/[component name]/messages_xx.json