cli icon indicating copy to clipboard operation
cli copied to clipboard

runbook-run subcommand

Open jbristowe opened this issue 2 years ago • 2 comments

https://github.com/OctopusDeploy/OctopusCLI/pull/243

We are considering adding a set of commands that will allow users to list, view, and delete runs of runbooks. This is done to perform administrative operations against Octopus. Unfortunately, this request poses a naming challenge; how do we represent runbook runs? A runbook run is a historical artefact in the context of Octopus. However, it's also refers to an action associated with a runbook (i.e. "the runbook ran to update the server"). It's confusing.

I propose the establishment of a runbook-run subcommand:

$ octopus runbook-run [command]

This subcommand would allow you to delete, list, and view runbook runs; runbooks that executed in the past.

In summary, the revised list of runbook-related commands would be:

$ octopus runbook delete       # deletes a runbook
$ octopus runbook execute      # executes a runbook
$ octopus runbook list         # lists runbooks
$ octopus runbook-run delete   # deletes a runbook run
$ octopus runbook-run list     # lists runbook runs
$ octopus runbook-run view     # views a runbook run
$ octopus runbook view         # view a runbook

jbristowe avatar Dec 06 '22 23:12 jbristowe

Further support for this work https://github.com/OctopusDeploy/OctopusCLI/issues/244

benPearce1 avatar Jan 27 '23 01:01 benPearce1

the ability to publish a snapshot is missing https://octopus.com/docs/octopus-rest-api/examples/runbooks/create-and-publish-runbook

$ octopus runbook snapshot    #create a runbook snapshot

toby-freemarket avatar May 22 '23 13:05 toby-freemarket