TripleO should create Cinder default volume type

[Alan Bishop]

Cinder supports multiple volume types, and every Cinder volume is supposed to be associated with a volume type. Cinder does allow volumes to be created without a volume type, but this can lead to problems later in the volume's life cycle (for example, when retyping or migrating the volume to another backend).

Here is an example showing a volume created with no associated volume type (3rd row from bottom of the table).

(overcloud) [stack@undercloud ~]$ openstack volume create --size=1 vol
+---------------------+--------------------------------------+
| Field | Value |
+---------------------+--------------------------------------+
| attachments | [] |
| availability_zone | nova |
| bootable | false |
| consistencygroup_id | None |
| created_at | 2018-07-17T17:34:38.000000 |
| description | None |
| encrypted | False |
| id | cbf43df4-f9b9-47e2-9844-a80c70b08039 |
| migration_status | None |
| multiattach | False |
| name | vol |
| properties | |
| replication_status | None |
| size | 1 |
| snapshot_id | None |
| source_volid | None |
| status | creating |
| type | None |
| updated_at | None |
| user_id | 578ad27ca80e4b58ac38ff82b0de6c65 |
+---------------------+--------------------------------------+

In order to avoid volume life cycle problems, TripleO should:

1) Configure the default_volume_type in /etc/cinder/cinder.conf
2) Ensure the default_volume_type is valid (i.e. the volume type exists)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/583341

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/589208

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/589208
Committed: https://git.openstack.org/cgit/openstack/puppet-tripleo/commit/?id=5e87dffbeed15756c55c397fb5962c551822336f
Submitter: Zuul
Branch: master

commit 5e87dffbeed15756c55c397fb5962c551822336f
Author: Alan Bishop <email address hidden>
Date: Mon Aug 6 10:21:53 2018 -0400

    Configure cinder's default volume type

    Add a resource that creates Cinder's default volume type. The
    cinder::type provider executes osc commands, so this is only done once
    on the bootstrap node, and at step 4 when the cinder_api service is
    running.

    Partial-Bug: #1782217
    Change-Id: Ia23996abefdd1410fb86f04ed84a314f4364339c

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/583341
Committed: https://git.openstack.org/cgit/openstack/tripleo-heat-templates/commit/?id=1433d5819f01631314dd3ea93f02583d7d5ae3eb
Submitter: Zuul
Branch: master

commit 1433d5819f01631314dd3ea93f02583d7d5ae3eb
Author: Alan Bishop <email address hidden>
Date: Tue Jul 17 14:44:26 2018 -0400

    Ensure Cinder has a default volume type

    This patch adds a CinderDefaultVolumeType parameter, and does two
    things:

    1. Configures the default_volume_type in /etc/cinder/cinder.conf
    2. Ensures the volume type exists

    The cinder::api puppet module supports configuring the default_volume_type,
    and this patch simply sets the corresponding hiera value.

    The cinder::type puppet resource is used to ensure the default volume
    type exists. This is done using docker_puppet_tasks so that it executes
    after the Cinder services are running. This is necessary because the
    cinder::type puppet provider executes osc commands.

    Closes-Bug: #1782217
    Depends-On: Ia23996abefdd1410fb86f04ed84a314f4364339c
    Change-Id: I99496aa82bb66eccd86f0e482f1fbdc656c07c5d

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/tripleo-heat-templates 9.0.0.0rc1 release candidate.

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/queens
Review: https://review.opendev.org/667129

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/queens
Review: https://review.opendev.org/667130

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/667129
Committed: https://git.openstack.org/cgit/openstack/puppet-tripleo/commit/?id=5096691354a0c2e82dba0b41e246bc37d321dc6d
Submitter: Zuul
Branch: stable/queens

