36 Commits

Author SHA1 Message Date
Takashi Kajinami
b609c80a36 doc: Use dnf instead of yum
The yum command has been replaced by the dnf command in recent releases
of Fedora-based distributions. Use the native command instead of
the alias kept for compatibility.

Change-Id: I0a1dfdaca91164eff2c25795f66976ec70356574
2025-01-07 10:51:03 +09:00
Martin Kopec
ec07b343d2 Remove support for opensuse
We haven't been testing the distro for a while in CI, e.g. in
Tempest, the jobs on opensuse15 haven't been executed for a year
now.
Therefore the patch removes opensuse support from devstack.

Closes-Bug: #2002900
Change-Id: I0f5e4c644e2d14d1b8bb5bc0096d1469febe5fcc
2023-02-16 12:01:39 +01:00
Martin Kopec
90e5479f38 Remove forgotten LinuxMint occurrence
Right now we don't officialy support LinuxMint as our
documentation says [1], it seems LinuxMint is a relict
and got forgotten over time.

This patch removes LinuxMint from the code in order not to
confuse users.

[1] https://docs.openstack.org/devstack/latest/
Closes-Bug: #1983427

Change-Id: Ie1ced25f89389494b28a7b2e9bb1c4273e002dd5
2022-08-16 17:29:16 +02:00
Stephen Finucane
970891a4ef Remove references to XenAPI driver
The XenAPI driver was removed during the Victoria release [1], while the
libvirt+xen driver has been removed in the Wallaby release [2]. Remove
references to Xen from DevStack since its all a no-op now.

[1] I42b302afbb1cfede7a0f7b16485a596cd70baf17
[2] I73305e82da5d8da548961b801a8e75fb0e8c4cf1

Change-Id: If7055feb88391f496a5e5e4c72008bf0050c5356
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-03-05 15:10:19 +00:00
Andreas Jaeger
8dd89e52d0 Update docs building
Switch to "modern" way of building docs using sphinx-build directly,
remove now unsed parts from setup.cfg.

Upgrade to openstackdocstheme 1.20 and remove obsolete variables from
conf.py.

Convert external links to internal RST links so that Sphinx can verify
that they are correct.

Replace redirected links with new targets.

Use opendev.org instead of github.com where appropriate.

Change-Id: Iedcc008b170821aa74acefc02ec6a243a0dc307c
2019-08-11 16:15:34 +02:00
Zuul
a928853692 Merge "Update (git|review).openstack.org links to opendev" 2019-06-24 20:23:20 +00:00
Zuul
5e09df086c Merge "Install from bindep.txt in plugins" 2019-06-21 08:04:35 +00:00
Matt Riedemann
9b6d2f20b4 Update (git|review).openstack.org links to opendev
This updates links going to git.openstack.org and review.openstack.org
to go to their respective opendev locations to avoid redirects.

Change-Id: I78e3bb5303718962f591117f9c0ee11f2314b128
Closes-Bug: #1833256
2019-06-21 14:35:16 +10:00
Ian Wienand
6509fd334e Remove git:// openstack references
This updates various parts of documentation to use https, rather than
git, which is not implemented by gitea

Change-Id: I8d2a93128dcdaba0a00b43d18652781733f90cf0
Story: #2004627
Task: #29701
2019-03-04 17:26:20 +11:00
Ian Wienand
fa9aadfdd8 Install from bindep.txt in plugins
This allows plugins to specify their binary dependencies in bindep
format.

Some thinking on the implementation: this is in contrast to the
files/[deb|rpm] installation, which is called from the external
install_prereqs.sh script.  This script being an externally callable
entry-point is really an artifact of the days when we would build
snapshot images for CI and wanted to pre-cache downloads.  These days
we use the mirror system to keep packages close to CI nodes.  Thus
rather than expand install_prereqs.sh to also be installing
virtualenvs and python dependencies, this seems to fit better as a
separate internal phase of stack.sh.

Documentation is updated

Change-Id: Icbdfbf97c17c906a7ae86f43e80eb2c445816228
2019-01-16 11:14:09 +11:00
Riccardo Pittau
b3ee6f4615 Correcting typo in plugins section
Fixing the example of the plugin's name as the last component
of the git repo path should be foo.

