Charmed-Kubernetes/calico/docs/status.md

1.9 KiB

WorkloadState

WorkloadState(self, /, *args, **kwargs)

Enum of the valid workload states.

Valid options are:

  • WorkloadState.MAINTENANCE
  • WorkloadState.BLOCKED
  • WorkloadState.WAITING
  • WorkloadState.ACTIVE

maintenance

maintenance(message)

Set the status to the MAINTENANCE state with the given operator message.

Parameters

  • message (str): Message to convey to the operator.

maint

maint(message)

Shorthand alias for maintenance.

Parameters

  • message (str): Message to convey to the operator.

blocked

blocked(message)

Set the status to the BLOCKED state with the given operator message.

Parameters

  • message (str): Message to convey to the operator.

waiting

waiting(message)

Set the status to the WAITING state with the given operator message.

Parameters

  • message (str): Message to convey to the operator.

active

active(message)

Set the status to the ACTIVE state with the given operator message.

Parameters

  • message (str): Message to convey to the operator.

status_set

status_set(workload_state, message)

Set the status to the given workload state with a message.

Parameters

  • workload_state (WorkloadState or str): State of the workload. Should be a WorkloadState enum member, or the string value of one of those members.
  • message (str): Message to convey to the operator.