Package planutil takes the functionality from the plan package and presents a more high-level API.

GetStepName analyzes the last step in a plan and returns the step id and: 1.

LookupByResourceIdQuery can be used to find a deployment by a resource-id (can be any kind e.g.

NewReverseLookupQuery can be used to look up a deployment's ID by specifying the resource kind and ID (elasticsearch, 6779ce55fc0646309ef812d007bb2526).

StepErrorOrUnknownError returns the last step message as an error except when the step InfoLog is empty, in which case it returns errorPlanFailedUnknown.

Stream prints a text formatted line on each TrackResponse received by the channel, unless the sender closes the channel when it has finished, calling this function will block execution until the received channel is closed.

StreamFunc is the underlying function used by Stream and StreamJSON.

StreamJSON prints a json formatted line for on each TrackResponse received by the channel, if pretty is set to true, the message will be intended with 2 spaces.

TrackChange iterates over a deployment's resources pending plans, sending updates to the returned channel in the form of TrackResponse every frequency period configured in the parameter's TrackFrequencyConfig.

ErrPlanFinished is returned when a cluster has no plan PlanStepInfo.

FailureDetails contains the details for a failure.

TrackChangeParams is consumed by TrackChange.

TrackFrequencyConfig controls how the TrackChange function polls the API.

TrackResponse is returned by Track and indicates the progress of a pending plan.