55 Commits

Author SHA1 Message Date
Maari Tamm
b095429783 [OSC] Implement share network subnet commands
This patch adds the following openstack share commands:

share network subnet create
share network subnet delete
share network subnet show

Partially-implements: bp openstack-client-support
Change-Id: I4e066a982fa40b079f969e7c3ca3276d3a842074
2021-11-24 07:43:44 +00:00
archanaserver
7c8aa8efd1 [OSC] Implement Share Group Commands
Added the implementation of the share group commands to OSC.
Commands are:

- openstack share group create
- openstack share group delete
- openstack share group list
- openstack share group show
- openstack share group set
- openstack share group unset

Change-Id: I9eb31449fef4eae73f1db91f2bad133d0fe8df2e
2021-09-02 18:47:08 +00:00
Nahim Alves de Souza
92ca00cd64 Implement OSC share instance export location commands
In this patch we add openstack commands for:
- share instance export location show
- share instance export location list

Co-authored-by: Eduardo Santos <eduardo.experimental@gmail.com>
Partially-implements: bp openstack-client-support
Change-Id: Ic1b5616a363059a941caa3cce6bd2b24bd379068
2021-09-02 07:07:57 +00:00
Goutham Pacha Ravi
d40205a2f2 OSC Implementation for Share Networks
Add the following OSC commands:

 share network create
 share network list
 share network show
 share network set
 share network unset
 share network delete

Partially-implements: bp openstack-client-support
Change-Id: I6ddb2fec1d9421bfa8b11c82da5379ada80f610b
Co-Authored-By: Vida Haririan <vhariria@redhat.com>
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-09-02 00:06:59 -07:00
Vida Haririan
cc440609bd [OSC] Implement Share Limits Show command
Adding the following openstack command,
share limits show --absolute
share limits show --rate

Partially-implements: bp openstack-client-support
Co-Authored-By: Goutham Pacha Ravi <gouthampravi@gmail.com>
Change-Id: I68b98a6c3ee369be1422d2f45e75d034e68da2e0
2021-08-31 03:52:56 -04:00
silvacarloss
2f173cb150 [OSC] Implement share instance commands
Added the implementation of the share instance commands to OSC.
Commands are:

- openstack share instance delete
- openstack share instance list
- openstack share instance set
- openstack share instance show

Co-Authored-By: Luisa Amaral <luisarfamaral@gmail.com>
Partially-Implements: bp openstack-client-support
Change-Id: I8d29651d4e3a74b9ade67ea0a8f20808ca33bdc8
2021-08-27 07:46:14 -03:00
Zuul
fa1188e8ef Merge "[OSC] Add Share Snapshot Instances commands" 2021-08-26 13:52:32 +00:00
Fabio Oliveira
1d591270bd [OSC] Add Share Snapshot Instances commands
In this patch we add the following openstack share commands:

share snapshot instance list
share snapshot instance show
share snapshot instance set --status
share snapshot instance export location list
share snapshot instance export location show

Partially-implements: bp openstack-client-support

Co-Authored-By: Caique Mello <caiquemellosbo@gmail.com>
Change-Id: I7feb6219b0c684d2e88d0d077f776bfb331e3955
2021-08-25 10:15:29 -03:00
Maari Tamm
d566ecc09a [OSC] Implement Share Pools List command
This commit implements the following openstack share command:

openstack share pool list

Partially-implements: bp openstack-client-support
Change-Id: I5be047d6c81556b45773497f55323d1611c1eb48
2021-08-23 17:04:35 -07:00
Maari Tamm
fcbcf7521f [OSC] Implement Share Services Commands
In this patch we add the following openstack share commands:
share service list
share sevice set

manila service-enable command is implemented as:
openstack share service set <hostname> <binary> --enable

manila service-disable command is implemented as:
openstack share service set <hostname> <binary> --disable

