chore: rename 'requirement' to 'state' key for traits

Author: cardoe

docs/design-guide/flavors.md

@@ -52,7 +52,7 @@ Flavor definitions are YAML files validated against `schema/flavor.schema.json`.
     * **trait**: Trait name without `CUSTOM_` prefix (e.g., `NICX`, `GPU`, `NVME`)
         * Pattern: `^[A-Z][A-Z0-9_]*$` (uppercase alphanumeric and underscores)
         * `CUSTOM_` prefix is automatically added when interacting with Ironic
-    * **requirement**: Either `required` (node must have trait) or `absent` (node must not have trait)
+    * **state**: Either `required` (node must have trait) or `absent` (node must not have trait)
 
 ### Example: Generic Flavor
 
@@ -74,7 +74,7 @@ name: m1.small.nicX
 resource_class: m1.small
 traits:
   - trait: NICX
-    requirement: required
+    state: required
 ```
 
 This matches only nodes with `resource_class=m1.small` AND the `CUSTOM_NICX` trait. Nova flavor properties still come from the device-type's `m1.small` resource class.
@@ -88,7 +88,7 @@ name: m1.small.no-gpu
 resource_class: m1.small
 traits:
   - trait: GPU
-    requirement: absent
+    state: absent
 ```
 
 This matches nodes with `resource_class=m1.small` that do NOT have the `CUSTOM_GPU` trait.
@@ -220,7 +220,7 @@ name: compute.gpu
 resource_class: m1.large
 traits:
   - trait: GPU
-    requirement: required
+    state: required
 ```
 
 Guarantees instances get hardware with GPU capabilities while using the `m1.large` resource class specifications for vCPUs/RAM/disk.
@@ -235,7 +235,7 @@ name: m1.small.mellanox-cx5
 resource_class: m1.small
 traits:
   - trait: NIC_MELLANOX_CX5
-    requirement: required
+    state: required
 ```
 
 Guarantees instances get nodes with Mellanox ConnectX-5 network cards.
@@ -255,7 +255,7 @@ name: m1.small.nvme
 resource_class: m1.small
 traits:
   - trait: NVME
-    requirement: required
+    state: required
 ```
 
 Users can choose between generic availability or guaranteed NVMe storage. Both flavors have identical Nova properties (derived from device-type `m1.small`), but different hardware selection criteria.
@@ -324,7 +324,7 @@ Flavor definitions undergo JSON schema validation checking:
 * Required field presence (name, resource_class)
 * Type correctness (strings for name/resource_class/traits)
 * Trait name patterns (uppercase alphanumeric with underscores)
-* Trait requirement enum values (`required` or `absent`)
+* Trait state enum values (`required` or `absent`)
 
 Validation happens at:
 
@@ -392,14 +392,14 @@ name: m1.small.nicX
 resource_class: m1.small
 traits:
   - trait: NICX
-    requirement: required
+    state: required
 ---
 # Exclusion: nodes without GPU
 name: m1.small.no-gpu
 resource_class: m1.small
 traits:
   - trait: GPU
-    requirement: absent
+    state: absent
 ```
 
 All three Nova flavors have identical vCPUs/RAM/disk (from device-type `m1.small`), but select different subsets of hardware based on traits.

docs/design-guide/hardware-traits.md

@@ -182,7 +182,7 @@ name: compute.nvme
 resource_class: m1.medium
 traits:
   - trait: NVME
-    requirement: required
+    state: required
 ```
 
 Matches only nodes with NVMe storage in m1.medium resource class.
@@ -194,7 +194,7 @@ name: compute.no-gpu
 resource_class: m1.large
 traits:
   - trait: GPU
-    requirement: absent
+    state: absent
 ```
 
 Matches nodes without GPU in m1.large resource class.
@@ -206,9 +206,9 @@ name: compute.nvidia-nvme
 resource_class: m1.large
 traits:
   - trait: GPU_NVIDIA
-    requirement: required
+    state: required
   - trait: NVME
-    requirement: required
+    state: required
 ```
 
 Matches nodes with both NVIDIA GPU and NVMe storage.
@@ -265,9 +265,9 @@ name: compute.gpu-nvme
 resource_class: m1.medium
 traits:
   - trait: GPU_NVIDIA
-    requirement: required
+    state: required
   - trait: NVME
-    requirement: required
+    state: required
 ```
 
 **Result**: Node eligible for `compute.gpu-nvme` flavor, Nova flavor created with m1.medium resource class properties (32 vCPUs, 256GB RAM from device-type).

