Quickstart
Run your first Runops Task in 2 minutes.
CLI User Guide#
If your company already uses Runops, head over to the#
Setup#
Install & signupRunning this in the terminal will install Runops and setup your account.
#
Create a TargetA Runops Target is the resource where we run scripts. Let's create a simple python Target:
#
Run Your First TaskNow we can create and run our first Task with a python script.
🎉 Great! You just executed your first Runops task. Now let's run your first real-world Task.
#
Add Configs to TargetsTo make Targets useful we need to add more configurations. Configs enable Tasks to access your real Targets, like databases, AWS Accounts, and more. You can add configs to a Target in two ways: when creating the Target, or updating it after it's created.
#
Create a Target with configsUse the config
flag in the CLI when creating the Target. Provide a JSON with the configs keys and values. The config name must follow the names defined for the integrations for them to become available in the execution.
info
We keep these secrets in a secure vault service. Our Secrets Manager system follow all the best practices. However, you also have the option to self-host this part so Runops systems never touch them, check out Agent Secrets if you need.
#
Update or add configs to a TargetsThe Runops CLI update command always adds the new values and only updates if they already exist. Adding configs to a Target is exactly like creating a target with a config. You use the config
flag. Runops creates the new values, and update existing ones.
#
Test your TargetNow that you added credentials to your Target you can use it to access the resource you want. Let's create a Task using the Target we just configured. Note that we used postgres
as the type, so we'll provide a SQL query in the script:
You have just learned the basics of Runops and ran your first script.
#
Add Slack reviews to TargetsWe define review workflows on Targets, and reviews happen in Slack. Targets have 3 review modes: none, anyone, and teams. Use the runops signup
command to install the Runops Slack app.
⚠️ Make sure to add the Slack bot to your Slack workspace before adding reviews.
none
#
In this mode, tasks don’t have a review workflow. They are ready to run right after they are created. This mode is good for making Targets safe and easy to access. Use this mode for database read-replicas and development cloud accounts.
anyone
#
The anyone mode lets anyone with access to the message in Slack review the Task. It’s suited for an optional peer review flow, and to notify other team members about tasks.
Required option: channel
ℹ️ For reviews on private Slack channels you must add the Runops bot to the channel.
team
#
Use this mode when you need multiple groups to review Tasks for a Target. The team mode requires people from one or more teams to review the task. Every user is a member of a team in Runops. This is the team Runops uses to validate if a given user can make the review. The task is only fully approved after one member of each required team approves it.
Required options: channel
& reviewers
ℹ️ For reviews on private Slack channels you must add the Runops bot to the channel.