nova/releasenotes/notes/user-settable-server-description-89dcfc75677e31bc.yaml
Chuck Carmack 4841cab03e REST API changes for user settable server description
This patches adds changes to the Nova REST API to allow
users to create a server with a description, rebuild
a server with a description, update the description,
and get the description in the server details.

Note: Future commits will be done to support the server
description in python-novaclient and openstack-client.

APIImpact

Implements blueprint: user-settable-server-description

Change-Id: I74b1a340c5ab98fdea2186e87dd13f42ce7c7661
2016-01-25 21:33:30 +00:00

17 lines
640 B
YAML

---
features:
- In Nova Compute API microversion 2.19, you can
specify a "description" attribute when creating, rebuilding, or updating
a server instance. This description can be retrieved by getting
server details, or list details for servers.
Refer to the Nova Compute API documentation for more
information.
Note that the description attribute existed in prior
Nova versions, but was set to the server name by Nova,
and was not visible to the user. So, servers you
created with microversions prior to 2.19 will return
the description equals the name on server details
microversion 2.19.