commit 5096691354a0c2e82dba0b41e246bc37d321dc6d
Author: Alan Bishop <email address hidden>
Date: Mon Aug 6 10:21:53 2018 -0400

    Configure cinder's default volume type

    Add a resource that creates Cinder's default volume type. The
    cinder::type provider executes osc commands, so this is only done once
    on the bootstrap node, and at step 4 when the cinder_api service is
    running.

    Partial-Bug: #1782217
    Change-Id: Ia23996abefdd1410fb86f04ed84a314f4364339c
    (cherry picked from commit 5e87dffbeed15756c55c397fb5962c551822336f)

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/667130
Committed: https://git.openstack.org/cgit/openstack/tripleo-heat-templates/commit/?id=9450d11504a0e27724407a42e6cd2d7717ac0a75
Submitter: Zuul
Branch: stable/queens

commit 9450d11504a0e27724407a42e6cd2d7717ac0a75
Author: Alan Bishop <email address hidden>
Date: Tue Jul 17 14:44:26 2018 -0400

    Ensure Cinder has a default volume type

    This patch adds a CinderDefaultVolumeType parameter, and does two
    things:

    1. Configures the default_volume_type in /etc/cinder/cinder.conf
    2. Ensures the volume type exists

    The cinder::api puppet module supports configuring the default_volume_type,
    and this patch simply sets the corresponding hiera value.

    The cinder::type puppet resource is used to ensure the default volume
    type exists. This is done using docker_puppet_tasks so that it executes
    after the Cinder services are running. This is necessary because the
    cinder::type puppet provider executes osc commands.

    Closes-Bug: #1782217
    Depends-On: Ia23996abefdd1410fb86f04ed84a314f4364339c
    Change-Id: I99496aa82bb66eccd86f0e482f1fbdc656c07c5d
    (cherry picked from commit 1433d5819f01631314dd3ea93f02583d7d5ae3eb)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/tripleo-heat-templates 8.4.1 release.

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/815332

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/815332
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/4bf4866030c78c5f9343eb0084d72c4a03beefa7
Submitter: "Zuul (22348)"
Branch: master

commit 4bf4866030c78c5f9343eb0084d72c4a03beefa7
Author: Alan Bishop <email address hidden>
Date: Mon Oct 25 07:36:24 2021 -0700

    Clear up confusion on cinder's default volume type

    This patch clears up confusion resulting from both tripleo and
    cinder creating "default" volume types. The quotes indicate subtle
    differences in how the term is used, and how it causes confusion for
    cloud users.

    TripleO added support for configuring cinder's default volume type,
    and later cinder itself added its own support for a default volume
    type. The cinder project's motivation was to provide a volume type
    for all volumes, even when cloud administrators hadn't defined one.
    But from tripleo's perspective, cinder's volume type was redundant
    because tripleo *does* define a default volume type.

    The confusion for cloud users is that cinder chose "__DEFAULT__" for
    the name of the volume type, and "Default Volume Type" for its
    description. This is misleading because tripleo's CinderDefaultVolumeType
    is the actual default volume type.

    Clearing up the confusion depends on whether the overcloud is a green
    field deployment where no volumes have been created, or a brown field
    deployment where cinder's __DEFAULT__ type may be in use. If no volumes
    exist then it's safe for tripleo to simply delete cinder's __DEFAULT__
    type. Otherwise, the __DEFAULT__ type's description is updated so that
    it indicates the actual default type is the one established by the
    CinderDefaultVolumeType parameter.

    Lastly, CinderDefaultVolumeType is now constrained to prevent it being
    set to an empty string. That should never happen, so this is just a
    safety net.

    Related-Bug: #1782217
    Change-Id: Idf27c14b31dc077ef9a0e567bd502ed6842bd52b

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/wallaby
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/817039

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/817039
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/f10e5f2e6e43c776eef51173bc0695e8c928cdfb
Submitter: "Zuul (22348)"
Branch: stable/wallaby

commit f10e5f2e6e43c776eef51173bc0695e8c928cdfb
Author: Alan Bishop <email address hidden>
Date: Mon Oct 25 07:36:24 2021 -0700

    Clear up confusion on cinder's default volume type

    This patch clears up confusion resulting from both tripleo and
    cinder creating "default" volume types. The quotes indicate subtle
    differences in how the term is used, and how it causes confusion for
    cloud users.

    TripleO added support for configuring cinder's default volume type,
    and later cinder itself added its own support for a default volume
    type. The cinder project's motivation was to provide a volume type
    for all volumes, even when cloud administrators hadn't defined one.
    But from tripleo's perspective, cinder's volume type was redundant
    because tripleo *does* define a default volume type.

    The confusion for cloud users is that cinder chose "__DEFAULT__" for
    the name of the volume type, and "Default Volume Type" for its
    description. This is misleading because tripleo's CinderDefaultVolumeType
    is the actual default volume type.

    Clearing up the confusion depends on whether the overcloud is a green
    field deployment where no volumes have been created, or a brown field
    deployment where cinder's __DEFAULT__ type may be in use. If no volumes
    exist then it's safe for tripleo to simply delete cinder's __DEFAULT__
    type. Otherwise, the __DEFAULT__ type's description is updated so that
    it indicates the actual default type is the one established by the
    CinderDefaultVolumeType parameter.

    Lastly, CinderDefaultVolumeType is now constrained to prevent it being
    set to an empty string. That should never happen, so this is just a
    safety net.

    Related-Bug: #1782217
    Change-Id: Idf27c14b31dc077ef9a0e567bd502ed6842bd52b
    (cherry picked from commit 4bf4866030c78c5f9343eb0084d72c4a03beefa7)

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/victoria
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/819153

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/819153
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/b7019a6272a44dac278e63af48c7ec427754e5d0
Submitter: "Zuul (22348)"
Branch: stable/victoria

commit b7019a6272a44dac278e63af48c7ec427754e5d0
Author: Alan Bishop <email address hidden>
Date: Mon Oct 25 07:36:24 2021 -0700

    Clear up confusion on cinder's default volume type

    This patch clears up confusion resulting from both tripleo and
    cinder creating "default" volume types. The quotes indicate subtle
    differences in how the term is used, and how it causes confusion for
    cloud users.

    TripleO added support for configuring cinder's default volume type,
    and later cinder itself added its own support for a default volume
    type. The cinder project's motivation was to provide a volume type
    for all volumes, even when cloud administrators hadn't defined one.
    But from tripleo's perspective, cinder's volume type was redundant
    because tripleo *does* define a default volume type.

    The confusion for cloud users is that cinder chose "__DEFAULT__" for
    the name of the volume type, and "Default Volume Type" for its
    description. This is misleading because tripleo's CinderDefaultVolumeType
    is the actual default volume type.

    Clearing up the confusion depends on whether the overcloud is a green
    field deployment where no volumes have been created, or a brown field
    deployment where cinder's __DEFAULT__ type may be in use. If no volumes
    exist then it's safe for tripleo to simply delete cinder's __DEFAULT__
    type. Otherwise, the __DEFAULT__ type's description is updated so that
    it indicates the actual default type is the one established by the
    CinderDefaultVolumeType parameter.

    Lastly, CinderDefaultVolumeType is now constrained to prevent it being
    set to an empty string. That should never happen, so this is just a
    safety net.

    Related-Bug: #1782217
    Change-Id: Idf27c14b31dc077ef9a0e567bd502ed6842bd52b
    (cherry picked from commit 4bf4866030c78c5f9343eb0084d72c4a03beefa7)
    (cherry picked from commit f10e5f2e6e43c776eef51173bc0695e8c928cdfb)

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/ussuri
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/821032

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/821032
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/d0ca4fe9fe5525e6985ea13460b0992fa4c15cf4
Submitter: "Zuul (22348)"
Branch: stable/ussuri

