26 Commits

Author SHA1 Message Date
liujunpeng
09eb81674b update openstackclient page url
The wiki url has been deprecated.

Change-Id: I4101b357d59661dce06519f158181982c5f96db5
2016-10-21 09:00:45 +00:00
KATO Tomoyuki
084e4fbf1b Add option markup in osc doc
To avoid unintended hyphen concatenation: "openstack –help"

Change-Id: I6e8a1c453c5964bea4adc47d167904ab8ce8abda
2016-09-25 14:15:27 +09:00
Richard Theis
6f2c1734e3 Fix --enable options on commands
The --enable option on commands is ignored when the arguments are parsed.
This is related to the --enable-beta-commands option. Renaming the option
to --os-beta-command fixes the problem.

There's no need to handle backwards compatibility for the option name
change because there hasn't been an OSC release yet with beta commands.

Change-Id: I0327ba8a2058858a83e9a42e231470ed733cc834
Closes-Bug: #1588384
2016-06-02 10:07:34 -05:00
Tang Chen
55466d8158 Trivial: Remove duplicated line in man page
Change-Id: I3f72308e639ddcdfb0289e50f9bafd097461c896
2016-06-02 12:19:08 +08:00
zhang.xiuhua
478dd64822 Modify lowercase to uppercase
Change-Id: Ia59355d824ba61da824612ea0e03243b1bec4a57
2016-06-02 09:57:21 +08:00
Richard Theis
1a2e12832d Devref: Command Beta
The devref proposes OSC support for beta commands.

Change-Id: I538a38be33734faf6eb69a3cb50946b2396b0c57
2016-04-21 12:14:42 -05:00
Dean Troyer
530fe42589 Rename --profile to --os-profile
* The --profile global option is deprecated but will be supported
  through at least April 2017.
* Update man page

Closes-bug: #1571812
Change-Id: I2e623411a56096b4cc352f4eedbf770632ae2cc3
2016-04-19 07:50:42 -05:00
Cedric Brandily
3a8320a1d7 Support client certificate/key
This change enables to specify a client certificate/key with:
 * usual CLI options (--os-cert/--os-key)
 * usual environment variables ($OS_CERT/$OS_KEY)
 * os-client-config

Change-Id: Ibeaaa5897ae37b37c1e91f3e47076e4e8e4a8ded
Closes-Bug: #1565112
2016-04-06 20:21:19 +02:00
Dina Belova
16f00833a7 Add shell --profile option to trigger osprofiler from CLI
This will allow to trigger profiling of various services that
allow it currently and which APIs support is added to openstackclient.
Cinder and Glance have osprofiler support already, Nova and Keystone
are in progress.

To use this functionality osprofiler (and its storage backend) needs
to be installed in the environment. If so, you will be able to trigger
profiling via the following command, for example:

$ openstack --profile SECRET_KEY user list

At the end of output there will be message with <trace_id>, and
to plot nice HTML graphs the following command should be used:

$ osprofiler trace show <trace_id> --html --out result.html

Related Keystone change: https://review.openstack.org/#/c/103368/
Related Nova change: https://review.openstack.org/#/c/254703/

