@zuke/argo-rollouts

`@zuke/argo-rollouts` — typed `ArgoRolloutsTasks` wrappers for the

Symbols

ArgoRolloutsCreateAnalysisRunSettings

class

class ArgoRolloutsCreateAnalysisRunSettings extends ArgoRolloutsSettings

Settings for create analysisrun — run an AnalysisTemplate (or, with global, a ClusterAnalysisTemplate) once, from the cluster or a file.

Member	Signature	Doc
`from`	`from(template: string): this`	The template in the cluster to run (`--from`); this or `fromFile` is required.
`fromFile`	`fromFile(path: PathLike): this`	A local template file to run (`--from-file`); this or `from` is required.
`global`	`global(): this`	Use a ClusterAnalysisTemplate instead of an AnalysisTemplate (`--global`).
`argument`	`argument(name: string, value: string): this`	Pass a template argument as `name=value` (`--argument`); repeatable.
`name`	`name(value: string): this`	Name the run exactly (`--name`).
`generateName`	`generateName(prefix: string): this`	Let the cluster name the run from this prefix (`--generate-name`).
`instanceId`	`instanceId(id: string): this`	The controller instance the run belongs to (`--instance-id`).

ArgoRolloutsCreateSettings

class

class ArgoRolloutsCreateSettings extends ArgoRolloutsSettings

Settings for create — create a Rollout or Experiment from files.

Member	Signature	Doc
`filename`	`filename(...paths: PathLike[]): this`	A manifest to create from (`--filename`); repeatable, at least one is required.
`watch`	`watch(): this`	Keep printing live updates after creating (`--watch`).
`noColor`	`noColor(): this`	Print without colour (`--no-color`).

ArgoRolloutsGetExperimentSettings

class

class ArgoRolloutsGetExperimentSettings extends ArgoRolloutsSettings

Settings for get experiment — show an experiment's templates and analysis.

Member	Signature	Doc
`name`	`name(value: string): this`	The experiment to show (required).
`watch`	`watch(): this`	Keep printing live updates (`--watch`).
`noColor`	`noColor(): this`	Print without colour (`--no-color`).

ArgoRolloutsGetRolloutSettings

class

class ArgoRolloutsGetRolloutSettings extends ArgoRolloutsSettings

Settings for get rollout — show a rollout's steps, replica sets and analysis.

Member	Signature	Doc
`name`	`name(value: string): this`	The rollout to show (required).
`watch`	`watch(): this`	Keep printing live updates (`--watch`).
`noColor`	`noColor(): this`	Print without colour (`--no-color`).
`timeoutSeconds`	`timeoutSeconds(seconds: number): this`	With `watch`, give up after this many seconds (`--timeout-seconds`).

ArgoRolloutsLintSettings

class

class ArgoRolloutsLintSettings extends ArgoRolloutsSettings

Settings for lint — validate a Rollout manifest without applying it.

Member	Signature	Doc
`filename`	`filename(path: PathLike): this`	The manifest to lint (`--filename`, required).

ArgoRolloutsListExperimentsSettings

class

class ArgoRolloutsListExperimentsSettings extends ArgoRolloutsSettings

Settings for list experiments. Unlike list rollouts it has no watch or name filter: the plugin registers only --all-namespaces for it, whatever its help text's examples suggest.

Member	Signature	Doc
`allNamespaces`	`allNamespaces(): this`	List across every namespace (`--all-namespaces`).

ArgoRolloutsListRolloutsSettings

class

class ArgoRolloutsListRolloutsSettings extends ArgoRolloutsSettings

Settings for list rollouts.

Member	Signature	Doc
`allNamespaces`	`allNamespaces(): this`	List across every namespace (`--all-namespaces`).
`name`	`name(value: string): this`	Only show the rollout with this name (`--name`).
`timestamps`	`timestamps(): this`	With `watch`, print a timestamp on each update (`--timestamps`).
`watch`	`watch(): this`	Keep printing changes (`--watch`).

ArgoRolloutsNamedSettings

class

class ArgoRolloutsNamedSettings extends ArgoRolloutsSettings

Settings for the subcommands whose only operand is a resource name: abort, pause, retry rollout, retry experiment, terminate analysisrun and terminate experiment. They differ only in their leading tokens, so they share one implementation rather than six copies of it.

Member	Signature	Doc
`name`	`name(value: string): this`	The rollout, experiment or analysis run to act on (required).

ArgoRolloutsPromoteSettings

class

class ArgoRolloutsPromoteSettings extends ArgoRolloutsSettings

Settings for promote — advance a paused rollout to its next step, or with full skip every remaining step, pause and analysis.

Member	Signature	Doc
`name`	`name(value: string): this`	The rollout to promote (required).
`full`	`full(): this`	Promote to the desired version outright, skipping analysis, pauses and steps (`--full`).

ArgoRolloutsRestartSettings

class

class ArgoRolloutsRestartSettings extends ArgoRolloutsSettings

Settings for restart — restart a rollout's pods, now or after a delay.

Member	Signature	Doc
`name`	`name(value: string): this`	The rollout whose pods to restart (required).
`in`	`in(duration: string): this`	Delay the restart, e.g. `"30s"`, `"5m"`, `"1h"` (`--in`).

ArgoRolloutsSetImageSettings

class

class ArgoRolloutsSetImageSettings extends ArgoRolloutsSettings

Settings for set image — point a container of the rollout at a new image, which starts a new rollout through the steps its manifest declares.

Member	Signature	Doc
`name`	`name(value: string): this`	The rollout to update (required).
`image`	`image(container: string, reference: string): this`	The container and the image to set, as `CONTAINER=IMAGE` (required). Pass `"*"` as the container to update every container in the rollout.