commit d0ca4fe9fe5525e6985ea13460b0992fa4c15cf4
Author: Alan Bishop <email address hidden>
Date: Mon Oct 25 07:36:24 2021 -0700

    Clear up confusion on cinder's default volume type

    This patch clears up confusion resulting from both tripleo and
    cinder creating "default" volume types. The quotes indicate subtle
    differences in how the term is used, and how it causes confusion for
    cloud users.

    TripleO added support for configuring cinder's default volume type,
    and later cinder itself added its own support for a default volume
    type. The cinder project's motivation was to provide a volume type
    for all volumes, even when cloud administrators hadn't defined one.
    But from tripleo's perspective, cinder's volume type was redundant
    because tripleo *does* define a default volume type.

    The confusion for cloud users is that cinder chose "__DEFAULT__" for
    the name of the volume type, and "Default Volume Type" for its
    description. This is misleading because tripleo's CinderDefaultVolumeType
    is the actual default volume type.

    Clearing up the confusion depends on whether the overcloud is a green
    field deployment where no volumes have been created, or a brown field
    deployment where cinder's __DEFAULT__ type may be in use. If no volumes
    exist then it's safe for tripleo to simply delete cinder's __DEFAULT__
    type. Otherwise, the __DEFAULT__ type's description is updated so that
    it indicates the actual default type is the one established by the
    CinderDefaultVolumeType parameter.

    Lastly, CinderDefaultVolumeType is now constrained to prevent it being
    set to an empty string. That should never happen, so this is just a
    safety net.

    Related-Bug: #1782217
    Change-Id: Idf27c14b31dc077ef9a0e567bd502ed6842bd52b
    (cherry picked from commit 4bf4866030c78c5f9343eb0084d72c4a03beefa7)
    (cherry picked from commit f10e5f2e6e43c776eef51173bc0695e8c928cdfb)
    (cherry picked from commit b7019a6272a44dac278e63af48c7ec427754e5d0)

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/ussuri
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/823411

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/823411
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/d30105a28c755d826c85bccf4d02cdca2712c53b
Submitter: "Zuul (22348)"
Branch: stable/ussuri

commit d30105a28c755d826c85bccf4d02cdca2712c53b
Author: Alan Bishop <email address hidden>
Date: Fri Dec 17 12:46:34 2021 -0800

    [train,ussuri] Set cinder's __DEFAULT__ vol type description

    Update the description of cinder's internal __DEFAULT__ volume type
    so that users don't confuse it with the actual default volume type
    established by the CinderDefaultVolumeType parameter.

    This patch is a variant of Idf27c14b31dc077ef9a0e567bd502ed6842bd52b,
    which in later releases deletes cinder's __DEFAULT__ volume type if
    there are no volumes associated with it. However, the __DEFAULT__
    volume type cannot be removed prior to the victoria release because
    it's required for a DB migration.

    Lastly, CinderDefaultVolumeType is now constrained to prevent it being
    set to an empty string. That should never happen, so this is just a
    safety net.

    Change-Id: Ifc35eb09ab3af4d8f3ea232dd20558047c6834b9
    Related-Bug: #1782217

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/train
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/824001

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/824001
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/e36e3c0ee9764414db982112876e8975466b777f
Submitter: "Zuul (22348)"
Branch: stable/train

commit e36e3c0ee9764414db982112876e8975466b777f
Author: Alan Bishop <email address hidden>
Date: Fri Dec 17 12:46:34 2021 -0800

    [train,ussuri] Set cinder's __DEFAULT__ vol type description

    Update the description of cinder's internal __DEFAULT__ volume type
    so that users don't confuse it with the actual default volume type
    established by the CinderDefaultVolumeType parameter.

    This patch is a variant of Idf27c14b31dc077ef9a0e567bd502ed6842bd52b,
    which in later releases deletes cinder's __DEFAULT__ volume type if
    there are no volumes associated with it. However, the __DEFAULT__
    volume type cannot be removed prior to the victoria release because
    it's required for a DB migration.

    Lastly, CinderDefaultVolumeType is now constrained to prevent it being
    set to an empty string. That should never happen, so this is just a
    safety net.

    Change-Id: Ifc35eb09ab3af4d8f3ea232dd20558047c6834b9
    Related-Bug: #1782217
    (cherry picked from commit d30105a28c755d826c85bccf4d02cdca2712c53b)

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/837031

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/837031
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/52bf7ee056dc1404153dc6b3fb3b0673e946a29d
Submitter: "Zuul (22348)"
Branch: master

