probeDeployment

deployment_available_and_healthy

Lookup a deployment state

Activity as code

Below are the details and signature of the activity Python module.

Typeprobe
Modulechaosk8s.deployment.probes
Namedeployment_available_and_healthy
Returnbool

Usage

JSON

{
  "name": "deployment-available-and-healthy",
  "type": "probe",
  "provider": {
    "type": "python",
    "module": "chaosk8s.deployment.probes",
    "func": "deployment_available_and_healthy",
    "arguments": {
      "name": ""
    }
  }
}

YAML

name: deployment-available-and-healthy
provider:
  arguments:
    name: ""
  func: deployment_available_and_healthy
  module: chaosk8s.deployment.probes
  type: python
type: probe

Arguments

NameTypeDefaultRequiredTitleDescription
namestringYesNameName of the deployment
nsstring“default”YesNamespace
label_selectorstringnullNoLabel SelectorUse label selector instead of the name
raise_on_unavailablebooltrueNoRaise if unavailableRaise when not available, if unchecked returns a boolean

Signature

def deployment_available_and_healthy(
        name: str,
        ns: str = 'default',
        label_selector: str = None,
        raise_on_unavailable: bool = True,
        secrets: Dict[str, Dict[str, str]] = None) -> Optional[bool]:
    pass