527fe5f2aa
Update charm's README.md's according to the charm README template Change-Id: Ief4637fbc9c2b63fbac21c95c92e995d5b3c9933
91 lines
3.5 KiB
Markdown
91 lines
3.5 KiB
Markdown
# Overview
|
|
|
|
This subordinate charm when deployed delivers tools and configuration automation
|
|
for the iSCSI and multipathing, specifically for Infinidat clients, running on
|
|
Linux.
|
|
|
|
The tools installed are scscitools, multipath-tools-boot
|
|
[host-power-tools][host-power-tools] as well as
|
|
[Infinidat package repository][infinidat-pkg-repo]. When deployed, the charm
|
|
applies fixes recommended by the `infinihost settings check` tool to
|
|
the environment it is deployed to. See also 'run-infinidat-settings-check'
|
|
action.
|
|
|
|
Typical principal charms for this charm are
|
|
[charm-nova-compute][charm-nova-compute] and [charm-cinder][charm-cinder].
|
|
|
|
> **Note**: The infinidat-tools 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-infinidat-tools-configure] in the Charmhub. Finally, the
|
|
[Juju documentation][juju-docs-config-apps] provides general guidance on
|
|
configuring applications.
|
|
|
|
# Deployment
|
|
|
|
The charm should be related to Cinder and Nova units in order to prepare the
|
|
environment for using Infinidat.
|
|
|
|
An example of how the charm can be added to an existing Charmed Openstack
|
|
deployment is provided below:
|
|
|
|
juju deploy infinidat-tools --channel <channel>
|
|
juju add-relation cinder:juju-info infinidat-tools:juju-info
|
|
juju add-relation nova-compute:juju-info infinidat-tools:juju-info
|
|
|
|
## 'run-infinidat-settings-check' action
|
|
|
|
The charm allows to re-run the `infinihost settings check` any time after that.
|
|
|
|
# High availability
|
|
|
|
This charm can be related to highly available Charmed Cinder deployments
|
|
and multiple Nova-compute units.
|
|
|
|
# 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-infinidat-tools].
|
|
|
|
<!-- 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://charmhub.io/cinder
|
|
[charm-infinidat-tools-configure]: https://charmhub.io/charm-infinidat-tools/configure
|
|
[charm-infinidat-tools]: https://charmhub.io/charm-infinidat-tools
|
|
[infinidat-pkg-repo]: https://repo.infinidat.com/home/main-stable
|
|
[juju-docs-actions]: https://charmhub.io/docs/actions
|
|
[juju-docs-config-apps]: https://charmhub.io/docs/configuring-applications
|
|
[lp-bugs-charm-infinidat-tools]: https://bugs.launchpad.net/charm-infinidat-tools/+filebug
|