The similar change to the keystoneclient
(https://review.openstack.org/#/c/255308/) was abandoned as new
CLI extenstions are not more accepted to python-keystoneclient.

Change-Id: I3d6ac613e5da70619d0a4781e5d066fde073b407
2016-02-25 20:13:27 +00:00
Xi Yang
54b0ef3358 Use Block Storage instead of Volume
Volume is better to be replaced by Block Storage in the
doc.

Change-Id: I736669ee01c7385b6e701cb20f4334eff1c49286
2015-11-27 17:56:10 +08:00
Daisuke Fujita
e23dd6de58 Set up every time record log in file
This will allow users to record logs of all their commands into
a predefined log file, in clouds.yaml. The log should have a
format similar to that of oslo.log.

Change-Id: I1b334bf429d575fc25809c9706fc0b11116be3f1
Implements: blueprint every-time-record-log-in-file
2015-08-08 10:02:46 -06:00
TerryHowe
36391a81a3 Rename endpoint type to interface
Change-Id: I4e21d09bc747e8210f4f79a1d6c4c7ccf2f25d1c
Closes-Bug: #1454392
2015-07-15 10:11:59 -06:00
Roxana Gherle
5521e4c504 Add --os-endpoint-type cli optional argument
User should be able to specify the endpoint type through
a CLI optional argument/ENV variable setting. We will name this new
optional argument: --os-endpoint-type (Env: OS_ENDPOINT_TYPE) and
based on the value given, the service API will use that specific
endpoint type. Possible values: public, admin, internal.

DocImpact
Closes-Bug: #1454392
Change-Id: Ife3d4e46b44c0ddcd712b1130e27e362545a9a29
2015-07-02 10:10:46 -07:00
Dean Troyer
6e7013954d Begin documenting --os-cloud
Change-Id: Id2e98ac5601840f6d380cabcd578f1a6d6d9b245
2015-04-18 23:04:53 -05:00
Zane Bitter
fb2a5492df Fix embarrassing typo in man page
Change-Id: Icf1fcd9f7952ebff9da0081ccb4b9272e17e7de4
2015-03-05 19:15:19 -05:00
Matthieu Huin
631ed3c802 Unscoped federated user-specific commands
A federated user can authenticate with the v3unscopedsaml plugin and
list the domains and projects she is allowed to scope to.
This patch introduces the new commands 'federation domain list' and
'federation project list'.
Note that for these commands -and plugin- to be available, the lxml
library must be installed.

Change-Id: I2707b624befcfb0a01b40a094e12fd68a3ee7773
Co-Authored-By: Florent Flament <florent.flament-ext@cloudwatt.com>
2014-10-30 17:27:28 +01:00
Matthieu Huin
0c77a9fe8b Support for keystone auth plugins
This patch allows the user to choose which authentication plugin
to use with the CLI. The arguments needed by the auth plugins are
automatically added to the argument parser. Some examples with
the currently available authentication plugins::

  OS_USERNAME=admin OS_PROJECT_NAME=admin OS_AUTH_URL=http://keystone:5000/v2.0 \
  OS_PASSWORD=admin openstack user list

  OS_USERNAME=admin OS_PROJECT_DOMAIN_NAME=default OS_USER_DOMAIN_NAME=default \
  OS_PROJECT_NAME=admin OS_AUTH_URL=http://keystone:5000/v3 OS_PASSWORD=admin \
  OS_IDENTITY_API_VERSION=3 OS_AUTH_PLUGIN=v3password openstack project list

  OS_TOKEN=1234 OS_URL=http://service_url:35357/v2.0 \
  OS_IDENTITY_API_VERSION=2.0 openstack user list

The --os-auth-plugin option can be omitted; if so the CLI will attempt to
guess which plugin to use from the other options.

Change-Id: I330c20ddb8d96b3a4287c68b57c36c4a0f869669
Co-Authored-By: Florent Flament <florent.flament-ext@cloudwatt.com>
2014-10-09 12:34:47 +02:00
Dean Troyer
f7357b7fe7 Update docs and release notes for 0.4.1 release
Closes-Bug: 1365505
Change-Id: I027d263ba9980715454b034a37733c5ff23fd169
2014-09-08 11:36:33 -05:00
Christian Berendt
dad5b10510 Replaced some UTF-8 characters with ASCII characters
Change-Id: Ic4e53b742f8691dd2dafe1a8d7fa45e4340a3c94
2014-07-07 19:52:48 +02:00
Jenkins
b3736fd9df Merge "Remove keyring support from openstackclient" 2014-07-04 19:45:30 +00:00
Alex Gaynor
b8f534df01 Remove keyring support from openstackclient
* The encryption it purports to offer is completely insecure.
* It also appears to be broken.

Closes-Bug: #1319381
Change-Id: Id15ecfbbfd15f142b14c125bfd85afd5032699ac
2014-07-04 01:56:18 +00:00
Matthieu Huin
5672c688d1 trust authentication
This patch enables authenticating by using a trust. The trust ID
must be set with the parameter --os-trust-id or the env variable
OS_TRUST_ID. Trusts are available for the identity v3 API.

Co-Authored-By: Florent Flament <florent.flament@cloudwatt.com>
Change-Id: Iacc389b203bbadda53ca31a7f5a9b8b6e1a1f522
2014-07-03 10:12:02 +02:00
Dean Troyer
3fa5fa5ba7 Update docs and release notes for 0.4.0
Change-Id: Iad6cfe5dee63adb9e60a0ea9811217b3175eb99c
2014-06-20 12:15:52 -05:00
Dean Troyer
038269cf7f Update release notes for 0.3.1
* update README
* update man page
* fix doc errors

Change-Id: I5682654bf482289879c8ba9016e348f2b2782971
2014-02-27 17:36:28 -06:00
Dean Troyer
4f1ebe8069 Update docs for plugins and release notes
* Fill out the existing command and man page
* Add a plugins page.
* Begin the release notes for 0.3.0

Change-Id: I4527fed28a10a9d79fc8f6c1d925a4bf0d0a7a36
2013-12-05 17:29:35 -06:00
Dean Troyer
6f9dcc13f6 Prep for 0.2 release (0.2.rc1)
* rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file
* add the barest of pointers to the wiki, etc. to the source docs
* add a bare-bones man page

Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
2013-08-01 16:21:22 -05:00