commit 52bf7ee056dc1404153dc6b3fb3b0673e946a29d
Author: Alan Bishop <email address hidden>
Date: Thu Apr 7 13:34:01 2022 -0700

    Fix CinderDefaultVolumeType constraints

    Fix the CinderDefaultVolumeType constraints so that they match
    cinder's own constraints. Basically, volume type names just need
    at least one non-whitespace character. The name can contain leading
    or trailing whitespace, but it cannot be '' (zero-length) or contain
    only whitespace characters. The error message if the constraint isn't
    met is similar to cinder's error message.

    Resolves: rhbz#2073096
    Related-Bug: #1782217
    Change-Id: Ie7db672f929b21031338fe3e20ad2dfda34c231f

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/wallaby
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/837577

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/837577
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/ab2d2f82c2575ba0908c4374f592c5f47b5b9533
Submitter: "Zuul (22348)"
Branch: stable/wallaby

commit ab2d2f82c2575ba0908c4374f592c5f47b5b9533
Author: Alan Bishop <email address hidden>
Date: Thu Apr 7 13:34:01 2022 -0700

    Fix CinderDefaultVolumeType constraints

    Fix the CinderDefaultVolumeType constraints so that they match
    cinder's own constraints. Basically, volume type names just need
    at least one non-whitespace character. The name can contain leading
    or trailing whitespace, but it cannot be '' (zero-length) or contain
    only whitespace characters. The error message if the constraint isn't
    met is similar to cinder's error message.

    Resolves: rhbz#2073096
    Related-Bug: #1782217
    Change-Id: Ie7db672f929b21031338fe3e20ad2dfda34c231f
    (cherry picked from commit 52bf7ee056dc1404153dc6b3fb3b0673e946a29d)

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/victoria
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/837648

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/837648
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/7f12c44846c2bb76afd2dd679f7d5ca3a410bffe
Submitter: "Zuul (22348)"
Branch: stable/victoria

commit 7f12c44846c2bb76afd2dd679f7d5ca3a410bffe
Author: Alan Bishop <email address hidden>
Date: Thu Apr 7 13:34:01 2022 -0700

    Fix CinderDefaultVolumeType constraints

    Fix the CinderDefaultVolumeType constraints so that they match
    cinder's own constraints. Basically, volume type names just need
    at least one non-whitespace character. The name can contain leading
    or trailing whitespace, but it cannot be '' (zero-length) or contain
    only whitespace characters. The error message if the constraint isn't
    met is similar to cinder's error message.

    Resolves: rhbz#2073096
    Related-Bug: #1782217
    Change-Id: Ie7db672f929b21031338fe3e20ad2dfda34c231f
    (cherry picked from commit 52bf7ee056dc1404153dc6b3fb3b0673e946a29d)
    (cherry picked from commit ab2d2f82c2575ba0908c4374f592c5f47b5b9533)

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/train
Review: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/837818

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/openstack/tripleo-heat-templates/+/837818
Committed: https://opendev.org/openstack/tripleo-heat-templates/commit/c39286f93c27bdeba56f1855c8bf59daef338113
Submitter: "Zuul (22348)"
Branch: stable/train

commit c39286f93c27bdeba56f1855c8bf59daef338113
Author: Alan Bishop <email address hidden>
Date: Thu Apr 7 13:34:01 2022 -0700

    Fix CinderDefaultVolumeType constraints

    Fix the CinderDefaultVolumeType constraints so that they match
    cinder's own constraints. Basically, volume type names just need
    at least one non-whitespace character. The name can contain leading
    or trailing whitespace, but it cannot be '' (zero-length) or contain
    only whitespace characters. The error message if the constraint isn't
    met is similar to cinder's error message.

    Resolves: rhbz#2073096
    Related-Bug: #1782217
    Change-Id: Ie7db672f929b21031338fe3e20ad2dfda34c231f
    (cherry picked from commit 52bf7ee056dc1404153dc6b3fb3b0673e946a29d)
    (cherry picked from commit ab2d2f82c2575ba0908c4374f592c5f47b5b9533)
    (cherry picked from commit 7f12c44846c2bb76afd2dd679f7d5ca3a410bffe)