Commit Graph

156 Commits

Author SHA1 Message Date
Balazs Gibizer fc3838a9b3 Change nova doc after Freenode -> OFTC move
Change-Id: I65e5ac1709d1ddbbf7a1d6b27070e676dedea186
2021-05-31 10:43:49 +02:00
Takashi Natsume eaf6a828df Update contributor guide for Xena
Change-Id: I6415e6d62eabf4c178dc3ac0a2f606403b44ebe8
Signed-off-by: Takashi Natsume <takanattie@gmail.com>
2021-04-11 07:49:08 +00:00
Zuul cd794aa538 Merge "doc: require openstack client change for every new API microversion" 2021-01-20 17:04:42 +00:00
Takashi Natsume bd0ead2d63 Add a description in the PTL guide
Add a description to update the RESI API microversion history
after milestone-3 in the PTL guide.

Change-Id: I1530f77291feda4c916cfe9c4a54de7dfdd8180f
Signed-off-by: Takashi Natsume <takanattie@gmail.com>
2020-12-13 11:28:00 +00:00
Takashi Natsume 9c0ea4a901 doc: Fix rendering in the PTL guide
Change-Id: I87c21431d8e286af793178ac934cc8f13cece523
Signed-off-by: Takashi Natsume <takanattie@gmail.com>
2020-11-25 23:14:59 +09:00
Balazs Gibizer 65fb14c36e doc: require openstack client change for every new API microversion
To avoid widening the gap between novaclient and openstack client we
require to add support for each new microversion in both clients.

Change-Id: I136cae2ea0b2f59c46d999569998e80ec5d4f24d
2020-11-16 11:25:55 +01:00
Takashi Natsume a1ec6e69fa doc: Update the PTL guide
Add a description to update the contributor guide
in the PTL guide.

Change-Id: I1e292a98ed72cf181a944c2bb20ff3a4d0bdd600
Signed-off-by: Takashi Natsume <takanattie@gmail.com>
2020-11-14 13:56:42 +09:00
Takashi Natsume bf47afd70a Update contributor guide for Wallaby
Change-Id: I8ce10c7dad73da2c2269282b9f2350a230e3aa84
Signed-off-by: Takashi Natsume <takanattie@gmail.com>
2020-11-11 12:54:35 +00:00
Balazs Gibizer aa7c6f8769 Prevent starting services with older than N-1 computes
Nova services only support computes that are not older than
the previous major release. This patch introduces a check in the
service startup that prevents staring the service if too old computes
are detected.

Change-Id: Ie15ec8299ae52ae8f5334d591ed3944e9585cf71
2020-11-04 14:05:52 +01:00
Zuul fc77e8a627 Merge "doc: Fix note directives" 2020-09-10 12:19:45 +00:00
Takashi Natsume c6ebfa45e6 doc: Fix note directives
Change-Id: I791656571926134edede9d3784bb92d46125a866
Signed-off-by: Takashi Natsume <takanattie@gmail.com>
2020-09-06 20:27:34 +09:00
Stephen Finucane 58f7582c63 docs: Remove references to XenAPI driver
Not as many of these as I thought there would be. Also, yes, the change
to 'nova.conf.compute' is a doc change :)

Change-Id: I27626984ce94544bd81d998c5fdf141875faec92
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2020-08-31 15:53:31 +01:00
Andreas Jaeger 0eb77b0ad2 Update interop repo link
Change I02ac67e333cc1a5133269bd8562f18a8d50bb036 renamed
openstack/interop to osf/interop, follow this change.

Change-Id: I43476fc0cc8f5eb2a93f75e208588f482182f3b2
2020-06-13 16:15:57 +02:00
Takashi Natsume d637b14092 Update contributor guide for Victoria
Update URLs for Victoria release.