Change-Id: I2f12d4d26993ec192517de7f5541c4219ee59ed9
2018-12-18 17:06:27 +01:00
James E. Blair
c5853ac1af Allow plugins to express dependency info
Add a no-op function, "plugin_requires" to allow plugins to indicate
their dependencies on each other.  This will be used by the Devstack
Ansible module when writing local.conf files.

Also add define_plugin to allow plugins to indicate their canonical
names.

Change-Id: Ibd8c7222ed7dfb08d7ea821d871fc6f3b88de24b
2017-11-21 16:33:23 -08:00
Chris Dent
ebbbc0500c Make reference to service-types-authority from plugins.rst
We want people creating plugins (that add services) to be aware of the
service-types-authority (STA), so this change adds a Prerequisites
section and notes the existince of the STA there, and the need to apply
there to create a service-type.

Change-Id: I1aa48fe231aaa4499f8b4fe336abea668841b9af
2017-08-16 16:37:20 +01:00
Vasyl Saienko
8e0fc9dc8e Fix doc formating
Fix formating issue in the doc/source/plugin.rst

Trivial fix.

Change-Id: Ifc9a43aebdab0c15c83485cf0b6d4133d7194a9d
2016-12-06 09:35:16 +02:00
Vasyl Saienko
04d51e4943 Fix doc formating issue
Change-Id: I9aa8c1fd114e4f4329e06ac263f337ea566d8355
2016-08-05 13:48:23 +03:00
Matthew Treinish
655c22c77f Add an explicit test-config phase to devstack plugins
This commit adds a new phase to the devstack plugin interface for
configuring test environments. It runs after everything in devstack
(except for the final output commands) to ensure that tempest or
any other dependency is installed prior to running it.

Change-Id: I52128756f18d3857963a0687de77f7cdfd11fb3e
2016-05-04 17:31:45 -04:00
Jim Rollenhagen
56632fc75d Fix override-defaults in plugin docs
Docs specify that this file should be override_defaults, when really
devstack looks for override-defaults.

Change-Id: I3900ec4d16ffb48c6969dac5081ea2817536c246
2015-12-10 05:57:19 -08:00
Deepak C Shetty
93e2499ee1 doc: document override_defaults phase
override_defaults phase was added to devstack in [1]
but documentation was pending. This patch adds the
same. For history around override_defaults, one can
refer to the mail thread [2]

Also fixes a small typo

[1]: https://review.openstack.org/#/c/167933/
[2]: http://lists.openstack.org/pipermail/openstack-dev/2015-March/059621.html

Change-Id: I1b58ca0ce0e4b85a1dbd710b4c426606fd4dcf45
2015-11-18 12:43:54 +05:30
Zhang Jinnan
9f6b542a25 change stackforge url to openstack url
beacuse of the stackforge project move to openstack project,
so change the document url to git://git.openstack.org/openstack/.

Change-Id: I1628c0aeb62ee519867fdaee56386e22978c4271
2015-10-20 11:49:18 +11:00
dieterly
bf9f9a5942 Fix typo
Change 'This' -> 'These'.

Change-Id: If2f8f92d3adbb8fe4556e5c3ec53e4da31d02d49
2015-09-21 13:24:00 -06:00
Atsushi SAKAI
2040143409 Fix four typos on devstack documentation
behaviour => behavior
mechansim => mechanism
glustfs => glusterfs
pluggin => plugin

Change-Id: I3de6740e5d4b2b55009614007767458124036b75
Closes-Bug: #1478538
2015-07-27 20:43:59 +09:00
Chris Dent
dcc8a30f2a Be more explicit about jenkins project config
In documentation like this (which is a huge boon) we should strive to be
as explicit and helpful as possible, so this change tries to be more
clear about what a project.yaml is and where one might go to create it
or change it.

Change-Id: Ia66a361fc7d79e511afa3ad903fffb122b86998b
2015-06-27 12:45:21 +00:00
Sean Dague
0124e08ede refresh the devstack plugin docs, add plugin registry
The devstack plugin docs mostly referred to in tree plugins, which is
honestly something we don't want people doing. Instead restructure the
whole document to talk about external plugins as the only kinds of
plugins, and focus on a workflow to make that easy for people to work
through.