Partially-implements: bp openstack-client-support
Change-Id: I41852e93fce356549ca0600b02d972742a105a38
2021-08-20 14:00:15 +00:00
Kafilat Adeleke
53275bec67 [OSC] Implement Availability Zones Command
This commit implements the following openstack share command:

openstack share availability zone list

Change-Id: I75d3c5441b82fb8f16896719544a81dd032cdd15
2021-08-19 06:35:28 +00:00
Maari Tamm
df3388677c [OSC] Implement Share Replica Commands
In this patch we add the following openstack share commands:
share replica create
share replica delete
share replica list
share replica show
share replica set
share replica promote
share replica resync

Partially-implements: bp openstack-client-support
Change-Id: I8d0542faf56e6022e3b265957132f00ce063dcd6
2021-07-06 09:39:42 +00:00
Zuul
8d71f1ee03 Merge "remove unicode from code" 2021-03-12 00:54:35 +00:00
Zuul
5285705e44 Merge "[OSC] Implement Share Revert Command" 2021-02-17 18:22:47 +00:00
Dina Saparbaeva
c225f0af79 [OSC] Implement user messages commands
In this patch the following openstack user messages
commands are added:
manila message-delete --> openstack share message delete
manila message-list --> openstack share message list
manila message-show --> openstack share message show

Partially-implements bp openstack-client-support

Change-Id: Ib1e4cca4f869d4e832e7b1814d48c838f75b42e1
2021-02-15 16:36:46 +06:00
Maari Tamm
17e5d63651 [OSC] Implement Share Revert Command
This patch adds the 'openstack share revert' command,
which implements the same functionality as 'manila revert-to-snapshot'
and can be used to revert a share to a specified snapshot.

Partially-implements bp openstack-client-support
Change-Id: I896f2bb4ae256dda637768672f833573f5c2475d
2021-01-31 18:18:40 +00:00
ashrod98
c7bcec2969 Implement openstack share properties show command
This commit adds openstack share show metadata command, which implements manila
metadata-show functionality.

Partially implements bp openstack-client-support.

Updated with working unit test.

Change-Id: Ibde82cf9c36be41403a0e68ecac17cb211725d84
2021-01-30 00:08:30 +00:00
Maari Tamm
3c65e6f9bf [OSC] Implement Share Export Location Commands
This commit implements the following openstack share commands:

openstack share export location show <share> <export_location>
openstack share export location list <share>

Partially-implements bp openstack-client-support

Change-Id: Ie65fdd644e7161d94947614a87933f36c1826bed
2021-01-22 06:34:05 +00:00
zhangboye
6b1a2f3ad4 remove unicode from code
Change-Id: If077ddfeb6bd782bb3c87264e86c998466941590
2021-01-03 16:02:15 +08:00
Maari Tamm
bf3e7cb716 [OSC] Implement Share Adopt & Abandon Commands
This commit adds 'openstack share adopt' and 'openstack share abandon'
commands, that implement the same functionality as 'manila manage' and
'manila unmanage' commands

Usage:
openstack share adopt <service-host> <protocol> <export-path>
openstack share abandon <share>

Partially-implements bp openstack-client-support
Change-Id: I39919d38854387af21da410849905698ad261e9f
2020-12-19 15:31:01 +00:00
Maari Tamm
f4ca71be0d Implement the first half of OSC share snapshots commands
In this patch we add openstack commands for:
share snapshot create
share snapshot delete
share snapshot show
share snapshot set
share snapshot unset
share snapshot list

Partially-implements bp openstack-client-support

Change-Id: Idfe2033016f333da0169fd032ff95bf868099f70
2020-09-10 16:52:34 +00:00
Maari Tamm
beb8409e7f Implement OSC share quota commands
In this patch we add openstack commands for:
share quota set
share quota show
share quota delete

Change-Id: I3520feec09a6c491f436809a5f620efce1b1f8c2
Partially-implements: bp openstack-client-support
2020-09-09 16:16:58 +00:00
Maari Tamm
8b74211d76 Add initial documentation for OSC
This patch creates initial documentation for OSC, with
general plugin information and a few examples.
New commands, that are implemented, should be then
referenced in doc/source/cli/osc/v2/index.rst

