openstack/ironic
Code Issues Proposed changes

Fix some typo in servicing doc

Browse Source 
Some word refer to cleaning steps while should be servicing step.

Change-Id: I417635a0cbb8643d997bc317ad81772d411cd7bd
This commit is contained in:
Kaifeng Wang 2024-05-28 19:30:42 +08:00
parent df6342d1ab
commit a52cba727e
1 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/admin/servicing.rst
View File

@ -51,8 +51,8 @@ Executing Service Steps
In order for manual cleaning to work, you may need to configure a In order for manual cleaning to work, you may need to configure a
`Servicing Network`_. `Servicing Network`_.
Starting manual cleaning via API Starting manual servicing via API
-------------------------------- ---------------------------------
Servicing can only be performed when a node is in the ``active`` Servicing can only be performed when a node is in the ``active``
provision state. The REST API request to initiate it is available in provision state. The REST API request to initiate it is available in
@ -74,7 +74,7 @@ dictionary (JSON), in the form::
"args": {"<arg1>": "<value1>", ..., "<argn>": <valuen>} "args": {"<arg1>": "<value1>", ..., "<argn>": <valuen>}
} }
The 'interface' and 'step' keys are required for all steps. If a cleaning step The 'interface' and 'step' keys are required for all steps. If a servicing step
method takes keyword arguments, the 'args' key may be specified. It method takes keyword arguments, the 'args' key may be specified. It
is a dictionary of keyword variable arguments, with each keyword-argument entry is a dictionary of keyword variable arguments, with each keyword-argument entry
being <name>: <value>. being <name>: <value>.
@ -99,7 +99,7 @@ An example of the request body for this API::
}, },
{ {
"interface": "vendor", "interface": "vendor",
"step": "send_raw" "step": "send_raw",
"args": {"raw_bytes": "0x00 0x00 0x00 0x00"} "args": {"raw_bytes": "0x00 0x00 0x00 0x00"}
}] }]
} }
@ -119,14 +119,11 @@ The argument ``--service-steps`` must be specified. Its value is one of:
- a JSON string - a JSON string
- path to a JSON file whose contents are passed to the API - path to a JSON file whose contents are passed to the API
- '-', to read from stdin. This allows piping in the clean steps. - '-', to read from stdin. This allows piping in the service steps.
Using '-' to signify stdin is common in Unix utilities. Using '-' to signify stdin is common in Unix utilities.
Examples of doing this with a JSON string:: Examples of doing this with a JSON string::
baremetal node service <node> \
--clean-steps '[{"interface": "deploy", "step": "example_task"}]'
baremetal node service <node> \ baremetal node service <node> \
--service-steps '[{"interface": "deploy", "step": "example_task"}]' --service-steps '[{"interface": "deploy", "step": "example_task"}]'