Commit graph

66 commits

Author SHA1 Message Date
Doug Hellmann
9599ffe65d reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.

Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.

Add a few toctrees and index pages for the new directories.

Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-23 11:54:32 +02:00
Jenkins
3fabbe9b39 Merge "Create server with security group ID and name" 2017-05-22 23:09:02 +00:00
Rui Chen
45496feee6 Create server with security group ID and name
Both resource ID and name are supported to identify an object
in openstackclient to make user easy to input, for security group,
nova only support security group name in API when launch a new server,
this patch convert ID to name, then pass name to nova API, and check
the security group exist before creating server.

Change-Id: I1ed4a967fb9de3f91c8945a1ef63f6c7b6b2dfb2
Closes-Bug: #1687814
2017-05-22 20:32:01 +00:00
Rui Chen
7a7bb06377 Make block-device-mapping more stable and clear
The patch fix the following issues:

1. ValueError is raised if input don't contain "=". Sometimes the whole
"server create" command is very complex, it's difficult to find out root
reason directly.
2. Don't support to add block device from snapshot, like:
--block-device-mapping
vdb=0c8ae9d8-cadc-4a23-8337-4254614d277e:snapshot:1, it's supported by
novaclient, but not in osc.
3. If input "vdb=", not add any mapping information, the server will be
launched successfully, not raise error message to let use add
volume/snapshot id, just ignore "--block-device-mapping" option.
4. The help message of "block-device-mapping" option is so simple, need
to add some details about how to add <type>, <delete_on_terminate>
contains.

Change-Id: Ib7f7a654c3dc2a8272545f168b4c4ced230ce39e
Depends-On: Ib37913891bbf7a31b570404c4668c490d5ac859b
Closes-Bug: #1667266
2017-05-17 01:42:12 +00:00
Jenkins
7977f7df18 Merge "Add --network and --port to server create" 2017-04-25 13:54:46 +00:00
David Rabel
8549071363 Add --network and --port to server create
--nic option is quite unhandy. It is better to have
two seperate options --network and --port to add a
network to a new server.

Change-Id: I523abdc83ca2dd4c5dd3871f8f109c2bf57c2e02
Closes-Bug: #1612898
2017-04-07 16:36:18 +02:00
Cedric Brandily
7f9814860a Enable to specify which fixed-ip to add to a vm.
This change enables to specify which fixed-ip will be added to a vm using:

 openstack server add fixed ip <vm> <network> --fixed-ip-address <ip>

This change uses interface_attach instead of add_fixed_ip[1] which is
less flexible and uses a deprecated API.

[1] https://review.openstack.org/384261

Closes-Bug: #1678140
Change-Id: I7fe4621439ef0d8dca080551ffaeb614c5a91174
2017-04-04 11:15:29 -05:00
Jenkins
c7e7f2b730 Merge "Help/docs cleanups: marker, limit, ip-address metavars" 2017-04-04 12:32:55 +00:00
Dean Troyer
1686dc54f0 Help/docs cleanups: marker, limit, ip-address metavars
Cleanup help strings and docs for clarity and to keep things consistent:
* --limit metavar should be <num-resource> to indicate what is being counted
* --marker metavar should be <resource> or <resource-id> to indicate the
  type of value being specified
* <*-ip-address> metavars should be just <ip-address> as there is no difference
  in format between fixed and floating IPs
* Move all occurances of '(name or ID)' to end of help text

Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
2017-04-04 03:56:19 +00:00
Cedric Brandily
21510ac1a9 Enable to add/remove port to/from a server
This change enables to add/remove a specific port to/from a server using
the new commands:

 openstack server add port <vm> <port>
 openstack server remove port <vm> <port>

Closes-Bug: #1678137
Change-Id: I6ee57df089235ccc1fb9d38316bd484956b1134d
2017-04-03 20:19:40 +02:00
Cedric Brandily
f5527877bb Enable to specify which vm fixed-ip to publish
This change enables to specify which vm fixed-ip will be associated to a
floating ip using:

 openstack server add floating ip <vm> <fip> --fixed-ip-address <ip>

Closes-Bug: #1624524
Change-Id: I2ddb68c5873bfed7293b0e661d1adbe111681136
2017-03-20 22:33:51 +01:00
Rui Chen
c051c5f090 Fix "server create" command failed when --nic auto or none
"auto" and "none" options was added into --nic argument of server create
command in patch https://review.openstack.org/#/c/412698/ , but that
don't work and raise internal error when execute command. The patch
fix that issue and add unit and functional tests.

