Alarms in Administrator Guide erroneous use of -a flag

[Tim Serewicz]

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [X ] This doc is inaccurate in this way:
It suggests that the use of the -a flag is necessary for the command to work. The command throws a warning saying "-a is obsolete! See help for more details." This is the particular part of the documentation that has this issue: http://docs.openstack.org/admin-guide/telemetry-alarms.html#alarm-update

- [ ] This is a doc addition request.

- [X] I have a fix to the document that I can paste below including example: input and output.

Remove the mention of the -a from the example. Following is output with the -a flag:
[root@ip-xx-31-20-51 ~(keystone_admin)]# ceilometer alarm-state-set --state ok -a ba8fc8e3-23ef-4bde-be6a-545729f4a120
-a is obsolete! See help for more details.
+----------+-------+
| Property | Value |
+----------+-------+
| state | ok |
+----------+-------+

And then without the -a:
[root@ip-xx-31-20-51 ~(keystone_admin)]# ceilometer alarm-state-set --state ok ba8fc8e3-23ef-4bde-be6a-545729f4a120
+----------+-------+
| Property | Value |
+----------+-------+
| state | ok |
+----------+-------+

I am using RDO Newton on CentOS 7.3-1611 (core), with this version of ceilometer client:
Name : python2-ceilometerclient
Arch : noarch
Version : 2.6.2
Release : 1.el7

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: http://ask.openstack.org
 - The mailing list: http://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: 0.9 on 2017-02-03 12:07
SHA: d5acec6bd1997ab14b4f5abc5b5def6be991ee67
Source: https://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/admin-guide/source/telemetry-alarms.rst
URL: http://docs.openstack.org/admin-guide/telemetry-alarms.html

[Tim Serewicz (h-tim-2)]

Same issue lower on the page with the alarm deletion using the -a flag.
http://docs.openstack.org/admin-guide/telemetry-alarms.html#alarm-deletion

[Alexandra Settle (alexandra-settle)]

Thanks! Will update asap :)

[Bernd Bausch (berndbausch)]

May I suggest to update all the commands to the openstack client at the same time?

[Alexandra Settle (alexandra-settle)]

Bernd - we have been slowly actioning this across most of the guides. I admit, there is potential still for gaps. But it's a long process :( https://wiki.openstack.org/wiki/Documentation/ReorganizeUserGuides#Legacy_to_OpenStack_command_conversion_table

[Alexandra Settle (alexandra-settle)]

Hey Joe - bringing this one to your attention :)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/430966

[Joseph Robinson (joseph-r-email)]

Thanks Alex, it looks as though the telemetry service commands (http://docs.openstack.org/cli-reference/ceilometer.html) do not have equivalent OpenStack command line commands yet - https://docs.openstack.org/developer/python-openstackclient/command-list.html. I'll add this to the table of clients yet to change.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/430966
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=f81f9bbd65ce81cda34f30f6160bc0f66a4cb706
Submitter: Jenkins
Branch: master

commit f81f9bbd65ce81cda34f30f6160bc0f66a4cb706
Author: chenxing <[e-mail]>
Date: Wed Feb 8 14:22:07 2017 +0000

    [admin-guide] Remove the obsolete flag

    Change-Id: I3d1cc550bf1bd4873d2052f02569f3bdb0cd0562
    Closes-Bug: #1661696
    Implements: blueprint use-openstack-command

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.