Change-Id: I29ca3aa6e16479cd86404a6cc7cac15ec0436fe4
2020-04-27 16:28:00 +00:00
zhangbailin 9ca505700a [Trivial] FUP: addressed comments in support non-admin filter instances
This commit mainly addressed comments in [1]
[1]https://review.opendev.org/#/c/701609/9/api-ref/source/parameters.yaml@420
that were related to change Ia66d3a1ceb74ed521cf44922929b2a502f3ee935

Part of blueprint non-admin-filter-instance-by-az
Change-Id: I8627de0fdb31f2090a4eef7dba8f0f5eb4ebb946
2020-04-10 09:17:48 +00:00
Zuul e5ea915f1b Merge "[Community goal] Update contributor documentation" 2020-03-31 19:33:46 +00:00
Balazs Gibizer 612c36034b [Community goal] Update contributor documentation
As the Ussuri goal we have an OpenStack project wide contributing
documentation template [1]. Nova has its own contributor documentation
so this patch adds the new contributing.rst according to the global
template and links the sections in it to the existing Nova contributor
documentation.

Also the top level CONTRIBUTING.rst template has been changed in the
cookiecutter repo[2]. So this patch updates the CONTRIBUTING.rst according
to the new template.

[1] https://opendev.org/openstack/cookiecutter/src/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/doc/source/contributor/contributing.rst
[2] https://review.opendev.org/#/c/696001

Change-Id: Ia12cd4acbb63f192fcaf0790b72f8e977025a9dc
Story: #2007236
Task: #38541
2020-03-25 12:01:37 +00:00
Victor Coutellier 4018d6fb71 Non-Admin user can filter their instances by more filters
Microversion bump to allow non-admin user to use more filters key
when listing instances.

In order to stay coherent, all existing instance filters who are
related to a field readable by default to non admin users when showing
instance details, should be allowed by default without policy
modification.

Implements: blueprint non-admin-filter-instance-by-az

Change-Id: Ia66d3a1ceb74ed521cf44922929b2a502f3ee935
2020-03-15 17:35:49 +01:00
Zuul b8f4e46939 Merge "zuul: Remove unnecessary 'USE_PYTHON3'" 2020-01-30 17:09:07 +00:00
Riccardo Pittau f0bc7874a8 Fix typos for update_available_resource reference
Fixing a couple of typos that wrongly refers to
update_available_resources()
insted of update_available_resource()

Change-Id: Iaf7828e9cfb73ac87018d78180d16aae91d838f3
2020-01-16 10:31:06 +01:00
Zuul f25e5d0820 Merge "Update Testing NUMA documentation" 2020-01-08 16:56:01 +00:00
Victor Morales 4b6b755d86 Update Testing NUMA documentation
The document which contains the steps to test different NUMA
setups was using legacy instructions. This change pretends to update
those instructions to improve the readability.

Change-Id: Id8bf96f035528b15a51c802f06e07422b9f36736
2020-01-08 08:11:50 -08:00
Zuul d4a0f69e61 Merge "nova-net: Remove firewall support (pt. 2)" 2020-01-08 01:55:20 +00:00
Stephen Finucane 30141e6b52 nova-net: Remove firewall support (pt. 2)
Firewall support is not needed with neutron, which supports both
security groups for per-port filtering and FWaaS for per-network
filtering. Remove both the generic firewalls and the hypervisor-specific
implementations.

This change focuses on removing the firewall-related API calls from the
various virt drivers. The firewall drivers themselves are removed
separately.

Change-Id: I5a9e5532c46a5f7064441ae644125d21efe5fda1
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2020-01-06 12:46:30 +00:00
Matt Riedemann 29100f9b5a FUP for docs nits in cross-cell-resize series
Addresses review comments from:

* https://review.opendev.org/#/c/638269/63/doc/source/admin/configuration/resize.rst
* https://review.opendev.org/#/c/696212/6/doc/source/admin/configuration/cross-cell-resize.rst

