How to annotate machines
Annotations are descriptive, searchable phrases that apply only to machines. There are two types of annotations: static (always present in any machine state), and dynamic (only present in allocated or deployed states). Annotations help you identify, characterise, and inform others about your machines.
This article will help you learn:
How to work with static annotations
This subsection will help you learn:
- How to create and assign static annotations
- How to delete static annotations
- How to view static annotations
- How to work with with dynamic (workload) annotations
How to create and assign static annotations
To create and assign static annotations (a note) to a machine, follow this procedure:
- Go to the machine list and click on the machine of interest:
- This will bring up a machine summary for that machine:
- Select “Configuration” and click the “Edit” button to the right of the “Machine configuration” section:
-
Add free-form notes in the “Note” field, as desired.
-
Click “Save changes” to update the machine’s configuration.
How to delete static annotations
To delete static annotations (a note) from a machine, follow this procedure:
- Go to the machine list and click on the machine of interest:
- This will bring up a machine summary for that machine:
- Select “Configuration” and click the “Edit” button to the right of the “Machine configuration” section:
-
Edit the free-form notes in the “Note” field, as desired.
-
Click “Save changes” to update the machine’s configuration.
How to view static annotations
To view static annotations, you can follow this procedure:
- Go to the machine list and look at the machine of interest; you should see the first few characters of a note in the bottom half of the column marked “POOL/NOTE:”
- Click on the machine, which will bring up a machine summary for that machine. Switch to the configuration tab to see the full note:
How to work with dynamic (workload) annotations
This subsection will help you learn:
- How to view dynamic (workload) annotations for one machine
- How to filter on dynamic (workload) annotations
How to view dynamic (workload) annotations for one machine
To view the dynamic (workload) annotations for one machine, do the following:
-
Go to the machine list and select the machine of interest by clicking on its hyperlinked name.
-
In the machine summary that comes up, look for the “Workload Annotations” card, in the lower, right-hand corner:
How to filter on dynamic (workload) annotations
To filter machines by dynamic (workload) annotations, use the following procedure:
- Go to the machine list and select the “Filter” drop-down; open the “Workload” segment:
- Select one or more values from this list to filter the machine list by these workload annotations.