Skip to content

chore: add conditions #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rollandf merged 1 commit into from
Jun 30, 2026
Merged

chore: add conditions #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 41 additions & 24 deletions docs/customizations/crds.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ AppliedState defines a finer-grained view of the observed state of NicClusterPol
| string | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _ConditionHolder:

ConditionHolder
~~~~~~~~~~~~~~~

ConditionHolder is implemented by CRDs that carry a status.conditions array. NicClusterPolicy and NicNodePolicy implement this interface.

.. _ConfigMapNameReference:

ConfigMapNameReference
Expand Down Expand Up @@ -728,18 +735,23 @@ NicClusterPolicyStatus defines the observed state of NicClusterPolicy

.. container:: md-typeset__table

+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| Field | Description |
+===================================================================================================+===================================================================================================+
| ``state`` | Reflects the current state of the cluster policy |
| :ref:`State <State>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``reason`` | Informative string in case the observed state is error |
| string | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``appliedStates`` | AppliedStates provide a finer view of the observed state |
| :ref:`[]AppliedState <AppliedState>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| Field | Description |
+===============================================================================================================+===================================================================================================+
| ``state`` | Reflects the current state of the cluster policy |
| :ref:`State <State>` | |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``reason`` | Informative string in case the observed state is error |
| string | |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``appliedStates`` | AppliedStates provide a finer view of the observed state |
| :ref:`[]AppliedState <AppliedState>` | |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``conditions`` | *(Optional)* |
| `[]Kubernetes | Conditions is a list of conditions describing the state of the NicClusterPolicy. Each enabled |
| meta/v1.Condition <https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta>`__ | component exposes a Ready condition, and the aggregate Ready condition summarizes the overall |
| | policy health. |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _NicConfigurationOperatorSpec:

Expand Down Expand Up @@ -882,18 +894,23 @@ NicNodePolicyStatus defines the observed state of NicNodePolicy

.. container:: md-typeset__table

+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| Field | Description |
+===================================================================================================+===================================================================================================+
| ``state`` | Reflects the current state of the cluster policy |
| :ref:`State <State>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``reason`` | Informative string in case the observed state is error |
| string | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``appliedStates`` | AppliedStates provide a finer view of the observed state |
| :ref:`[]AppliedState <AppliedState>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| Field | Description |
+===============================================================================================================+===================================================================================================+
| ``state`` | Reflects the current state of the cluster policy |
| :ref:`State <State>` | |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``reason`` | Informative string in case the observed state is error |
| string | |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``appliedStates`` | AppliedStates provide a finer view of the observed state |
| :ref:`[]AppliedState <AppliedState>` | |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``conditions`` | *(Optional)* |
| `[]Kubernetes | Conditions is a list of conditions describing the state of the NicNodePolicy. Each enabled |
| meta/v1.Condition <https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#condition-v1-meta>`__ | component exposes a Ready condition, and the aggregate Ready condition summarizes the overall |
| | policy health. |
+---------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

.. _NicPolicyCR:

Expand Down
Loading
Loading