a925493257
Update charm's README.md's according to the charm README template Change-Id: I3b95696b8b707964cdad60e306fcafcfc242359e
79 lines
3.1 KiB
Markdown
79 lines
3.1 KiB
Markdown
# Overview
|
|
|
|
This charm implements Manila charm subordinate that enables and configures
|
|
the [Infinidat share backend][infinidat-shared-fs-upstream] for use with
|
|
Charmed Openstack.
|
|
|
|
> **Note**: The manila-infinidat charm is currently in tech-preview.
|
|
|
|
# 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-manila-infinidat-configure] in the Charmhub.
|
|
Finally, the [Juju documentation][juju-docs-config-apps] provides general
|
|
guidance on configuring applications.
|
|
|
|
# Deployment
|
|
|
|
The charm can be deployed through a bundle or manually like described below:
|
|
|
|
juju deploy manila --channel <channel>
|
|
juju deploy manila-infinidat --channel <channel>
|
|
juju add-relation manila-infinidat:manila-plugin manila:manila-plugin
|
|
|
|
# TLS encryption support
|
|
|
|
The charm supports configuring encrypted communication with Infinidat API and
|
|
installation of the CA certificates. Refer to
|
|
[Configure tab][charm-manila-infinidat-configure] in the Charmhub for more
|
|
information.
|
|
|
|
# High availability
|
|
|
|
The charm can be used to enable Infinidat backend in highly available
|
|
Charmed Manila deployments. Please see example overlay bundle for such
|
|
deployments in the [Manila Charm Deployment Guide][cdg-manila].
|
|
|
|
# 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-manila-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-shared-fs-upstream]: https://docs.openstack.org/manila/latest/configuration/shared-file-systems/drivers/infinidat-share-driver.html
|
|
[manila-upstream]: https://docs.openstack.org/manila
|
|
[manila-charm]: https://charmhub.io/manila
|
|
[charm-manila-infinidat-configure]: https://charmhub.io/charm-manila-infinidat/configure
|
|
[juju-docs-config-apps]: https://juju.is/docs/olm/configure-an-application
|
|
[lp-bugs-charm-manila-infinidat]: https://bugs.launchpad.net/charm-manila-infinidat/+filebug
|
|
[cdg-manila]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/manila-ganesha.html
|