Also updates contributor/resize-and-cold-migrate since that is relatively
new and biased toward same-cell resize and cold migrate. However, I chose
to link the same-cell resize glossary term to that contributor doc rather
than admin/configuration/resize because the admin doc is woefully bare.

Part of blueprint cross-cell-resize

Change-Id: I93b051252e34c8604cebea617c34e9299ac508d4
2019-12-23 10:10:57 -05:00
Zuul 2230ec836b Merge "Integrate 'pre-commit'" 2019-12-05 12:26:58 +00:00
Zuul d209dd7d52 Merge "Add sequence diagrams to resize/cold migrate contrib doc" 2019-11-29 17:02:27 +00:00
Zuul e5e0994c3a Merge "Add contributor doc for resize and cold migrate" 2019-11-29 15:20:10 +00:00
Stephen Finucane 5f8dd65f6c Integrate 'pre-commit'
This nifty tool provides a extensible way to configure pre-commit hooks
to do everything from running linters to spellchecking [1] and has
already been adopted by a few OpenStack projects [2]. Let's start using
it as a faster, more automatic alternative to the 'fast8' tox target and
iterate on it as we find more things to use it for. The 'fast8' target
is not deprecated though a note is included for end-users to alert them
to this great new tool.

Note that the 'check-executables-have-shebangs' actually failed and
highlighted that the 'contributor/development-environment.rst' document
was marked as executable when it shouldn't have been. This is corrected.

[1] https://pre-commit.com/
[2] https://review.opendev.org/#/q/file:.pre-commit-config.yaml

Change-Id: I256e75eceeb3495dce04885ca42d16adb4160cf3
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-11-28 12:46:55 +00:00
Stephen Finucane 29b9f788de docs: Blast most references to nova-network
The only ones remaining are some real crufty SVGs and references to
things that still exist because nova-network was once a thing.

Change-Id: I1aebf86c05c7b8c1562d0071d45de2fe53f4588b
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-11-27 18:26:10 +00:00
Zuul e2bba0b15e Merge "Make it easier to run a selection of tests relevant to ongoing work" 2019-11-22 20:58:18 +00:00
Matt Riedemann 49422f87d2 Add sequence diagrams to resize/cold migrate contrib doc
This adds high level sequence diagrams for the resize flows
including confirm and revert.

Change-Id: Iaca4325c9b4d7b63c5bc811bdba2db0d10db61f6
2019-11-22 15:15:38 -05:00
Matt Riedemann 1e781f6f34 Add contributor doc for resize and cold migrate
Resize and cold migrate can be confusing since they are
very similar operations and share mostly the same code paths
but there are some notable differences. This adds a contributor
doc, similar to the evacuate-vs-rebuild contributor doc, to
try and explain things at a high level and provide enough links
so contributors can follow along and see where things fit into
the puzzle.

A sequence diagram is sorely needed for this as well but that will
come in a separate change.

Change-Id: I11b401a3f874226fdc20a0ee0bd518192f70fa1d
2019-11-22 15:15:34 -05:00
Stephen Finucane 4a876df468 zuul: Remove unnecessary 'USE_PYTHON3'
The DevStack change to switch to Python 3 by default [1] has now landed,
which means we no longer need to override this in our zuul
configuration. Remove the relevant entries.

[1] https://review.opendev.org/#/c/649097/

Change-Id: I40e515cd4ddc85cd1dba613c2b5c0505e35df295
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-11-21 09:30:40 +00:00
wangfaxin 200a050182 Fix review link.
Change-Id: Ibdc333f155835f27c95d8e50d0a5fab92bbb0780
2019-11-13 15:54:53 +00:00
Matt Riedemann e619354f7c Document CD mentality policy for nova contributors
The mentality of being able to continuously deliver nova
has been around since the beginning with Rackspace public
cloud trying to CD openstack as close to master as possible.
This has implications for how code series are structured,
reviewed and merged. For the most part this seems to be tribal
knowledge and we don't have anything very obvious in the nova
docs about it, and not all projects in openstack necessarily
subscribe to this mentality anymore, or do so grudgingly, but
it's worth documenting it in nova while still applied here.

