Skip to main content

perpetual union

Manage unions.

perpetual union delete​

Delete a union.

perpetual union delete <id> [flags]

Changes: Stages its writes into a changeset.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
idRequiredUnion ID (ION_*).

Flags​

FlagTypeRequiredDescription
--base-versionstringOptionalExpected current version for optimistic concurrency.
--changesetstringOptionalChangeset (CHG_*) to stage into; REQUIRED (the CLI makes no live changes).

Also accepts the global flags, including the sign-in flags.

perpetual union export​

Write a union as a GitOps file.

perpetual union export <id> [flags]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
idRequiredUnion ID (ION_*).

Flags​

FlagTypeRequiredDescription
--dirstringOptionalDirectory for a new file (default .).
--filestringOptionalExisting .union.yaml/.json file to edit in place.

Also accepts the global flags, including the sign-in flags.

perpetual union get​

Get a union.

perpetual union get <id>

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
idRequiredUnion ID (ION_*).

Also accepts the global flags, including the sign-in flags.

perpetual union list​

List unions.

perpetual union list [flags]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Flags​

FlagTypeRequiredDescription
--spacestring, repeatableOptionalOnly these spaces: SPC_* ids, comma-separated or repeated.
--filterstringOptionalRaw OData $filter expression, passed to the server as is.
--topstringOptionalItems per page (server default 100).
--skipstringOptionalNumber of items to skip.
--allbooleanOptionalFetch every page (1000 items per request).

Also accepts the global flags, including the sign-in flags.

perpetual union status​

Show the deployment status of unions.

perpetual union status [ids]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
idsOptionalUnion ids.

Also accepts the global flags, including the sign-in flags.

perpetual union wait​

Wait until a union reaches a deployment status (requires --timeout).

perpetual union wait <id> [flags]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
idRequiredUnion id.

Flags​

FlagTypeRequiredDescription
--timeoutstringOptionalGive up after this long, e.g. 90s, 10m, 1h (required; at most 24h).
--untilstringOptionalStatus to wait for (default DEPLOYED): DEPLOYED, FAILED, DEGRADED, UNDEPLOYED, ARCHIVED. One of DEPLOYED, FAILED, DEGRADED, UNDEPLOYED, ARCHIVED.
--versionstringOptionalWait for this committed version (default: the version committed when the wait starts).

Also accepts the global flags, including the sign-in flags.


Perpetual CLI 0.5.0