User guide was not migrated to the nova repo

Bug #1714017 reported by Pavlukhin Max
16
This bug affects 2 people
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
In Progress
Medium
Matt Riedemann
Pike
In Progress
Medium
Matt Riedemann
OpenStack Heat
Fix Released
Medium
Zane Bitter

Bug Description

A number of the documents that were previously provided as part of the user guide are missing from the nova documentation.

# Provide user data to instances

There is one link to this article in Heat Documentation. We can see it on this page:

  https://docs.openstack.org/heat/latest/glossary.html

(Refer to the the 'User data' item. This link is called ' User data (OpenStack End User Guide)')

The source for this file is here:

  https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli.rst

# Config drive

The compute API reference refers to it though in the "config_drive" parameter for the "Create Server" action:

  https://developer.openstack.org/api-ref/compute/#create-server

(Refer to the "Read more in the OpenStack End User Guide." link).

The source for this file is here:

  https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-config-drive.rst

Revision history for this message
Pavlukhin Max (mpavlukhin) wrote :

The Link to the Lost Article Screenshot

Changed in nova:
assignee: nobody → Pavlukhin Max (mpavlukhin)
Changed in heat:
assignee: nobody → Pavlukhin Max (mpavlukhin)
Changed in python-novaclient:
assignee: nobody → Pavlukhin Max (mpavlukhin)
Sean Dague (sdague)
Changed in nova:
status: New → Confirmed
importance: Undecided → Medium
Revision history for this message
Pavlukhin Max (mpavlukhin) wrote :

It seems that documentation is being rewritten now. This changes will affect the structure of the OpenStack documentation.

I found an article that can replace the 'Provide user data to instance' article partially.
Link to this article (to 'User data' item):
https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/server.html#cmdoption-openstack-server-create-user-data

I pointed this link in this review to another bug:
https://review.openstack.org/#/c/498835/

Changes: https://review.openstack.org/#/c/498835/4/doc/source/glossary.rst

Thank you for attention!

Revision history for this message
Rico Lin (rico-lin) wrote :

Not sure why heat was listed here, so mark it as an opinion for now. We surely welcome any improvement with document, but it's not a bug IMO.

Changed in heat:
status: New → Opinion
Revision history for this message
Takashi Natsume (natsume-takashi) wrote :

Set the status "In Progress" because this report has an assignee.

Changed in nova:
status: Confirmed → In Progress
Changed in python-novaclient:
status: New → In Progress
summary: - The 'Provide user data to instances' article was lost in the current
- Nova Documentation
+ User guide was not migrated to the nova repo
description: updated
Revision history for this message
Stephen Finucane (stephenfinucane) wrote :

Marking the python-novaclient component as invalid as these docs belong in the nova tree alone

Changed in python-novaclient:
status: In Progress → Invalid
Revision history for this message
Matt Riedemann (mriedem) wrote :

I don't see any nova proposed changes for this and I'd like to see this fixed sooner than later so we can backport to stable/pike. Is someone working on this?

Since we want to backport the docs fix to stable/pike, I'd suggest doing this in two steps:

1. Migrate the user guide docs to the nova repo in their current form so they are easy to backport to stable/pike.

2. Then on the master branch only, cleanup the docs, e.g. the config drive doc has both user and admin information in it that could be split up into user and admin docs.

no longer affects: python-novaclient
Matt Riedemann (mriedem)
Changed in nova:
assignee: Pavlukhin Max (mpavlukhin) → nobody
status: In Progress → Confirmed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

Changed in nova:
assignee: nobody → Matt Riedemann (mriedem)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
Matt Riedemann (mriedem) wrote :

I've got changes up for two pages: config-drive and user-data

These are the others that I see missing which are related to nova:

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-access-instance-through-a-console.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-change-the-size-of-your-server.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-delete-an-instance.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-launch-instances.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-manage-instances-hosts.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-manage-ip-addresses.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-nova-configure-access-security-for-instances.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-nova-launch-instance-from-image.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-nova-launch-instance-from-volume.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-nova-launch-instance-using-ISO-image.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-reboot-an-instance.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-stop-and-start-an-instance.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-use-snapshots-to-migrate-instances.rst

