Guide to common pipeline operations
apply
command + pipeline configurationgoldsky pipeline apply <path_to_config_file> --status ACTIVE
to deploy the pipeline.
pause
commandgoldsky pipeline pause <name>
will attempt to take a snapshot before pausing the pipeline. The snapshot is successfully taken only if the
pipeline is in a healthy state. After snapshot completes, the pipeline desired status to PAUSED
runtime status to TERMINATED
.
Example:
stop
commandgoldsky pipeline stop <name>
. Unlike the pause
command, stopping a pipeline doesn’t try to take a snapshot. Mirror will directly set pipeline to INACTIVE
desired status and TERMINATED
runtime status.
Example:
apply
command + INACTIVE
or PAUSED
statuspause
and stop
commands using pipeline apply
and setting the --status
flag to INACTIVE
or PAUSED
.
Following up with our previous example, we could stop our deployed pipeline with goldsky pipeline apply <name_or_path_to_config> --status INACTIVE
restart
commandgoldsky pipeline restart <name> --from-snapshot last|none
Example:
apply
command + ACTIVE
statusINACTIVE
you can also restart it by setting it to ACTIVE
Following up with our previous example, we could restart our stopped pipeline with goldsky pipeline apply base-logs-pipeline --status ACTIVE
start
command, this method won’t open up the monitor automatically.
description
and resource_size
of the pipeline using its latest succesful snapshot available and informing Mirror
to not take a snapshot before applying the update. This is a common configuration to apply in a situation where you found issues with your pipeline and would like to restart from the last
healthy checkpoint.
For a more complete reference on the configuration attributes you can apply check this reference.
INACTIVE
don’t consume any resources (and thus, do not imply a billing cost on your side) it’s always nice to keep your project
clean and remove pipelines which you aren’t going to use any longer.
You can delete pipelines with the command goldsky pipeline delete
: