Remove experimental from s3 options

Remove the experimental status from the S3 options. Update the
README documentation to provide informationf or configuring the
appropriate backend to use for NFS or S3 storage.

Change-Id: I7836754529a8b5d067a86077e1e004fa2f53ec6e

src/README.md

@@ -5,7 +5,21 @@ part of the [TrilioVault Cloud Backup solution][trilio.io].
 
 # Usage
 
-TODO
+The TrilioVault Workload Manager Service relies on a database service, the
+Keystone identity service, and RabbitMQ messaging:
+
+    juju deploy trilio-wlm
+    juju deploy mysql
+    juju deploy rabbitmq-server
+    juju deploy keystone
+    juju add-relation trilio-wlm mysql
+    juju add-relation trilio-wlm rabbitmq-server
+    juju add-relation trilio-wlm keystone
+
+TrilioVault will also need to be deployed with other services in order to
+provide a fully functional TrilioVault backup solution. Refer to the
+[TrilioVault Data Protection][deployment-guide] section in the deployment
+guide for more information.
 
 # Creating trust with the Cloud Admin account
 
@@ -41,9 +55,45 @@ service.
 Alternatively this may be completed via the Horizon plugin for
 TrilioVault in the OpenStack Dashboard.
 
-# Configuration Options
+# Storage Options
 
-TODO
+TrilioVault supports NFS and S3 backends for storing workload backups. The
+storage type used by TrilioVault is determined by the value in the
+`backup-target-type` charm config option.
+
+## NFS
+
+To configure the TrilioVault Workload Manager to store backups in an NFS share,
+set the `backup-target-type` option of the charm to `nfs` and set the `nfs-shares`
+option of the charm to specify a valid NFS share.
+
+    juju config trilio-wlm backup-target-type=nfs
+    juju config trilio-wlm nfs-shares=10.40.3.20:/srv/triliovault
+
+Mount settings for the NFS shares can be configured using the `nfs-options`
+config option.
+
+The TrilioVault Data Mover application will also need to be configured to use
+the same nfs-share.
+
+## S3
+
+To configure the TrilioVault Workload Manager to store backups in an S3 share,
+set the `backup-target-type` option of the charm to `s3` and set the following
+configuration options to provide information regarding the S3 service:
+
+* `tv-s3-endpoint-url` the URL of the s3 storage
+* `tv-s3-secret-key` the secret key for accessing the s3 storage
+* `tv-s3-access-key` the access key for accessing the s3 storage
+* `tv-s3-region-name` the region for accessing the s3 storage
+* `tv-s3-bucket` the s3 bucket to use to storage backups in
+* `tv-s3-ssl-cert` the SSL CA to use when connecting to the s3 service
+
+    juju config trilio-wlm tv-s3-endpoint-url=http://s3.example.com/
+    juju config trilio-wlm tv-s3-secret-key=superSecretKey
+    juju config trilio-wlm tv-s3-access-key=secretAccessKey
+    juju config trilio-wlm tv-s3-region-name=RegionOne
+    juju config trilio-wlm tv-s3-bucket=backups
 
 # Bugs
 
@@ -51,3 +101,4 @@ Please report bugs on [Launchpad][lp-bugs-charm-trilio-wlm].
 
 [lp-bugs-charm-trilio-wlm]: https://bugs.launchpad.net/charm-trilio-wlm/+filebug
 [trilio.io]: https://www.trilio.io/triliovault/openstack
+[deployment-guide]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-trilio-vault.html

src/config.yaml

@@ -32,7 +32,7 @@ options:
     type: string
     default: nfs
     description: |
-      Type of backup target. Valid types - nfs
+      Type of backup target. Valid types - nfs, s3
   nfs-options:
     type: string
     default: nolock,soft,timeo=180,intr,lookupcache=none
@@ -63,7 +63,6 @@ options:
       scheduler will consider to trigger the missed snapshots
       The value is in seconds
       This option is ignored if Trilio is before 4.1.94
-  # UNSUPPORTED
   tv-s3-secret-key:
     type: string
     default:

src/lib/charm/openstack/trilio_wlm.py

@@ -185,11 +185,10 @@ class TrilioWLMCharm(charms_openstack.plugins.TrilioVaultCharm,
     @property
     def backup_target_type(self):
         # The main purpose of this property is to translate experimental-s3
-        # to s3 and s3 to UNKNOWN. This forces the deployer to
-        # use 'experimental-s3' for s3 support but the code can stay clean and
-        # refer to s3.
+        # to s3. This allows users who tried experimental-s3 a grace period
+        # before being pushed to s3.
         _type = hookenv.config("backup-target-type").lower()
-        if _type == 'experimental-s3':
+        if _type in ('experimental-s3', 's3'):
             return 's3'
         if _type == 'nfs':
             return 'nfs'

src/tests/bundles/bionic-train-41-s3.yaml

@@ -213,7 +213,7 @@ applications:
     options:
       openstack-origin: *openstack-origin
       triliovault-pkg-source: *triliovault-pkg-source
-      backup-target-type: experimental-s3
+      backup-target-type: s3
   ceph-mon:
     charm: cs:~openstack-charmers-next/ceph-mon
     num_units: 3