Change-Id: Ieff87dbd748318f1b7f879a136ff25081dac321e
2019-11-01 11:52:07 -04:00
Matt Riedemann c5557f03da doc: link to nova code review guide from dev policies
The development policies section on code review was linking to the
generic openstack review guidelines but we have nova-specific
guidelines as well so this changes the policies page to link to the
nova code review guidelines, links the general guidelines into the
nova page, and also fixes a formatting issue in the nova code review
guidelines page.

Change-Id: I725570d0d737f18fe8b105dc8382c4abcfdef295
2019-11-01 11:34:13 -04:00
Zuul 43248b4c92 Merge "doc: Improve PDF document structure" 2019-10-08 16:06:39 +00:00
Akihiro Motoki 152d5c359c doc: Improve PDF document structure
This is a follow-up patch for https://review.opendev.org/676730.

In the TOC of the current PDF file [1], most contents related to
user and admin guides are located under "For Contributors" section.
This is weird. It happens because the latex builder constructs
the document tree based on "toctree" directives even though they
are marked as "hidden".

This commit reorganizes "toctree" per section.
The "toctree" directives must be placed at the end of
individual sections. Otherwise, content of a last section and
content just after "toctree" directive are concatenated
into a same section in the rendered LaTeX document.

This commit also improves the following as well:

* Specify "openany" as "extraclassoptions" to skip blank pages
  along with "oneside" to use same page style for odd and even pages.
* Set "tocdepth" and "secnumdepth" to 3 respectively.
  "tocdepth" controls the depth of TOC and "secnumdepth" controls
  the level of numbered sections in TOC.

Note that this commit does not reorganize file structure under doc/source.
I believe this should be done separately.

[1] https://docs.openstack.org/nova/latest/doc-nova.pdf

Change-Id: Ie9685e6a4798357d4979aa6b4ff8a03663a9c71c
Story: 2006100
Task: 35140
2019-10-08 11:06:00 +01:00
Takashi NATSUME 6901be694c Update contributor guide for Ussuri
Update URLs for Ussuri release.
Remove some outdated descriptions.

Change-Id: Ibc3568483718da9ae4b2cf0568935cb0a86fa9fc
2019-10-07 12:24:39 +09:00
Matt Riedemann ddd7273ac3 Add evacuate vs rebuild contributor doc
People often get confused about the differences between
evacuate and rebuild operations, especially since the
conductor and compute methods are both called "rebuild_instance".
This change adds a contributor document which explains some
of the high and low level differences between the two operations.

Change-Id: I146fbc65237c4729ce3c28a4614589ba085dfce0
Closes-Bug: #1843439
2019-09-19 17:55:19 -04:00
Takashi NATSUME b244a02730 doc: Fix a broken reference link
Fix a broken reference link in
contributor/testing/zero-downtime-upgrade.rst

Change-Id: I1c0054175f9d665fecd76a03466663177c49f774
Closes-Bug: #1842985
2019-09-09 07:58:38 +09:00
Matt Riedemann 37164b418e doc: cleanup references to conductor doc
The conductor doc is not really end user material,
so this moves it under reference/, removes it from the
user page and adds it to the reference index for internals.
Also makes the contributor page link to the reference internals
since it's kind of weird to have one contributor section that
only mentions one thing but the internals under reference have
a lot more of that kind of detail. Finally, a todo is added so
we don't forget to update the reference internals about versioned
objects at some point since that's always a point of confusion
for people.

Change-Id: I8d3dbce5334afaa3e1ca309b2669eff9933a0104
2019-09-05 18:37:31 -04:00
Zuul 3b54979ae0 Merge "Switch some GitHub URLs to point to opendev.org" 2019-08-29 13:52:07 +00:00
Chris Dent 6fa5bd43fb Add a "Caveats" section to the eventlet profiling docs
There are some bits of wisdom and workarounds required to have a
positive experience when profiling in an eventlet environment.

