chore: add conditions#385
Conversation
Documentation previewhttps://mellanox.github.io/network-operator-docs/review/pr-385 |
Greptile SummaryThis PR documents the new
Confidence Score: 4/5Documentation-only PR that is safe to merge; the heading hierarchy mismatch in the new subsections remains unresolved from the prior review thread. The content is accurate and internally consistent. The heading style issue in life-cycle-management.rst (using top-level docs/life-cycle-management.rst — heading levels for the new subsections should be verified against the file's declared hierarchy before merging. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Reconcile Loop] --> B{For each configured component}
B --> C[Component state = ready]
B --> D[Component state = notReady]
B --> E[Component state = error]
B --> F[Component state = ignore]
C --> G["condition: status=True\nreason=ComponentReady"]
D --> H["condition: status=False\nreason=ComponentNotReady"]
E --> I["condition: status=False\nreason=ComponentError"]
F --> J[No condition written / stale pruned]
G & H & I --> K[Aggregate Ready condition]
K --> L{Any ComponentError?}
L -- Yes --> M["Ready: False\nreason=ComponentError"]
L -- No --> N{Any ComponentNotReady?}
N -- Yes --> O["Ready: False\nreason=ComponentsNotReady"]
N -- No --> P["Ready: True\nreason=AllComponentsReady"]
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[Reconcile Loop] --> B{For each configured component}
B --> C[Component state = ready]
B --> D[Component state = notReady]
B --> E[Component state = error]
B --> F[Component state = ignore]
C --> G["condition: status=True\nreason=ComponentReady"]
D --> H["condition: status=False\nreason=ComponentNotReady"]
E --> I["condition: status=False\nreason=ComponentError"]
F --> J[No condition written / stale pruned]
G & H & I --> K[Aggregate Ready condition]
K --> L{Any ComponentError?}
L -- Yes --> M["Ready: False\nreason=ComponentError"]
L -- No --> N{Any ComponentNotReady?}
N -- Yes --> O["Ready: False\nreason=ComponentsNotReady"]
N -- No --> P["Ready: True\nreason=AllComponentsReady"]
Reviews (2): Last reviewed commit: "chore: ncp conditions" | Re-trigger Greptile |
| ##################### | ||
| Condition Field Model | ||
| ##################### |
There was a problem hiding this comment.
Heading style inconsistent with file convention
The file's comment on line 17 declares the heading hierarchy as # #, * *, =, -, ^, ", meaning # with overline is the top-level style and ^ is the sub-subsection style that should follow -. The existing ^ headings (e.g., Troubleshooting and Returning Pods…) were level 4 before this PR. Introducing ### (overline #) as a new level 4 inside this section demotes every existing ^ heading to level 5 while those ^ sections remain direct children of level-3 (---) headings — a level skip that docutils flags as "Title level inconsistent". Using ^ here (consistent with the rest of the file) avoids reassigning heading levels for the entire document.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| .. |spectrum-x-operator-stig-rhel-repository| replace:: nvcr.io/nvidia/mellanox | ||
| .. |spectrum-x-operator-stig-ubuntu-version| replace:: network-operator-v26.4.0-stig-fips-ubuntu | ||
| .. |spectrum-x-operator-stig-ubuntu-repository| replace:: nvcr.io/nvidia/mellanox | ||
|
|
| | ``appliedStates`` | AppliedStates provide a finer view of the observed state | | ||
| | :ref:`[]AppliedState <AppliedState>` | | | ||
| +---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+ | ||
| | ``conditions`` | Standard Kubernetes conditions representing per-component and aggregate health. | |
There was a problem hiding this comment.
run make api-docs and commit the changes
Signed-off-by: Dana Halperin <dahalperin@nvidia.com>
No description provided.