[RFE] Add tags to neutron resources

[Gal Sagie]

In most popular REST API interfaces, objects in the domain model can be
"tagged" with zero or more simple strings. These strings may then be used
to group and categorize objects in the domain model.

Neutron resources in current DB model do not contain any tags, and
dont have a generic consistent way to add tags or/and any other data
by the user.
Adding tags to resources can be useful for management and
orchestration in OpenStack, if its done in the API level
and IS NOT backend specific data.

The following use cases refer to adding tags to networks, but the same
can be applicable to any other Neutron resource (core resource and router):

1) Ability to map different networks in different OpenStack locations
   to one logically same network (for Multi site OpenStack)

2) Ability to map Id's from different management/orchestration systems to
   OpenStack networks in mixed environments, for example for project Kuryr,
    map docker network id to neutron network id

3) Leverage tags by deployment tools

spec : https://review.openstack.org/#/c/216021/

[Eugene Nikanorov (enikanorov)]

That looks like a bluepring, not a bug.
Could you file it for the next release?

[Gal Sagie (gal-sagie)]

This is an RFE request as part of Neutron new process, which is described here:

https://github.com/openstack/neutron/blob/master/doc/source/policies/blueprints.rst#neutron-request-for-feature-enhancements

Did i do it wrong somehow?

The spec is also written, and the Neutron drivers team should set the release, its obviously not for Liberty...

[Armando Migliaccio (armando-migliaccio)]

Discussion has been going on in a number of venues, and there's positive reaction to the use of tagging for 3rd party projects to use (rather than plugins/drivers themselves).

[Hirofumi Ichihara (ichihara-hirofumi)]

I have introduced the implementation[1] as PoC in order to confirm the spec is fine and reasonable in neutron. I found some gaps between spec and implementation but I believe that it's easy to bridge the gaps. I will clear up PoC code and then introduce some patches for the feature.

[1]: https://review.openstack.org/#/c/273881/

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/278197

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/284519

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/284519
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=0ae3c172ae4a7f80df5473ed53b8424ea408c583
Submitter: Jenkins
Branch: master

commit 0ae3c172ae4a7f80df5473ed53b8424ea408c583
Author: Hirofumi Ichihara <email address hidden>
Date: Thu Feb 25 12:26:57 2016 +0900

    Make API framework more flexible for various extensions

    This patch adds a function to Neutron extension mechanism
    so that we can add API methods to "/resources" path rather than
    "/resources/action" path.

    This patch also allow extentions to control correspondences
    between action and status in API request.

    Change-Id: I862086f7528583e65d7bee794f011ddff6ae8901
    Partial-Implements: blueprint add-tags-to-core-resources
    Related-Bug: #1489291

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/273881
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=ec1457dd7503626c917031ce4a16a366fe70c7bb
Submitter: Jenkins
Branch: master

commit ec1457dd7503626c917031ce4a16a366fe70c7bb
Author: Hirofumi Ichihara <email address hidden>
Date: Tue Mar 1 11:05:56 2016 +0900

    Add tag mechanism for network resources

    Introduce a generic mechanism to allow the user to set tags
    on Neutron resources. This patch adds the function for "network"
    resource with tags.

    APIImpact
    DocImpact: allow users to set tags on network resources

    Partial-Implements: blueprint add-tags-to-core-resources
    Related-Bug: #1489291
    Change-Id: I4d9e80d2c46d07fc22de8015eac4bd3dacf4c03a

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/278197
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=7fb8d542efab555e2e3b466fe9a04fb77d836c02
Submitter: Jenkins
Branch: master

commit 7fb8d542efab555e2e3b466fe9a04fb77d836c02
Author: Hirofumi Ichihara <email address hidden>
Date: Tue Mar 1 11:57:36 2016 +0900

    Add filter for resource tag

    Introduce a generic mechanism to allow the user to get
    Neutron resources with tag filter.

    APIImpact

    Change-Id: I1e5b25fea268e188cc9620c72b3c71004b197512
    Partial-Implements: blueprint add-tags-to-core-resources
    Related-Bug: #1489291

[Armando Migliaccio (armando-migliaccio)]

@Hirofumi, coding for this effort looks complete to me. Can you confirm?

[Armando Migliaccio (armando-migliaccio)]

Also, can I get you to confirm [1]

[1] https://review.openstack.org/#/c/286413/13/specs/mitaka/postmortem/postmortem.rst@257

[Armando Migliaccio (armando-migliaccio)]

And lasty: what about bug 1552487? Is there any pending patch you're working on?

[Hirofumi Ichihara (ichihara-hirofumi)]

I'm preparing documents now. It takes some times because I'm beginner about api-site development ;)

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/292204

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/293839

[OpenStack Infra (hudson-openstack)]

Change abandoned by Armando Migliaccio (<email address hidden>) on branch: master
Review: https://review.openstack.org/293839
Reason: This review is > 4 weeks without comment, and failed Jenkins the last time it was checked. We are abandoning this for now. Feel free to reactivate the review by pressing the restore button and leaving a 'recheck' comment to get fresh test results.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/292204
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=a348c389583a0b7a9c48ed5a7cbc4ae734b766ee
Submitter: Jenkins
Branch: master

commit a348c389583a0b7a9c48ed5a7cbc4ae734b766ee
Author: Hirofumi Ichihara <email address hidden>
Date: Tue Aug 16 19:53:19 2016 +0900

    Add API test for tag

    This patch adds api test for tag.

    Change-Id: I87aba26534db179f0744ddee982251e8e1834638
    Partial-Implements: blueprint add-tags-to-core-resources
    Related-Bug: #1489291

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/413662

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/414500

[OpenStack Infra (hudson-openstack)]

Change abandoned by Dongcan Ye (<email address hidden>) on branch: master
Review: https://review.openstack.org/414500
Reason: duplicated with: https://review.openstack.org/#/c/413662/

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/newton
Review: https://review.openstack.org/470335

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/470335
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=d48e5c7575bc4fe786cfbdca2b88060eec905015
Submitter: Jenkins
Branch: stable/newton

commit d48e5c7575bc4fe786cfbdca2b88060eec905015
Author: Hirofumi Ichihara <email address hidden>
Date: Tue Aug 16 19:53:19 2016 +0900

    Add API test for tag

    This patch adds api test for tag.

    Change-Id: I87aba26534db179f0744ddee982251e8e1834638
    Partial-Implements: blueprint add-tags-to-core-resources
    Related-Bug: #1489291
    (cherry picked from commit a348c389583a0b7a9c48ed5a7cbc4ae734b766ee)