Change-Id: I6fa9fcb3cf41a2992a4b5c7b38c54825106e9ce5
Partially-implements: bp openstack-client-support
2020-07-03 20:27:53 +00:00
Andreas Jaeger
1721e2871d Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_name to use 'project' as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I1d02403727831c29f3a38cfc11949325614ac7d0
2020-05-22 17:23:00 +00:00
Goutham Pacha Ravi
3c88e82871 [ussuri][goal] Change contributor guide
- Add a top level CONTRIBUTING.rst for
  repo browsers
- Refactor existing contributor guide
- Add a contributor/contributing.rst file
  with links back to relevant manila
  documentation.
- Rearrange some things in the main doc
  index file to make things prettier.

Change-Id: I68ea17a71c4ea1e7aac5bea1ec8b95344cb256b7
Story: #2007236
Task: #39553
Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2020-04-24 16:49:52 -07:00
Andreas Jaeger
9004a32d33 Cleanup py27 support
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg: Wheel is not needed for python
  3 only repo
- Update requirements, no need for python_version anymore
- Remove old variables from conf.py, update openstackdocstheme
  requirement.
- Remove hacking and friends from lower-constraints, they are
  not needed in installed system.

Change-Id: I179d61545169f3d329c746c88dd4d38035d4075d
2020-04-04 11:30:07 +02:00
Chris MacNaughton
c07a11194f Add more detail to API introduction
Creating a share in Manila requires an existing share-type
so this change adds a deeper usage example that includes
creation of a share-type, allowing share access to an IP
range, and demonstrates reading export_locations from a share

Change-Id: I1dd8271bed80a727901a4ee98182b4790790931e
2019-11-07 20:09:44 +08:00
Tom Barron
6c6b0bd5b2 Add PDF documentation build
Add a new tox target to build PDF documentation in accord
with the community goal [0] to have PDF docs available.

Also, only show genindex and search for HTML.  These elements
do not make sense within PDF documents.

[0] https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Change-Id: Ibbd50276c3879958b0ceb82afcc882716c01b384
2019-09-13 14:00:46 -04:00
vkmc
6ed5fa8056 Add "functional tests" documentation
Add a base set of instructions with examples
on how contributors can run the functional tests

Change-Id: Id65bac35f99483ca8fd55c645d47f4e882f6e191
Closes-Bug: #1832023
2019-06-12 19:21:23 +00:00
jacky06
5b2dc5f806 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I68e9c3428eee50b8daf6bef56d62b679779d1aee
2019-04-28 13:56:09 +08:00
Goutham Pacha Ravi
d146a345c7 Drop 'clidoc' from sphinx extensions
Replace it with program-output from
sphinxcontrib-programoutput

Depends-On: https://review.openstack.org/595480
Change-Id: I9b14af568996cc1aaefaeb4d94fe36163c6cbbf2
2018-08-23 19:21:34 -07:00
Nguyen Hung Phuong
8415a4c4e1 Clean imports in code
In some part in the code we import objects. In the Openstack style guidelines
they recommend to import only modules. [1]: "Do not import objects, only modules".

[1] https://docs.openstack.org/hacking/0.10.3/

Change-Id: If31aa24f74db73ab925f6568d3c8653228b6e9c6
2018-01-30 14:31:18 +07:00
Jenkins
49c21196bc Merge "doc-migration: new directory layout" 2017-08-26 04:28:12 +00:00
Jenkins
5ec71a315e Merge "doc migration: openstackdocstheme completion" 2017-08-26 04:28:06 +00:00
Tom Barron
6785f07e7b doc-migration: new directory layout
This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.

This is the first step in the migration process
as outlined in the spec.

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Closes-Bug: #1706181
Change-Id: I8964d066bb838fabbe94239ac108bff884c6ff76
Depends-On: I72be6303f9be77c0461eaacbc61bad8372546fb5
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-08-24 23:58:16 -04:00
junboli
767cfa6723 Add license to doc/source/conf.py
TrivialFix

