Install Runbooks

Runbooks in OneLens allow you to automate actions across your cloud environment with minimal manual effort. Before you install your first runbook, you'll need to complete a one-time setup in your AWS accounts. Once that’s done, installing a runbook becomes a simple, account-level action.

One Time Setup

To allow OneLens to deploy and run automation safely, a one-time AWS environment setup is required. This step ensures OneLens can securely initiate and manage changes via your AWS Systems Manager.

Step-by-Step Guide

OneLens will automatically prompt you with the one time setup steps when you attempt your first runbook installation.

1. Setup a Delegated Account

Begin by setting up a delegated account from your master account. This account will be used to manage resources and permissions across multiple AWS accounts.

Important

The master/payer account cannot be used as a delegated account. Ensure you create the delegated account from the master account, not as the master account itself.

2. Enable AWS Change Manager

After the delegated account setup, enable AWS Systems Manager Change Manager in that account. This step is essential for enabling OneLens to execute changes securely across your cloud infrastructure.

For detailed steps on enabling Change Manager, refer to the Enable Change Manager.

3. Deploy CFT as a Stack in the Delegated Account

In the delegated account, deploy the OneLens CloudFormation Template (CFT) as a CloudFormation Stack. This step sets up the necessary permissions and resources that OneLens needs to operate.

🔗 Delegated Account CFT URL:

https://prod-onyx-backend.s3.ap-south-1.amazonaws.com/onyx/aws/cft/onyx-master.template.json

Note

If you are using a Master-Child (Multi-Account) setup, complete the StackSet deployment for your child accounts. If you are managing a single account, simply follow the previous steps and do not run the StackSet.

For detailed steps on deploying the CFT (both as a Stack in the delegated account and as a StackSet for child accounts), refer to the Deploy CFT (Stack and StackSet).

4. Deploy the CFT as a StackSet for Child Accounts

Once the CFT has been deployed in the delegated account, use a CloudFormation StackSet from the delegated account to deploy the CFT to all child accounts. This ensures that each child account is configured with the required resources.

Child Accounts CFT URL:

https://prod-onyx-backend.s3.ap-south-1.amazonaws.com/onyx/aws/cft/onyx-child.template.json

CFT Verification

To verify or inspect any of the CloudFormation templates before deploying, click on the respective link provided above.

Installing a Runbook

Once the setup is complete, here’s how you can install a runbook:

1. Open the particular runbook page in the OneLens UI.

1. Click the Install button at the bottom right of the page. This will open the Accounts Tab where you can see all your connected AWS accounts.

1. In the Accounts Tab, locate the specific account where you want to install the runbook.

1. Click the Install button next to the account you want to deploy the runbook to.

OneLens will then deploy the runbook using the permissions granted during one time setup.

Uninstall Runbook

After installation, the Install button changes to Uninstall, allowing you to remove the runbook if needed.