https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/configure-access-and-security-for-instances.rst (NOTE: this one seems very redundant with cli-nova-configure-access-security-for-instances.rst)

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to heat (master)

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

Changed in heat:
assignee: Pavlukhin Max (mpavlukhin) → Matt Riedemann (mriedem)
status: Opinion → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (stable/pike)

Fix proposed to branch: stable/pike
Review: https://review.openstack.org/515053

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

Fix proposed to branch: stable/pike
Review: https://review.openstack.org/515054

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/514723
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=59bd2f6adc1777c7c8d7a2f442be965fecb573a0
Submitter: Zuul
Branch: master

commit 59bd2f6adc1777c7c8d7a2f442be965fecb573a0
Author: Matt Riedemann <email address hidden>
Date: Tue Oct 24 11:51:47 2017 -0400

    Import the config drive docs from openstack-manuals

    As part of the docs migration from openstack-manuals to
    nova in the pike release we missed the config-drive docs.

    This change does the following:

    1. Imports the config-drive doc into the user guide.
    2. Fixes a broken link to the metadata service in the doc.
    3. Removes a note about liberty being the current release.
    4. Adds a link in the API reference parameters to actually
       point at the document we have in tree now, which is
       otherwise not very discoverable as the main index does
       not link to this page (or the user index for that matter).

    Partial-Bug: #1714017
    Closes-Bug: #1720873

    Change-Id: I1d54e1f5a1a94e9821efad99b7fa430bd8fece0a

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

Reviewed: https://review.openstack.org/514738
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=3fc85389e5e500e25cebf4d89094e7d06bf63605
Submitter: Zuul
Branch: master

commit 3fc85389e5e500e25cebf4d89094e7d06bf63605
Author: Matt Riedemann <email address hidden>
Date: Tue Oct 24 12:19:24 2017 -0400

    Import user-data page from openstack-manuals

    This imports the "provide-user-data-to-instances" page
    from the old openstack-manuals user guide.

    Since we don't have a glossary, the :term: link is removed
    and replaced with just giving the glossary definition as
    the first part of the doc.

    Change-Id: Iae70d9b53d6cefb3bcb107fe68499cccb71fc15e
    Partial-Bug: #1714017

Rico Lin (rico-lin)
Changed in heat:
importance: Undecided → Medium
milestone: none → queens-3
Changed in heat:
assignee: Matt Riedemann (mriedem) → Zane Bitter (zaneb)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to heat (master)

Reviewed: https://review.openstack.org/514761
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=9a5252ae6ed3f49ec8bd59032c9374b3cb77f78e
Submitter: Zuul
Branch: master

commit 9a5252ae6ed3f49ec8bd59032c9374b3cb77f78e
Author: Matt Riedemann <email address hidden>
Date: Tue Oct 24 12:51:45 2017 -0400

    docs: fix user-data end user guide link

    The user-data doc has moved out of the openstack-manuals
    repo and into the nova docs, so this updates the link.

    Change-Id: I6fac7128f8c099deaea31b3834cab0e472bc10fe
    Closes-Bug: #1714017

Changed in heat:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/heat 10.0.0.0b3

This issue was fixed in the openstack/heat 10.0.0.0b3 development milestone.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/540048
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=4ed5e81ee0a7df28547d87e28f2eabe395d4737d
Submitter: Zuul
Branch: master

commit 4ed5e81ee0a7df28547d87e28f2eabe395d4737d
Author: Matt Riedemann <email address hidden>
Date: Thu Feb 1 12:27:59 2018 -0500

    Migrate "launch instance" user guide docs

    This imports the "launch instance" end user guide docs from
    the openstack-manuals repo. As part of the docs migration
    in Pike, these were forgotten. The copied contents come from
    the stable/ocata branch of openstack-manuals, and therefore
    likely need some updating, but that could be done in follow up
    changes. This is an initial import to (1) publish the content
    again somewhere and (2) fix broken links in the cinder docs
    for booting from volume.

    Change-Id: Ie039322660fd0e2e0403843448379b78114c425b
    Partial-Bug: #1714017
    Related-Bug: #1711267

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (stable/pike)