ArgoRolloutsSettings

class

class ArgoRolloutsSettings extends ToolSettings

Base for all Argo Rollouts subcommand settings. The binary is the plugin itself, kubectl-argo-rollouts, which takes the same subcommands as kubectl argo rollouts; the cluster-targeting flags (--namespace, --context, --kubeconfig) are shared by every subcommand.

Member	Signature	Doc
`namespace`	`namespace(name: string): this`	Target a namespace (`--namespace`).
`context`	`context(name: string): this`	Use a named kubeconfig context (`--context`).
`kubeconfig`	`kubeconfig(path: PathLike): this`	Use an explicit kubeconfig file (`--kubeconfig`).

ArgoRolloutsStatusSettings

class

class ArgoRolloutsStatusSettings extends ArgoRolloutsSettings

Settings for status — report a rollout's status, by default watching until it completes or degrades.

Member	Signature	Doc
`name`	`name(value: string): this`	The rollout to report on (required).
`timeout`	`timeout(duration: string): this`	How long to watch before giving up, e.g. `"10m"`; `"0"` waits forever (`--timeout`).
`noWatch`	`noWatch(): this`	Print the current status once instead of watching it (`--watch=false`).

ArgoRolloutsTasks

const

const ArgoRolloutsTasks: ArgoRolloutsTasksApi

Typed task functions for the Argo Rollouts kubectl plugin.

ArgoRolloutsTasksApi

interface

interface ArgoRolloutsTasksApi

The shape of ArgoRolloutsTasks.

Member	Signature	Doc
`setImage`	`setImage(configure?: Configure<ArgoRolloutsSetImageSettings>): Promise<CommandOutput>`	Point a rollout's container at a new image, starting a rollout: `set image`.
`promote`	`promote(configure?: Configure<ArgoRolloutsPromoteSettings>): Promise<CommandOutput>`	Advance a paused rollout, or promote it fully: `promote`.
`abort`	`abort(configure?: Configure<ArgoRolloutsNamedSettings>): Promise<CommandOutput>`	Abort a rollout, returning traffic to the stable version: `abort`.
`pause`	`pause(configure?: Configure<ArgoRolloutsNamedSettings>): Promise<CommandOutput>`	Pause a rollout where it is: `pause`.
`status`	`status(configure?: Configure<ArgoRolloutsStatusSettings>): Promise<CommandOutput>`	Report, or watch, a rollout's status: `status`.
`undo`	`undo(configure?: Configure<ArgoRolloutsUndoSettings>): Promise<CommandOutput>`	Roll a rollout back to an earlier revision: `undo`.
`restart`	`restart(configure?: Configure<ArgoRolloutsRestartSettings>): Promise<CommandOutput>`	Restart a rollout's pods: `restart`.
`retryRollout`	`retryRollout(configure?: Configure<ArgoRolloutsNamedSettings>): Promise<CommandOutput>`	Retry an aborted rollout: `retry rollout`.
`retryExperiment`	`retryExperiment(configure?: Configure<ArgoRolloutsNamedSettings>): Promise<CommandOutput>`	Retry an experiment: `retry experiment`.
`terminateAnalysisRun`	`terminateAnalysisRun(configure?: Configure<ArgoRolloutsNamedSettings>): Promise<CommandOutput>`	Terminate a running analysis run: `terminate analysisrun`.
`terminateExperiment`	`terminateExperiment(configure?: Configure<ArgoRolloutsNamedSettings>): Promise<CommandOutput>`	Terminate a running experiment: `terminate experiment`.
`getRollout`	`getRollout(configure?: Configure<ArgoRolloutsGetRolloutSettings>): Promise<CommandOutput>`	Show a rollout: `get rollout`.
`getExperiment`	`getExperiment(configure?: Configure<ArgoRolloutsGetExperimentSettings>): Promise<CommandOutput>`	Show an experiment: `get experiment`.
`listRollouts`	`listRollouts(configure?: Configure<ArgoRolloutsListRolloutsSettings>): Promise<CommandOutput>`	List rollouts: `list rollouts`.
`listExperiments`	`listExperiments(configure?: Configure<ArgoRolloutsListExperimentsSettings>): Promise<CommandOutput>`	List experiments: `list experiments`.
`create`	`create(configure?: Configure<ArgoRolloutsCreateSettings>): Promise<CommandOutput>`	Create a Rollout or Experiment from files: `create`.
`createAnalysisRun`	`createAnalysisRun(configure?: Configure<ArgoRolloutsCreateAnalysisRunSettings>): Promise<CommandOutput>`	Run an analysis template once: `create analysisrun`.
`lint`	`lint(configure?: Configure<ArgoRolloutsLintSettings>): Promise<CommandOutput>`	Validate a Rollout manifest: `lint`.
`version`	`version(configure?: Configure<ArgoRolloutsVersionSettings>): Promise<CommandOutput>`	Print the plugin's version: `version`.

ArgoRolloutsUndoSettings

class

class ArgoRolloutsUndoSettings extends ArgoRolloutsSettings

Settings for undo — roll a rollout back to an earlier revision.

Member	Signature	Doc
`name`	`name(value: string): this`	The rollout to roll back (required).
`toRevision`	`toRevision(revision: number): this`	The revision to roll back to; the previous one when unset (`--to-revision`).

ArgoRolloutsVersionSettings

class

class ArgoRolloutsVersionSettings extends ArgoRolloutsSettings

Settings for version.

Member	Signature	Doc
`short`	`short(): this`	Print only the plugin's version number (`--short`).