This patch adds a section where such wisdom can accumlate, and
also provides a workaround for a specific problem when profiling
nova-compute.

Change-Id: Id6362f20c831c43e4d3316fe573e28c6b891d459
2019-08-27 11:41:31 +01:00
Adam Spiers d47f1db49e Switch some GitHub URLs to point to opendev.org
Also update some outdated URLs at the same time, e.g. defcore is now
interop.

Unfortunately unlike GitHub, gitea doesn't yet support URLs with
shortened SHA1s; however this is being worked on:

    https://github.com/go-gitea/gitea/issues/6450

Change-Id: I6e6b63619f1138cc961b61be548453361d01f73c
2019-08-19 21:08:27 +01:00
Adam Spiers 5df748b2ed Make it easier to run a selection of tests relevant to ongoing work
During development of a new git commit, locally running a whole unit
or functional test suite to check every minor code change is
prohibitively expensive.  For maximum developer productivity and
happiness, it's generally desirable to make the feedback loop of the
traditional red/green cycle as quick as possible.

So add run-tests-for-diff.sh and run-tests.py to the tools/
subdirectory, using a few tricks as explained below to help with this.

run-tests.py takes a list of files on STDIN, filters the list for
tests which can be run in the current tox virtualenv, and then runs
them with the correct stestr options.

run-tests-for-diff.sh is a simple wrapper around run-tests.py which
determines which tests to run using output from "git diff".  This
allows running only the test files changed/added in the working tree:

    tools/run-tests-for-diff.sh

or by a single commit:

    tools/run-tests-for-diff.sh mybranch^!

or a range of commits, e.g. a branch containing a whole patch series
for a blueprint:

    tools/run-tests-for-diff.sh gerrit/master..bp/my-blueprint

It supports the same "-HEAD" invocation syntax as flake8wrap.sh (as
used by the "fast8" tox environment):

    tools/run-tests-for-diff.sh -HEAD

run-tests.py uses two tricks to make test runs as quick as possible:

  1. It's (already) possible to speed up running of tests by
     source'ing the "activate" file for the desired tox virtualenv,
     e.g.

        source .tox/py36/bin/activate

     and then running stestr directly.  This saves a few seconds by
     skipping the overhead introduced by running tox.

  2. When only one test file needs to be run, specifying the -n option
     to stestr will skip the costly test discovery phase, saving
     several more valuable seconds.

Future commits could build on top of this work, harnessing a framework
such as watchdog / watchmedo[0] or Guard[1] in order to automatically
run relevant tests every time your editor saves changes to a .py file.

[0] https://github.com/gorakhargosh/watchdog - Python-based
[1] https://guardgem.org - probably best in class, but Ruby-based so
    maybe unacceptable for use within Nova.

Change-Id: I9a9bda5d29bbb8d8d77f769cd1abf7c42a18c36b
2019-08-19 17:48:39 +01:00
Chris Dent 886142b17a Add a document that describes profiling eventlet services
Profiling eventlet using services is a bit different from standard
situations so here is a document that tries to explain the basics
on how to get started doing it.

Change-Id: If8c34653285f07c5cc1abccabfec16f18daafdde
2019-08-09 11:37:41 +01:00
Zuul ab34c941be Merge "Remove deprecated Core/Ram/DiskFilter" 2019-07-23 23:36:06 +00:00
Stephen Finucane 78645e61c6 Remove deprecated Core/Ram/DiskFilter
These were deprecated during Stein [1] and can now be removed, lest they
cause hassle with the PCPU work. As noted in [1], the aggregate
equivalents of same are left untouched for now.

[1] https://review.opendev.org/#/c/596502/

Change-Id: I8a0d332877fbb9794700081e7954f2501b7e7c09
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-07-23 07:49:41 -07:00