This also adds a plugin-registry page to start listing known plugins
somewhere centrally. Some sample content was added, hopefully people
will submit patches to include their plugins.

This does drop the section on hypervisor plugins. That's not currently
something that we expect a ton of people to work on, so diving into
the code for this should be fine.

Change-Id: Ifc0b831c90a1a45daa507a009d1dcffcd6e2deca
2015-06-19 08:48:16 -04:00
Ian Wienand
51c48d4c80 Add a note on default values of globals
Add a note on default values of globals in plugin settings

Change-Id: I0d5d3a7e0597abe7e2401f8bae30ccc5682eab03
2015-03-25 21:52:14 +11:00
Jenkins
d9a7ae8056 Merge "Allow devstack plugins to specify prereq packages" 2015-03-19 00:35:34 +00:00
Adam Gandelman
7ca90cded3 Allow devstack plugins to specify prereq packages
We offer main devstack components the ability to install their own
system package preqreqs via files/{debs, rpms}/$service.  This adds
similar functionality for plugins, who can now do the same in their
own tree at ./devstack/files/{debs, rpms}/$plugin.

Change-Id: I63af8dc54c75a6e80ca4b2a96c76233a0795aabb
2015-03-11 14:46:35 -07:00
Jenkins
d8b66662d5 Merge "Document use of plugins for gate jobs" 2015-03-10 13:25:16 +00:00
Ian Wienand
db1152c96e Document use of plugins for gate jobs
Document use of plugins for gate jobs.  See also [1]

[1] http://lists.openstack.org/pipermail/openstack-dev/2015-January/054291.html

Change-Id: I9ed82f5d195511fb612517745f93f2a54475091a
2015-03-10 07:12:15 -04:00
Sean Dague
33127a1287 update plugin doc
After doing a couple of external plugins I found that basically things
don't work unless you enable_service in the settings file. Document
that as a requirement, and clean up the rest of the docs around the
external plugins to be consistent with that.

Change-Id: I13aee7dbf112ce9663e8338b555a208327f89b61
2015-02-09 15:17:27 -05:00
YAMAMOTO Takashi
b1a153ed71 plugins.rst: Fix a typo
Change-Id: I3f85166a1e0f2fea02055dae6871746ad1b8d897
2015-02-09 12:43:12 +09:00
Sean Dague
2c65e71ab8 Implement devstack external plugins
This is an initial pass at plugin infrastructure for devstack which
allows specifying an external repository via:

enable_plugin <name> <giturl> [branch]

It implements the devstack specification for this at
I173dee3d57967b1d2ffd30e4868a2832aeac97ce

Change-Id: I8e4175313b3cf0b12e981122358b1288a7eb0746
2015-01-06 12:30:25 -05:00
Sean Dague
3293046d30 use a more common rst header hiearchy
While rst doesn't actually care about the order of headers, reviewers
sometimes do. And the build in emacs mode has a certain order
specified that it can easily rotate between.

Standardize on == h1, = h2, - h3, ~ h4 in the code.

Change-Id: I80ff6df6ef0703a3c3005809069428018bb355d4
2014-11-18 06:51:16 -05:00
Dean Troyer
ea3cdfad1f Pass through the rest of the docs
Do the link cleanups and update a handful of things that were
out of date.

Change-Id: I758027bf3577c66cfb13df963516823a5c247080
2014-11-08 08:29:20 -06:00
Dean Troyer
0986a7b760 Remove old HTML headers
Change-Id: I39107df88aeb89d3364ad479d8c313b7a79b9440
2014-11-06 06:40:45 -06:00
Sean M. Collins
0f3bafc74e Remove copyright footer from RST docs
Change-Id: I2fe6aac7caec21af26983636d6ec827b3525ee15
2014-10-24 10:48:46 -04:00
Sean M. Collins
09e550c370 Convert all HTML doc to RST
The motivation for this conversion is to have DevStack's docs be
generated using a more familair workflow for OpenStack projects, using
Sphinx.

Changing from raw HTML to RST will also make it easier to contribute
more documentation, as well as making edits less of a hassle.

The majority of the work was done by using Pandoc to convert from HTML
to RST, with minor edits to the output to remove errors in Sphinx.

Change-Id: I9636017965aeade37b950ddf5bdb0c22ab9004bd
2014-10-22 12:27:00 -04:00