Comment on page

Cron Workflows

Using the Pipekit CLI with Cron Workflows

The Pipekit CLI provides create (equivalent to submit for regular workflows), delete, suspend, resume, and update commands for a Cron Workflow.
For further information about Cron Workflows, please refer to our Cron Workflow documentation.
Create and update cron
To create a new Cron Workflow on a given cluster:
$> pipekit create cron --cluster-name=clusterB ./path/to/workflow.yaml
This will create a new Cron Workflow, and a Pipe based on the Cron Workflow name (part of the metadata inside the yaml). If such a Pipe already exists, a new Cron Workflow will be associated with it as well.
Note that you will not be able to create two Cron Workflows with the same name, on the same cluster, in the same namespace. You must therefore check the namespace specified in the meta part of your Cron Workflow yaml.
To update an existing Cron Workflow, on a given cluster:
$> pipekit update cron --cluster-name=clusterB ./path/to/workflow.yaml
Flag
Shorthand
Type
Description
--cluster-name
-c
string
name of the cluster to create a Cron Workflow on (required)
Delete cron
To delete a Cron Workflow, from a given cluster, in a given namespace:
$> pipekit delete cron --cluster-name=clusterB --namespace=foo cron-wf-name
The argument passed to this command is the name of the Cron Workflow (which should correspond to the Pipe name).
Flag
Shorthand
Type
Description
--cluster-name
-c
string
name of the cluster from which to delete (required)
--namespace
-n
string
namespace in which the Cron Workflow is located
Suspend and resume cron
To suspend a Cron Workflow, on a given cluster, in a given namespace:
$> pipekit suspend cron --cluster-name=clusterB --namespace=staging cron-wf-name
To resume a suspended Cron Workflow, on a given cluster, in a given namespace:
$> pipekit resume cron --cluster-name=clusterB --namespace=staging cron-wf-name
The only argument that these commands accept is the name of the Cron Workflow to suspend/resume.
Flag
Shorthand
Type
Description
--cluster-name
-c
string
name of the cluster from which to suspend (required)
--namespace
-n
string
namespace in which the Cron Workflow is located
Trigger cron
To run a Cron Workflow immediately, on a given cluster, in a given namespace:
$> pipekit trigger cron --cluster-name=clusterB --namespace=staging cron-wf-name
The only argument that this command accepts is the name of the Cron Workflow to trigger.
Flag
Shorthand
Type
Description
--cluster-name
-c
string
name of the cluster from which to suspend (required)
--namespace
-n
string
namespace in which the Cron Workflow is located
--open-ui
​
bool
open UI for the submitted workflow
--wait
-w
bool
wait for the submitted workflow to complete

Flag	Shorthand	Type	Description
--cluster-name	-c	string	name of the cluster to create a Cron Workflow on (required)

Flag	Shorthand	Type	Description
--cluster-name	-c	string	name of the cluster from which to delete (required)
--namespace	-n	string	namespace in which the Cron Workflow is located

Flag	Shorthand	Type	Description
--cluster-name	-c	string	name of the cluster from which to suspend (required)
--namespace	-n	string	namespace in which the Cron Workflow is located

Flag	Shorthand	Type	Description
--cluster-name	-c	string	name of the cluster from which to suspend (required)
--namespace	-n	string	namespace in which the Cron Workflow is located
--open-ui		bool	open UI for the submitted workflow
--wait	-w	bool	wait for the submitted workflow to complete

Last modified 5d ago