Fix proposed to branch: stable/pike
Review: https://review.openstack.org/540495

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (stable/pike)

Reviewed: https://review.openstack.org/540495
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=2d49eb8e4f5aaff88ee7288d4fadd07c0e2e499d
Submitter: Zuul
Branch: stable/pike

commit 2d49eb8e4f5aaff88ee7288d4fadd07c0e2e499d
Author: Matt Riedemann <email address hidden>
Date: Thu Feb 1 12:27:59 2018 -0500

    Migrate "launch instance" user guide docs

    This imports the "launch instance" end user guide docs from
    the openstack-manuals repo. As part of the docs migration
    in Pike, these were forgotten. The copied contents come from
    the stable/ocata branch of openstack-manuals, and therefore
    likely need some updating, but that could be done in follow up
    changes. This is an initial import to (1) publish the content
    again somewhere and (2) fix broken links in the cinder docs
    for booting from volume.

    Conflicts:
          doc/source/index.rst

    NOTE(mriedem): The conflict is due to not having change
    Ia57c93ef1e72ccf134ba6fc7fcb85ab228d68a47 in pike.

    Change-Id: Ie039322660fd0e2e0403843448379b78114c425b
    Partial-Bug: #1714017
    Related-Bug: #1711267
    (cherry picked from commit 4ed5e81ee0a7df28547d87e28f2eabe395d4737d)

tags: added: in-stable-pike
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/515053
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=2c77e4f7c48e8d3984400169bfb1b60ee7004032
Submitter: Zuul
Branch: stable/pike

commit 2c77e4f7c48e8d3984400169bfb1b60ee7004032
Author: Matt Riedemann <email address hidden>
Date: Tue Oct 24 11:51:47 2017 -0400

    Import the config drive docs from openstack-manuals

    As part of the docs migration from openstack-manuals to
    nova in the pike release we missed the config-drive docs.

    This change does the following:

    1. Imports the config-drive doc into the user guide.
    2. Fixes a broken link to the metadata service in the doc.
    3. Removes a note about liberty being the current release.
    4. Adds a link in the API reference parameters to actually
       point at the document we have in tree now, which is
       otherwise not very discoverable as the main index does
       not link to this page (or the user index for that matter).

    Partial-Bug: #1714017
    Closes-Bug: #1720873

    Change-Id: I1d54e1f5a1a94e9821efad99b7fa430bd8fece0a
    (cherry picked from commit 59bd2f6adc1777c7c8d7a2f442be965fecb573a0)

do3meli (d-info-e)
tags: removed: docs
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

Changed in nova:
assignee: Matt Riedemann (mriedem) → Eric Fried (efried)
Eric Fried (efried)
Changed in nova:
assignee: Eric Fried (efried) → Matt Riedemann (mriedem)
Changed in nova:
assignee: Matt Riedemann (mriedem) → Stephen Finucane (stephenfinucane)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/612730
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=9de70aed23a28dca90dd3e860a5951d4e1a79e44
Submitter: Zuul
Branch: master

commit 9de70aed23a28dca90dd3e860a5951d4e1a79e44
Author: Matt Riedemann <email address hidden>
Date: Tue Oct 23 11:25:36 2018 -0400

    Migrate "reboot an instance" user guide docs

    This imports the cli-reboot-an-instance end user guide docs from
    the openstack-manuals repo [1]. As part of the docs migration
    in Pike, these were forgotten. The copied contents come from
    the stable/ocata branch of openstack-manuals [2].

    There are two minor content changes from the original:

    1. The "shutdown_timeout" config option is linked to the docs.

    2. The "nova rescue" command usage is replaced with
       "openstack server rescue".

    [1] https://docs.openstack.org/ocata/user-guide/cli-reboot-an-instance.html
    [2] https://github.com/openstack/openstack-manuals/blob/stable/ocata/doc/user-guide/source/cli-reboot-an-instance.rst

    Change-Id: I6701e43fd80fb17df5cc703df766390ab838289a
    Partial-Bug: #1714017

Matt Riedemann (mriedem)
Changed in nova:
assignee: Stephen Finucane (stephenfinucane) → Matt Riedemann (mriedem)
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Bug attachments

Remote bug watches

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