Change-Id: I80f4c5373997077e4524c4efbbe6c10c5540b7a1
2017-08-22 08:36:53 +00:00
Tom Barron
f98e4f6723 doc migration: openstackdocstheme completion
This patch completes the transition from oslosphinx
to openstackdocs theme in accord with the OpenStack
manuals project migration spec [1].

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: I72be6303f9be77c0461eaacbc61bad8372546fb5
Partial-Bug: #1706181
Needed-By: I8964d066bb838fabbe94239ac108bff884c6ff76
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-08-21 10:32:53 -04:00
howardlee
450b093e64 Replace http with https
Trivialfix

Change-Id: Ia12e0afb5bc42d7fd0ff3638d5add23733f8d369
2017-07-19 18:56:26 +08:00
luke.li
7378896225 Switch from oslosphinx to openstackdocstheme
Use the new style of setting of openstackdocstheme according to follow.
https://docs.openstack.org/openstackdocstheme/latest/

Change-Id: I67b7082d9a21f39cb5b62b753f39dd56f81860cb
2017-07-06 16:27:45 +08:00
Stephen Finucane
2b97ead879 doc: Remove cruft from conf.py
Change-Id: Idfd0b9fe9def7792f9fda9d035fd4ce5ed2a67b9
2017-04-19 10:41:50 +01:00
Stephen Finucane
e19b787dd4 Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Enable this.

Change-Id: I8ea73cff6dc539c9f9db2f550ad8088812467d1b
2017-04-19 10:41:19 +01:00
melissaml
31cd7b16b1 Removes unnecessary utf-8 encoding
The following file(s) added utf-8 encoding but never used. So we can
remove them at all.

doc/source/conf.py
releasenotes/source/conf.py

Change-Id: I8ffd8ad1a9638a80696c3d0775372de5be642fbc
2017-01-05 15:07:57 +08:00
vponomaryov
60b7c5caea Fix view of doc info for functional tests
Format text for functional tests so it could be interpreted properly.

TrivialFix

Change-Id: I96d624de23993554d1515b85f2e4e1c6b6ab604d
2016-05-17 18:00:51 +03:00
Joe Gordon
281795ef75 Drop incubating theme from docs
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.

Change-Id: I9f9c70f9d6fd9156da66280183fa933f72b59d7a
2015-05-27 15:25:02 -07:00
vponomaryov
a05a48b59c Add info about functional tests run to docs
Make doc with tests description up-to-date and provide there information
that describes how to run functional tests.

Partially implements bp functional-tests

Change-Id: Iad6b1d97a9c43dd24c2c6837bb71739a6f09bb1e
2015-01-14 15:41:28 +00:00
Jenkins
35fc635556 Merge "Add manila cli help output to doc" 2014-12-12 19:39:38 +00:00
Thomas Bechtold
4faae5a7b8 Add manila cli help output to doc
Dynamically generate the cli help output and include
it into the documentation.

Change-Id: Ib56c8b28272f955924c80f0a893de71a62fc5b49
2014-12-11 23:58:54 +01:00
Jeremy Stanley
8f135629cd Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Ib50f0ff10da76e53a9b4545a1007e5425d39fd94
2014-12-05 03:30:40 +00:00
Andreas Jaeger
dc4d63e86c Improve documentation
Split up index page, remove duplicated shell information, include
other exiting files and the usual indices and tables.

Change-Id: I271c245c9d3af81e4563c489f7a5fd279fd1568e
2014-11-11 18:17:13 +01:00
Andreas Jaeger
af8a53d087 Use oslosphinx
Since manila is now an incubated project, use oslosphinx together with
the incubated theme.
Unset html_static_path since there's currently no static file and sphinx
warns otherwise.

Change-Id: Icfbf2c0ee214da870c3c711a34b6a649e9878659
2014-09-22 21:51:29 +02:00