Change-Id: Ia718c3bac0a5172a0cdbe9f0d97972a9346c1172
Co-Authored-By: Kevin_Zheng <zhengzhenyu@huawei.com>
Closes-Bug: #1663520
2017-02-15 14:25:37 +08:00
Dean Troyer
16aeee4303 Cleanup for 3.8.0 release
Release notes and proofreading cleanups.

Change-Id: Iddc6a64e6ea3082aa220a2465793e6f7f2aecaa9
2017-01-26 10:41:30 -06:00
jiahui.qiang
c46f9dc501 Add options to "server list" command
Add "--deleted" and "--changes-since" options to "server list" command.

Change-Id: Id94f6e5831a60b172b6cfcfca29b1d89de8db621
Closes-Bug:#1647242
2017-01-25 21:31:45 +00:00
licanwei
0948aa6aeb update server migrate '--wait' description
'Wait for resize to complete'
==>
'Wait for migrate to complete'

Change-Id: I0e08968c0132f0a8e1ef1ce2e6179001315372c3
2016-12-30 14:16:32 +08:00
Kevin_Zheng
ff18e3d0e9 Should support 'auto' and 'none' as network parameter when boot instances
Nova added support using 'auto' and 'none' as network parameters since
microversion 2.37:
http://git.openstack.org/cgit/openstack/nova/tree/nova/api/openstack/rest_api_version_history.rst#n389
we should also add support for this in OSC.

Change-Id: I6e5f616dfa48895ebd13144effe9fda7cb94c649
Closes-bug: #1651288
2016-12-22 10:01:02 +00:00
Huanxuan Ao
97c0b4bf15 Fix all missing "os to openstack" transformation
Checked and fix all missing of the review:
https://review.openstack.org/#/c/412669/
https://review.openstack.org/#/c/412673/
https://review.openstack.org/#/c/412678/

Change-Id: Ice85958874121eeb574d0b4cfa58e1590b014ed6
2016-12-21 10:29:38 +08:00
Kevin_Zheng
446e6f2fa8 change os in command example to openstack(3)
In the current doc, the command examples are like
"os server create" but the acutal command should
be started with "openstack" instead of "os", it
is misleading to first time users.

Change-Id: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
2016-12-20 09:26:15 +08:00
zhengsenyan
1e895f3286 fix one spelling mistake and two help messages
I checked all the 70 rst files in doc/source/command-objects and
found that:
 -one spelling mistake as:rescure should be rescue(server.rst)
 -two help messages:xpvnc should be xvpvnc(console-url.rst and
  console.py)

Change-Id: I6f46c79983eaf5650bd3aa0ab448c19f5c6527a9
2016-07-07 14:19:04 +08:00
Tang Chen
179ebe6d64 Transfer "ip fixed add/remove" to "server add/remove fixed ip"
This patch does the following things to transfer
"ip fixed add/remove" to "server add/remove fixed ip":
* Add new command "server add/remove fixed ip", and unit
  tests and doc.
* Deprecate "ip fixed add/remove" command.

compute/v2/fixedip.py is not removed because the arguments'
positions are different between the new and old commands.
* ip fixed add <network> <server>
  server add fixed ip <server> <network>
* ip fixed remove <ip-address> <server>
  server remove fixed ip <server> <ip-address>

Change-Id: Ica07ccf92a76c21fd5608ecaff86ff7c4d96f5a0
Implements: blueprint rework-ip-commands
Partial-bug: 1555990
Co-Authored-By: Dean Troyer <dtroyer@gmail.com>
2016-07-04 10:41:30 +08:00
Tang Chen
d1f9ea3f75 Transfer "ip floating add/remove" to "server add/remove
floating ip"

This patch does the following things to transfer
"ip floating add/remove" to "server add/remove floating ip":
* Add new command "server add/remove floating ip", and unit
  tests and doc.
* Deprecate "ip floating add/remove" command.

compute/v2/floatingip.py is not removed because the arguments'
positions are different between the new and old commands.
* ip floating add <ip-address> <server>
  server add floating ip <server> <ip-address>
* ip floating remove <ip-address> <server>
  server remove floating ip <server> <ip-address>

