idyl wait - IDYL Docs

Wait for a resource to reach a condition. The —for condition is required. The —timeout flag defaults to 5m. Set —timeout=0s to evaluate the current resource snapshot only and exit without watching for changes. Supported resources and conditions:

pod: started, ready, complete, deleted
sandbox: started, ready, deleted
job: started, complete, deleted
deployment: started, ready, deleted
replicaset: started, ready, deleted
namespace: deleted
workspace: deleted
fleet: ready, condition=<name>
fleet-lease: fulfilled, condition=<name>
cloud-account: connected, condition=<name>

Workloads and workspaces are addressed by name within a namespace; a namespace is addressed by name alone and takes no —workspace; capacity resources are addressed by the 12-digit ID the platform assigned them. A namespace or a workspace is released asynchronously after ‘idyl namespace delete’ or ‘idyl workspace delete’ accepts the deletion. Waiting for deleted blocks until the platform has finalized the release and the name no longer resolves; while it is terminating the wait reports what still holds it back. Capacity resources report conditions — named properties, each with a reason from a closed set. —for=condition=<name> waits on one of them directly, for a property with no shorthand of its own: Attached, Launching, CapacitySatisfied fleet Accepted, Fulfilled fleet-lease Verified cloud-account Exit status says what happened, so a script can tell the three outcomes apart without reading any output. It means the same thing for every resource above: 0 the condition was reached 124 the deadline passed with the condition not yet reached; the resource may still reach it 125 the condition will not be reached — the workload failed or was deleted, or capacity reports something that has to change first: the resource’s own spec, the catalog it draws on, or the cloud account it provisions into 1 the command could not run: no session, an unknown resource, bad arguments The reason a wait ended is written to standard error whichever way it ended, so the status is what a script reads and the reason is what a person reads. Resource aliases match the rest of the CLI:

deployment, deployments, deploy
replicaset, replicasets, rs
pod, pods
job, jobs
sandbox, sandboxes
namespace, namespaces, ns
workspace, workspaces, ws
fleet, fleets
fleet-lease, fleet-leases, lease, leases
cloud-account, cloud-accounts

Usage

idyl wait <resource> <name>|<resource>/<name> [flags]

Commands

Command	Description
`idyl wait cloud-account`	Wait for a cloud-account condition
`idyl wait deployment`	Wait for a deployment condition
`idyl wait fleet`	Wait for a fleet condition
`idyl wait fleet-lease`	Wait for a fleet-lease condition
`idyl wait job`	Wait for a job condition
`idyl wait namespace`	Wait for a namespace condition
`idyl wait pod`	Wait for a pod condition
`idyl wait replicaset`	Wait for a replicaset condition
`idyl wait sandbox`	Wait for a sandbox condition
`idyl wait workspace`	Wait for a workspace condition

Flags

Flag	Description
`--for <string>`	Required. Condition to wait for; varies by resource (started, ready, complete, deleted, fulfilled, connected, or condition=<name>).
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.
`--timeout <duration>`	Maximum time to wait; 0s checks the current resource snapshot only. Default: `5m0s`.

Inherited flags

Flag	Description
`-a <string>, --account-id <string>`	Account ID to use, overriding the current context.
`-c <string>, --context <string>`	Use the named context for this command.
`--homedir <string>`	Override the configuration directory. Defaults to ~/.config/idyl.
`-n <string>, --namespace <string>`	Namespace to address, overriding the entered context.
`--network <string>`	Override the Network for this command.
`-p <string>, --profile <string>`	Override the access profile for this command.
`-s <string>, --subnet <string>`	Subnet to use for this command, overriding the current context.
`--workspace <string>`	Workspace within the namespace, overriding the entered context.

Examples

idyl wait pod web-abc --for=ready
idyl wait sandbox/dev --for=ready --timeout=2m
idyl wait job migrate --for=complete --timeout=10m
idyl wait namespace staging --for=deleted --timeout=10m
idyl wait workspace payments -n production --for=deleted
idyl wait fleet 100000000101 --for=ready --timeout=15m
idyl wait fleet-lease 100000000102 --for=fulfilled --timeout=30m
idyl wait cloud-account 100000000103 --for=connected
idyl wait fleet 100000000101 --for=condition=Launching
idyl wait sandbox dev --for=deleted --timeout=0s

Subcommand reference

`idyl wait cloud-account`

Wait for a cloud-account condition

Usage

idyl wait cloud-account <id> [flags]

Aliases

cloud-accounts

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait deployment`

Wait for a deployment condition

Usage

idyl wait deployment <name> [flags]

Aliases

deployments
deploy

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait fleet`

Wait for a fleet condition

Usage

idyl wait fleet <id> [flags]

Aliases

fleets

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait fleet-lease`

Wait for a fleet-lease condition

Usage

idyl wait fleet-lease <id> [flags]

Aliases

fleet-leases
lease
leases

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait job`

Wait for a job condition

Usage

idyl wait job <name> [flags]

Aliases

jobs

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait namespace`

Wait for a namespace condition

Usage

idyl wait namespace <name> [flags]

Aliases

namespaces
ns

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait pod`

Wait for a pod condition

Usage

idyl wait pod <name> [flags]

Aliases

pods

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait replicaset`

Wait for a replicaset condition

Usage

idyl wait replicaset <name> [flags]

Aliases

replicasets
rs

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait sandbox`

Wait for a sandbox condition

Usage

idyl wait sandbox <name> [flags]

Aliases

sandboxes

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

`idyl wait workspace`

Wait for a workspace condition

Usage

idyl wait workspace <name> [flags]

Aliases

workspaces
ws

Flags

Flag	Description
`-o <string>, --output <string>`	Output format: table, json, yaml. Default: `table`.

​Usage

​Commands

​Flags

​Inherited flags

​Examples

​Subcommand reference

​idyl wait cloud-account

​Usage

​Aliases

​Flags

​idyl wait deployment

​Usage

​Aliases

​Flags

​idyl wait fleet

​Usage

​Aliases

​Flags

​idyl wait fleet-lease

​Usage

​Aliases

​Flags

​idyl wait job

​Usage

​Aliases

​Flags

​idyl wait namespace

​Usage

​Aliases

​Flags

​idyl wait pod

​Usage

​Aliases

​Flags

​idyl wait replicaset

​Usage

​Aliases

​Flags

​idyl wait sandbox

​Usage

​Aliases

​Flags

​idyl wait workspace

​Usage

​Aliases

​Flags

Usage

Commands

Flags

Inherited flags

Examples

Subcommand reference

`idyl wait cloud-account`

Usage

Aliases

Flags

`idyl wait deployment`

Usage

Aliases

Flags

`idyl wait fleet`

Usage

Aliases

Flags

`idyl wait fleet-lease`

Usage

Aliases

Flags

`idyl wait job`

Usage

Aliases

Flags

`idyl wait namespace`

Usage

Aliases

Flags

`idyl wait pod`

Usage

Aliases

Flags

`idyl wait replicaset`

Usage

Aliases

Flags

`idyl wait sandbox`

Usage

Aliases

Flags

`idyl wait workspace`

Usage

Aliases

Flags