40d425c595
The openstack doc standard location is 'user', so go with that. Incorporate pages from the shade and occ docs into the appropriate places in the user index file. This still leaves user/logging and user/guide/logging which need to be rationalized. That will come in the next commit, as it also needs to actually rationalize the logging helper functions. Remove the Makefile, as it's not used by things. Change-Id: I26f36370ef9651f4bcaa7dee3b903309463d9592
2.9 KiB
Managing Profiles
A profile type can be treated as the meta-type of a Profile object. A registry of profile types is built when the Cluster service starts. When creating a Profile object, you will indicate the profile type used in its spec property.
List Profiles
To examine the list of profiles:
../../examples/clustering/profile.py
When listing profiles, you can specify the sorting option using the
sort parameter and you can do pagination using the
limit and marker parameters.
Full example: manage profile
Create Profile
When creating a profile, you will provide a dictionary with keys and values specified according to the profile type referenced.
../../examples/clustering/profile.py
Optionally, you can specify a metadata keyword argument
that contains some key-value pairs to be associated with the
profile.
Full example: manage profile
Find Profile
To find a profile based on its name or ID:
../../examples/clustering/profile.py
The Cluster service doesn't allow updating the spec of a
profile. The only way to achieve that is to create a new profile.
Full example: manage profile
Get Profile
To get a profile based on its name or ID:
../../examples/clustering/profile.py
Full example: manage profile
Update Profile
After a profile is created, most of its properties are immutable.
Still, you can update a profile's name and/or
metadata.
../../examples/clustering/profile.py
The Cluster service doesn't allow updating the spec of a
profile. The only way to achieve that is to create a new profile.
Full example: manage profile
Delete Profile
A profile can be deleted after creation, provided that it is not referenced by any active clusters or nodes. If you attempt to delete a profile that is still in use, you will get an error message.
../../examples/clustering/profile.py