Change-Id: Ic0dd22ca6fb7b7bc3e820fd5a14d7c551e7ab963
Implements: blueprint rework-ip-commands
Partial-bug: 1555990
Co-Authored-By: Dean Troyer <dtroyer@gmail.com>
2016-07-04 10:40:59 +08:00
Rui Chen
1a7284f63a Support to set server state
When a server is unexpected state, OSC don't support reset
the server to active or error state, that's supported by
novaclient, and it's an important command for operators, the
patch implement this function.

Change-Id: I3e7800feb192832b0719ef9a353945beb6bfd509
Implements: blueprint server-reset-state
2016-05-28 18:55:50 +08:00
Tang Chen
32c627eaf0 Doc: Unify repeatable option comments
There are lots of "this option can be repeated" comments
in the doc, which are not consistent to other similar
docs.

This patch changes them to the following format:

"repeat option to do something"

Change-Id: I54e01053091c428bf87bb36bb95f73a0b80ab6e7
2016-04-12 15:57:17 +08:00
Rui Chen
ee621509be Fix "server unset" document issue
Fix "--property" option describe issue in "server unset"
document, and update the help message to keep consistent.

Change-Id: I68022a187e83fad6320365400ad2a1b0c8cf9a61
2016-03-23 14:45:04 +08:00
Stephen Finucane
13e2bb9b96 Trivial: Use 'SSH' rather than 'Ssh'
This is reflected in the '--help' screen.

Change-Id: Ic22a65ff6a56b069b37a0ea8365cce2b3f93621c
2016-03-09 14:55:55 +00:00
jichenjc
6902a288f8 [compute] Support restore server
Server in soft-delete state can be restored, add this command.

Change-Id: Id9d7246f89ae65273505f36dcb664996534ae986
2016-02-23 13:43:37 +08:00
xiexs
6b3583ab06 Add support for triggering an crash dump
The triggering crash dump feature is supported by nova [1] and
novaclient [2] now, it's time to introduce this feature into
OSC correspondingly.

[1]The change id is: I6ed777ff637254b4b79417008f9055dd19fc7405
[2]The change id is: If03b1864bbe7074c720b946fc2700bd5d07debc3

Change-Id: I5a411f283fdf0fc3c00380d069848a332c799cdd
Closes-Bug: #1538372
Co-Authored-By: Tang Chen <chen.tang@easystack.cn>
2016-02-05 21:48:41 +08:00
David Moreau Simard
a526777218 Make --image parameter optional in "server rebuild"
The command will now default to the image currently in-use by
the server, effectively making the --image parameter optional.

This commit also adds basic tests for ServerRebuild since there
wasn't any. Will add more full tests for it.

Change-Id: I733fd3ad5a825f06563c72aa430122e1a0e3b3b0
Closes-bug: #1524406
Co-Authored-By: David Moreau Simard <dms@redhat.com>
Co-Authored-By: Tang Chen <tangchen@cn.fujitsu.com>
2015-12-11 15:34:26 +08:00
Jenkins
e93e1493b6 Merge "Trivial: Improve doc for "server create" command" 2015-12-05 09:14:43 +00:00
Tang Chen
ca76260bf8 Trivial: Improve doc for "server create" command
The following options of "server create" command support searching
by both name and ID. So add this info into doc.

--image, --volume, --flavor, --security.

Change-Id: I93b167da58144e5de6c9996009b7ea2449fb4cd8
2015-12-04 11:51:15 +08:00
Jenkins
4ed9e88078 Merge "Support "server list" searching by both image name and ID." 2015-12-03 20:36:59 +00:00
Jenkins
c39b720f00 Merge "Support "server list" searching by both flavor name and ID." 2015-12-03 20:36:48 +00:00
Tang Chen
6cea1e0463 Trivial: Reorder doc of "server shelve" command to keep alphabetic order.
Change-Id: I616154a8c958b6980233014c7ae1c4544283d72d
2015-12-04 00:21:32 +08:00
Tang Chen
106f928cb6 Support "server list" searching by both image name and ID.
Nova API only supports list servers searching by image ID.
In OSC, we can support both image name and ID by mapping
the name to ID.

This patch also fix the inconsistent doc in .py and .rst files.

Closes-Bug: 1521492

Change-Id: I70613843f82d74732bd32a457cd4a31aba57825f
2015-12-01 06:59:22 +00:00
Tang Chen
0069a01967 Support "server list" searching by both flavor name and ID.
Nova API only supports list servers searching by flavor ID.
In OSC, we can support both flavor name and ID by mapping
the name to ID.

This patch also fix the inconsistent doc in .py and .rst files.

Partial-Bug: 1521492

