Update README.md

Update charm's README.md's according to the charm README template

Change-Id: I0b57d9d5ceb418d0adc2d1c76d476a9b6be41ef0

README.md

@@ -1,19 +1,90 @@
-Infinidat Storage Backend for Cinder
--------------------------------
+# Overview
 
-Overview
-========
+This charm implements Cinder charm subordinate that enables and configures
+the [Infinidat storage backend][infinidat-upstream] for use with
+Charmed Openstack.
 
-This charm provides a Infinidat storage backend for use with the Cinder
-charm.
+This charm is intended to work next to
+[charm-infinidat-tools][charm-infinidat-tools] which configures the environment
+for using iSCSI and FC.
 
-To use:
+> **Note**: The cinder-infinidat charm is currently in tech-preview.
 
-    juju deploy cinder
-    juju deploy cinder-infinidat
-    juju add-relation cinder-infinidat cinder
+# Configuration
 
-Configuration
-=============
+To display all configuration option information run `juju config <application>`.
+If the application is not deployed then see the charm's
+[Configure tab][charm-cinder-infinidat-configure] in the Charmhub. Finally,
+the [Juju documentation][juju-docs-config-apps] provides general guidance
+on configuring applications.
 
-See config.yaml for details of configuration options.
+# Deployment
+
+The charm can be deployed through a bundle or manually like described below:
+
+    juju deploy cinder --channel <channel>
+    juju deploy cinder-infinidat --channel <channel>
+    juju add-relation cinder-infinidat:storage-backend cinder:storage-backend
+
+# Infinidat configuration option validation
+
+The charm deploys to blocked state unless all the mandatory configuration
+options  for the Infinidat storage backend are properly set in the charm.
+Refer to [Configure tab][charm-cinder-infinidat-configure] in the Charmhub
+for more information.
+
+# TLS encryption support
+
+The charm supports configuring encrypted communication with Infinidat API and
+installation of the CA certificates.
+
+Refer to [Configure tab][charm-cinder-infinidat-configure] in the Charmhub
+for more information.
+
+# High availability
+
+The charm can be used to enable Infinidat backend in highly available
+Charmed Cinder deployments.
+
+# Deferred service events
+
+This charm supports the deferred service events feature.
+
+Operational or maintenance procedures applied to a cloud often lead to
+the restarting of various OpenStack services and/or the calling of certain charm
+hooks. Although normal, such events can be undesirable due to the service
+interruptions they can cause.
+
+The deferred service events feature provides the operator the choice of
+preventing these service restarts and hook calls from occurring, which can then
+be resolved at a more opportune time.
+
+See [Deferred service events][cg-deferred-service-events] for more
+information on this feature.
+
+# Documentation
+
+The OpenStack Charms project maintains two documentation guides:
+
+* [OpenStack Charm Guide][cg]: the primary source of information for
+  OpenStack charms
+* [OpenStack Charms Deployment Guide][cdg]: a step-by-step guide for
+  deploying OpenStack with charms
+
+# Bugs
+
+Please report bugs on [Launchpad][lp-bugs-charm-cinder-infinidat].
+
+<!-- LINKS -->
+
+[cg]: https://docs.openstack.org/charm-guide
+[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide
+[cg-deferred-service-events]: https://docs.openstack.org/charm-guide/latest/admin/deferred-events.html
+[infinidat-upstream]: https://docs.openstack.org/cinder/latest/configuration/block-storage/drivers/infinidat-volume-driver.html
+[cinder-upstream]: https://docs.openstack.org/cinder
+[cinder-charm]: https://jaas.ai/cinder
+[charm-cinder-infinidat-configure]: https://charmhub.io/charm-cinder-infinidat/configure
+[charm-infinidat-tools]: https://charmhub.io/charm-infinidat-tools
+[juju-docs-actions]: https://jaas.ai/docs/actions
+[juju-docs-config-apps]: https://juju.is/docs/configuring-applications
+[lp-bugs-charm-cinder-infinidat]: https://bugs.launchpad.net/charm-cinder-infinidat/+filebug