[doc]Add manage/unmanage of shares in DHSS=True

Bug #1818758 reported by OpenStack Infra
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Shared File Systems Service (Manila)
Fix Released
Medium
Carlos Eduardo

Bug Description

https://review.openstack.org/635831
Dear bug triager. This bug was created since a commit was marked with DOCIMPACT.
Your project "openstack/manila" is set up so that we directly report the documentation bugs against it. If this needs changing, the docimpact-group option needs to be added for the project. You can ask the OpenStack infra team (#openstack-infra on freenode) for help if you need to.

commit d877b61c5e37ff012341194b8349af6f38155e5d
Author: Rodrigo Barbieri <email address hidden>
Date: Mon Jan 7 14:57:18 2019 -0200

    Add manage/unmanage of shares in DHSS=True

    This patch adds Manage/Unmanage of share servers in
    Manila. It also updates the Manage Share API to accept
    a "share_server_id" parameter, and updates Unmanage
    of Share and Snapshots API to allow unmanaging of
    shares and snapshots in DHSS=True.

    Managed share servers are not deleted automatically
    by manila, and if a single share is unmanaged in
    DHSS=True, the respective share server will not be
    deleted automatically as well.

    Managing share servers require that the driver
    implements 2 functions:
    - get_share_server_network_info: obtain IPs from
      share server.
    - manage_server: perform required operations to
      manage and return dict of backend_details.

    Unmanaging share servers require that the driver
    overrides unmanage_server function.

    The IPs obtained from the backend are validated
    by the Network plugin, so ports with the exact
    IPs must exist in the subnet and admin subnet
    associated with the share network specified
    when managing the share server (unless
    StandaloneNetworkPlugin is used).

    It is recommended to rename the backend resource
    if possible when managing the share server, to
    prevent issues with re-managing a share server
    that has already been managed.

    This patch bumps the API microversion to 2.49.

    APIImpact
    DocImpact

    Depends-On: I17c74b2aa242918188eeff368232c762a4b31093
    Partially-implements: bp manage-unmanage-with-share-servers
    Change-Id: I108961e7436ba13550ef2b8f02079c6e599a6166

Tags: doc manila
Jason Grosso (jgrosso)
Changed in manila:
status: New → Triaged
importance: Undecided → High
Jason Grosso (jgrosso)
summary: - Add manage/unmanage of shares in DHSS=True
+ [doc]Add manage/unmanage of shares in DHSS=True
Changed in manila:
assignee: nobody → Carlos Eduardo (silvacarlose)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to manila (master)

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

Changed in manila:
assignee: Carlos Eduardo (silvacarlose) → Goutham Pacha Ravi (gouthamr)
Changed in manila:
assignee: Goutham Pacha Ravi (gouthamr) → Carlos Eduardo (silvacarlose)
Changed in manila:
assignee: Carlos Eduardo (silvacarlose) → Goutham Pacha Ravi (gouthamr)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to manila (master)

Reviewed: https://review.openstack.org/647973
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=5cd643785d81784d61e4d9b49ff0707ff5dd4ed9
Submitter: Zuul
Branch: master

commit 5cd643785d81784d61e4d9b49ff0707ff5dd4ed9
Author: Goutham Pacha Ravi <email address hidden>
Date: Tue Mar 26 18:42:44 2019 -0700

    [doc][api-ref] Clarify manage/unmanage APIs

    Clarify the usage of these APIs wrt DHSS=True/False
    drivers.

    Partial-Bug: #1818758
    Partial-Bug: #1760644
    Change-Id: I0fb239a44dee5b2c8da1d469ae761e780d14b4b2

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/642099
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=3fe22863dba723ee189520c248a36587371b0275
Submitter: Zuul
Branch: master

commit 3fe22863dba723ee189520c248a36587371b0275
Author: silvacarloss <email address hidden>
Date: Tue Feb 19 09:38:52 2019 -0300

    Add api-ref for manage/unmanage with DHSS=True

    This patch updates the manila api-ref adding content to the
    manage/unmanage of share servers with DHSS=True feature.

    Partial-Bug: #1818758
    Change-Id: Ia63762df5cfb2c4b47cf59186ceb571b4c79c31b

Changed in manila:
assignee: Goutham Pacha Ravi (gouthamr) → Carlos Eduardo (silvacarlose)
milestone: none → train-2
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.opendev.org/657414
Committed: https://git.openstack.org/cgit/openstack/manila/commit/?id=408348b5a47968822752260117e93b7a86b5d86a
Submitter: Zuul
Branch: master

commit 408348b5a47968822752260117e93b7a86b5d86a
Author: silvacarloss <email address hidden>
Date: Thu Apr 25 16:49:50 2019 -0300

    Add admin ref for manage/unmanage servers DHSS=True

    This patch updates the Manila admin reference adding information
    for the feature manage/unmanage of share servers with DHSS=True
    driver mode, introduced in Stein release.

    Partial-Bug: #1818758
    Change-Id: Idac30b5e79cba9352f421654a1a94054dd1ba110

Changed in manila:
importance: High → Medium
Revision history for this message
Goutham Pacha Ravi (gouthamr) wrote :

Hi Carlos,

Is there any other documentation you intended to add wrt this feature? If not, let's close this bug as "Fix Released". I see the following documentation:

API reference: https://docs.openstack.org/api-ref/shared-file-system/#share-servers
Administrator Guide: https://docs.openstack.org/manila/latest/admin/shared-file-systems-share-server-management.html

The specification calls for an update to the developer reference update as well: http://specs.openstack.org/openstack/manila-specs/specs/stein/manage-unmanage-with-share-servers.html#documentation-impact

I think the driver interface doc-strings added suffice, what do you think?

Revision history for this message
Carlos Eduardo (silvacarlose) wrote :

Hi, Goutham! Sorry I took too long to answer to this question. I agree with you. I think this suffice and the bug could be closed.

Douglas Viroel (dviroel)
Changed in manila:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.