openstack/charm-cinder
Code Issues Proposed changes

Deprecate LVM support and add NetApp support

Browse Source 
Deprecate LVM support in the README and point to the
cinder-lvm charm instead. Edit config.yaml accordingly.
The CDG will soon be updated by having a page in the
'Special charm procedures' section included.

Include a section on NetApp support in the cinder-netapp
charm.

Links to the two cinder-* charms are momentarily broken.
And that's ok.

Edits according to the latest charm README template.

Change-Id: Ie4a0f337277ed14388f1b5c189efbbab568a29b7
This commit is contained in:
Peter Matulis 2021-09-29 17:30:54 -04:00
parent f32f3b735c
commit 794634a06c
2 changed files with 60 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -13,13 +13,25 @@ This section covers common and/or important configuration options. See file
default values. See the [Juju documentation][juju-docs-config-apps] for details
on configuring applications.
#### `block-device`
Specifies the storage source. Setting this option to 'None' will allow for
storage to be managed by separate charms. See sections [Ceph-backed
storage][anchor-ceph-storage], [LVM-backed storage][anchor-lvm-storage], and
[NetApp-backed storage][anchor-netapp-storage].
> **Important**: The practice of setting the `block-device` option to a local
block device is deprecated. Doing so enacts the charm's built-in support for
LVM storage. This feature will soon be removed from the charm, along with the
option's default value of 'sdb'.
#### `openstack-origin`
The `openstack-origin` option states the software sources. A common value is an
OpenStack UCA release (e.g. 'cloud:bionic-ussuri' or 'cloud:focal-victoria').
See [Ubuntu Cloud Archive][wiki-uca]. The underlying host's existing apt
sources will be used if this option is not specified (this behaviour can be
explicitly chosen by using the value of 'distro').
States the software sources. A common value is an OpenStack UCA release (e.g.
'cloud:bionic-ussuri' or 'cloud:focal-wallaby'). See [Ubuntu Cloud
Archive][wiki-uca]. The underlying host's existing apt sources will be used if
this option is not specified (this behaviour can be explicitly chosen by using
the value of 'distro').
## Deployment
@ -70,34 +82,20 @@ Proceed with a group of commands common to both scenarios:
juju add-relation cinder-mysql-router:db-router mysql-innodb-cluster:db-router
juju add-relation cinder-mysql-router:shared-db cinder:shared-db
### LVM/iSCSI-backed storage
### LVM-backed storage
Cinder can be backed by storage local to the cinder unit, where a block device
is used as an LVM physical volume. When a logical volume is created (`openstack
volume create`) it is exported to a VM via iSCSI when needed (`openstack server
add volume`).
Cinder can be backed by storage local to the cinder unit, where local block
devices are used as LVM physical volumes, and volumes are offered via iSCSI.
This functionality is provided by the [cinder-lvm][cinder-lvm-charm]
subordinate charm.
> **Note**: LVM/iSCSI is intended for testing and small Cinder deployments.
> **Note**: Built-in support for LVM in the cinder charm is deprecated.
A sample `cinder.yaml` file's contents:
### NetApp-backed storage
```yaml
cinder:
block-device: sdc
```
> **Important**: Make sure the designated block device exists and is not
currently in use.
Deploy Cinder:
juju deploy --config cinder.yaml cinder
Proceed with the common group of commands from the Ceph scenario.
> **Note**: It has been reported that the LVM storage method may not properly
initialise the physical volume and volume group. See bug
[LP #1862392][lp-bug-1862392].
Cinder can be backed by a NetApp appliance local to the cinder unit, where
volumes are offered via iSCSI or NFS. This functionality is provided by the
[cinder-netapp][cinder-netapp-charm] subordinate charm.
## High availability
@ -153,8 +151,8 @@ Alternatively, configuration can be provided as part of a bundle:
This section covers Juju [actions][juju-docs-actions] supported by the charm.
Actions allow specific operations to be performed on a per-unit basis. To
display action descriptions run `juju actions cinder`. If the charm is not
deployed then see file `actions.yaml`.
display action descriptions run `juju actions --schema cinder`. If the charm is
not deployed then see file `actions.yaml`.
* `openstack-upgrade`
* `pause`
@ -187,12 +185,18 @@ Here are the essential commands (filenames are arbitrary):
See [Policy overrides][cdg-policy-overrides] in the [OpenStack Charms
Deployment Guide][cdg] for a thorough treatment of this feature.
# Documentation
The OpenStack Charms project maintains two documentation guides:
* [OpenStack Charm Guide][cg]: for project information, including development
and support notes
* [OpenStack Charms Deployment Guide][cdg]: for charm usage information
# Bugs
Please report bugs on [Launchpad][lp-bugs-charm-cinder].
For general charm questions refer to the [OpenStack Charm Guide][cg].
<!-- LINKS -->
[cg]: https://docs.openstack.org/charm-guide
@ -204,8 +208,13 @@ For general charm questions refer to the [OpenStack Charm Guide][cg].
[lp-bug-1862392]: https://bugs.launchpad.net/charm-cinder/+bug/1862392
[cdg-ha-apps]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-ha.html#ha-applications
[hacluster-charm]: https://jaas.ai/hacluster
[cinder-lvm-charm]: https://jaas.ai/cinder-lvm
[cinder-netapp-charm]: https://jaas.ai/cinder-netapp
[upstream-cinder]: https://docs.openstack.org/cinder/latest/
[juju-docs-config-apps]: https://juju.is/docs/configuring-applications
[wiki-uca]: https://wiki.ubuntu.com/OpenStack/CloudArchive
[percona-cluster-charm]: https://jaas.ai/percona-cluster
[mysql-innodb-cluster-charm]: https://jaas.ai/mysql-innodb-cluster
[anchor-ceph-storage]: #ceph-backed-storage
[anchor-lvm-storage]: #lvm-backed-storage
[anchor-netapp-storage]: #netapp-backed-storage

21
config.yaml
View File

@ -57,10 +57,13 @@ options:
type: string
default: sdb
description: |
The block devices on which to create LVM volume group.
Set to 'None' for deployments whose storage is managed by separate
charms (cinder-lvm, cinder-netapp, ceph-mon).
.
May be set to None for deployments that will not need local
storage (eg, Ceph/RBD-backed volumes).
The below LVM functionality is DEPRECATED. Use the cinder-lvm charm
instead.
.
The block devices on which to create LVM volume group.
.
This can also be a space-delimited list of block devices to attempt
to use in the cinder LVM volume group - each block device detected
@ -77,18 +80,27 @@ options:
type: string
default: "false"
description: |
The below LVM functionality is DEPRECATED. Use the cinder-lvm charm
instead.
.
If true, charm will attempt to overwrite block devices containing
previous filesystems or LVM, assuming it is not in use.
remove-missing:
type: boolean
default: False
description: |
The below LVM functionality is DEPRECATED. Use the cinder-lvm charm
instead.
.
If True, charm will attempt to remove missing physical volumes from
volume group, if logical volumes are not allocated on them.
remove-missing-force:
type: boolean
default: False
description: |
The below LVM functionality is DEPRECATED. Use the cinder-lvm charm
instead.
.
If True, charm will attempt to remove missing physical volumes from
volume group, even when logical volumes are allocated on them. This
option overrides 'remove-missing' when set.
@ -96,6 +108,9 @@ options:
type: string
default:
description: |
The below LVM functionality is DEPRECATED. Use the cinder-lvm charm
instead.
.
Cloud instances provide ephemeral storage which is normally mounted
on /mnt.
.