Change-Id: I1d1a6aa91aef4e2846745babe8382481185fa96e
2015-12-01 06:59:08 +00:00
Jenkins
b221f2ceac Merge "Add --limit option to "server list" command." 2015-12-01 03:00:52 +00:00
Tang Chen
43c11c356b Add --limit option to "server list" command.
This option will limit the total amount of items the command will list up.

Change-Id: I46af0d479d795ebb6a74585d0f76629dd940b117
2015-12-01 10:12:58 +08:00
Tang Chen
b36b477e81 Add --marker option to "server list" command.
This option will give user a chance to display the server list
from wherever they want.

Change-Id: I92cca5e98cd473f1113a9106eb9d1f490694b1fe
2015-12-01 09:30:43 +08:00
Jenkins
e63de0db2d Merge "Add --marker option to "server list" command." 2015-11-30 18:58:14 +00:00
xiexs
af5dbf72c4 Add "openstack server unshelve" into OSC
The unshelve operation is not supported by OSC,
and this patch tries to add it.

Change-Id: Ic60a4616cb63ad21c1a3c8e02611da8bad3a8bd0
Implements: blueprint introduce-shelve-into-osc
2015-11-28 11:21:05 +08:00
Jenkins
13dfacc5ff Merge "Add "openstack server shelve" into OSC" 2015-11-24 23:23:30 +00:00
Tang Chen
bfa223f615 Enable "openstack server resume" command to take multiple servers.
Current "openstack server resume" command could only resume one server.
Improve it to be able to handle more than one servers. Also improve
the doc to reflect the new feature.

Change-Id: I726eb86bfa3df3a9911f45770e6641264dbc1e0b
Implements: blueprint cmd-with-multi-servers
2015-11-24 18:54:03 +08:00
Tang Chen
4955117dff Enable "openstack server suspend" command to take multiple servers.
Current "openstack server suspend" command could only suspend one server.
Improve it to be able to handle more than one servers. Also improve
the doc to reflect the new feature.

Change-Id: Ic0417ee28f46c9198a35744c0180342e61966b26
Implements: blueprint cmd-with-multi-servers
2015-11-24 18:47:26 +08:00
xiexs
a41a8c42af Add "openstack server shelve" into OSC
Currently, the shelve operation is not supported by OSC.
So, this patch attempts to add it into OSC.

Change-Id: I92545300bef006a069338168d2de800e8a58af69
Implements: blueprint introduce-shelve-into-osc
2015-11-24 00:40:26 -05:00
Tang Chen
91fbb0e136 Enable "openstack server unlock" command to take multiple servers.
Current "openstack server unlock" command could only unlock one server.
Improve it to be able to handle more than one servers. Also improve the
doc to reflect the new feature.

Change-Id: Ibf57b2021a504da950a491d63139a438087aed0b
Implements: blueprint cmd-with-multi-servers
2015-11-13 11:02:01 +08:00
Tang Chen
c1f0ad6d71 Enable "openstack server lock" command to take multiple servers.
Current "openstack server lock" command could only lock one server.
Improve it to be able to handle more than one servers. Also improve
the doc to reflect the new feature.

Change-Id: Ifcf103b1c32e6c547ac09f688b887b1c03f92b09
Implements: blueprint cmd-with-multi-servers
2015-11-13 10:36:22 +08:00
Tang Chen
90d86ef01c Enable "openstack server unpause" command to take multiple servers.
Current "openstack server unpause" command could only unpause one server.
Improve it to be able to handle more than one servers. Also improve the
doc to reflect the new feature.

Change-Id: I069ebdd6dcd121f6e55c2bf40d42197f93830e0c
Implements: blueprint cmd-with-multi-servers
2015-11-13 10:36:16 +08:00
Jenkins
4a76b4dd51 Merge "Trivial cleanup: Use plural format for "server delete" doc." 2015-11-10 03:40:18 +00:00
Tang Chen
c9756667ce Trivial cleanup: Use plural format for "server delete" doc.
Change-Id: I4dca25f1933d5925db443eca75f602a39a833413
2015-11-10 16:28:25 +08:00
Tang Chen
a337f664d2 Enable "openstack server pause" command to take multiple servers.
Current "openstack server pause" command could only pause one server.
Improve it to be able to handle more than one servers. Also improve
the doc to reflect the new feature.

Change-Id: I809f77f0720457c9cdc1028a70b391c75885984c
Implements: blueprint cmd-with-multi-servers
2015-11-09 04:27:45 +00:00