Skip to content
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

docs: clarify distinction between maintenance and waiting status #1148

Merged
merged 2 commits into from
Jul 17, 2024
Merged

docs: clarify distinction between maintenance and waiting status #1148

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e63a4a
doc(model): clarify distinction between maintenance and waiting status
benhoyt Mar 12, 2024
1c33246
Updates per discussion in Madrid
benhoyt Jul 17, 2024
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
13 changes: 7 additions & 6 deletions ops/model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1854,9 +1854,9 @@ class MaintenanceStatus(StatusBase):
"""The unit is performing maintenance tasks.

The unit is not yet providing services, but is actively doing work in preparation
for providing those services. This is a "spinning" state, not an error state. It
reflects activity on the unit itself, not on peers or related units.

for providing those services. This is a "spinning" state, not an error state. In
contrast to :class:`WaitingStatus`, "maintenance" reflects activity on this unit
or charm, not on peers or related units.
"""
name = 'maintenance'

Expand All @@ -1865,9 +1865,10 @@ class MaintenanceStatus(StatusBase):
class WaitingStatus(StatusBase):
"""A unit is unable to progress.

The unit is unable to progress to an active state because an application with which
it is integrated is not running.

The unit is unable to progress to an active state because an application it
is integrated with is not yet ready. In contrast to
:class:`MaintenanceStatus`, "waiting" reflects activity on related units,
not on this unit or charm.
"""
name = 'waiting'

Expand Down
Loading