docs/operator-guide/flavors.md

@@ -62,15 +62,15 @@ name: m1.small.nicX
 resource_class: m1.small
 traits:
   - trait: NICX
-    requirement: required
+    state: required
 ```
 
 **Trait Requirements**:
 
 * `trait`: Hardware trait name WITHOUT the `CUSTOM_` prefix (e.g., `NICX`, `GPU`, `NVME`)
     * Must be uppercase alphanumeric with underscores
     * The system automatically adds `CUSTOM_` prefix when interacting with Ironic
-* `requirement`: Either `required` (node must have trait) or `absent` (node must not have trait)
+* `state`: Either `required` (node must have trait) or `absent` (node must not have trait)
 
 ### 4. Add to Deployment
 
@@ -128,7 +128,7 @@ This performs full JSON schema validation including:
 * Required field presence (name, resource_class)
 * Type correctness (strings)
 * Trait name patterns (uppercase alphanumeric with underscores)
-* Trait requirement enum values (`required` or `absent`)
+* Trait state enum values (`required` or `absent`)
 
 Successful output:
 
@@ -139,7 +139,7 @@ INFO Flavor definition is valid name=m1.small resource_class=m1.small
 Validation errors will show the specific issue:
 
 ```text
-Error: validation failed: traits[0].requirement: must be one of [required, absent]
+Error: validation failed: traits[0].state: must be one of [required, absent]
 Error: validation failed: traits[0].trait: does not match pattern ^[A-Z][A-Z0-9_]*$
 ```
 
@@ -262,7 +262,7 @@ name: compute.gpu
 resource_class: m1.large
 traits:
   - trait: GPU
-    requirement: required
+    state: required
 ```
 
 Guarantees instances get nodes with GPU hardware.
@@ -277,7 +277,7 @@ name: m1.small.mellanox-cx5
 resource_class: m1.small
 traits:
   - trait: NIC_MELLANOX_CX5
-    requirement: required
+    state: required
 ```
 
 Only matches nodes with Mellanox ConnectX-5 network cards.
@@ -292,9 +292,9 @@ name: compute.nvme-no-gpu
 resource_class: m1.medium
 traits:
   - trait: NVME
-    requirement: required
+    state: required
   - trait: GPU
-    requirement: absent
+    state: absent
 ```
 
 Requires NVMe storage but excludes GPU nodes.
@@ -346,9 +346,9 @@ Ensure both `name` and `resource_class` are present in the definition.
 
 Trait names must be uppercase alphanumeric with underscores. Don't include the `CUSTOM_` prefix.
 
-**Invalid requirement**:
+**Invalid state**:
 
-The `requirement` field must be exactly `required` or `absent`.
+The `state` field must be exactly `required` or `absent`.
 
 ### ConfigMap Not Updating
 
@@ -404,7 +404,7 @@ name: m1.small.nicX
 resource_class: m1.small
 traits:
   - trait: NICX
-    requirement: required
+    state: required
 ```
 
 Only matches nodes with the `CUSTOM_NICX` trait.
@@ -417,7 +417,7 @@ name: compute.gpu
 resource_class: m1.large
 traits:
   - trait: GPU
-    requirement: required
+    state: required
 ```
 
 Guarantees GPU hardware for compute workloads.
@@ -430,9 +430,9 @@ name: m1.medium.mellanox-cx5-nvme
 resource_class: m1.medium
 traits:
   - trait: NIC_MELLANOX_CX5
-    requirement: required
+    state: required
   - trait: NVME
-    requirement: required
+    state: required
 ```
 
 Requires both Mellanox ConnectX-5 and NVMe storage.

schema/flavor.schema.json

@@ -26,13 +26,13 @@
             "type": "string",
             "pattern": "^[A-Z][A-Z0-9_]*$"
           },
-          "requirement": {
+          "state": {
             "description": "Whether the trait must be present (required) or absent",
             "type": "string",
             "enum": ["required", "absent"]
           }
         },
-        "required": ["trait", "requirement"],
+        "required": ["trait", "state"],
         "additionalProperties": false
       }
     }