Actions is a scheduling automation system that integrates a playbook with an alert module to manage administrative tasks in a Pulse UI-interactive mode. You can, for example, implement an action that kills an application that has been operating for longer than the given SLA duration.
You need a private key for authorized user on respective server for running defined playbook. Only an Admin or Data Steward type of user can create, edit, and run an action.
To create a playbook, see Custom Playbook.
Click Actions > Actions from the left navigation bar to view the list of actions. The Actions page is displayed.
Action Table
The following table describes the details displayed in the action table:
| Property Name | Description |
|---|---|
| Name | Specifies the name of the action that was provided while creating the action. |
| Enabled | Displays if the action is enabled or disabled. |
| Scheduled | Specifies the status of the Action. If the action is scheduled, displays the time at the the action is scheduled. If the action is unscheduled, displays Not Scheduled. |
| Last Status | Specifies the status of the action whether action had succeeded or failed or created. |
| Last Execution | Specifies the date and time for when the action was last executed. |
Creating an Action
To create an action, click the Create Action button from the Actions page. The Create Actions page is displayed. Select a runbook to create an action. An Action Wizard is displayed. The Action Wizard consists of stock playbooks provided by Acceldata, if you choose to create playbook of your choice, click here.
Action Wizard is followed by the following four steps:
Step 1
The following are the runbooks available; select the runbook for which you want to create an action:
- Hive Canary Action
- Validate Kerberos Ticket Generation#validate-kerberos-ticket-generation
- DNS Lookup#dns-lookup
- Hive Analyze Table#hive-analyse-table
- Ambari Admin Utilities#ambari-admin-utilities
- Hive concatenate table#hive-concatenate-table
- ZK open connections#zk-open-connections
- Hive table metadata#hive-table-metadata
- HDFS top-10 Directories#hdfs-top-10-directories
- Local Log Cleanup#local-log-cleanup
- HDFS data Utilities#hdfs-data-utilities
- Check Path Accessibility#check-path-accessibility
- Echo Text#echo-text
- Open Port Text#open-port-text
- API Call#api-call
- HDFS Log Cleanup#hdfs-log-cleanup
- Hbase Compact Tables#hbase-compact-tables
- HDFS Admin Utilities#hdfs-admin-utilities
- Hive Purge Table#hive-purge-table
- Hbase Hbck Action#hbase-hbck-action
- Hive Straggler Queries#hive-straggler-queries
- Fire Command#fire-command
- HDFS Balancer#hdfs-balancer
- Hive Compact Table#hive-compact-table
- Kill Tez Queries#Kill Tez Queries
- YARN Kill App
- Kill Impala Queries (CDP)
- Kill Impala Queries
Hive Canary Action
Creates an action script to raise an alert when the hive query time deviation crosses a threshold.
Enter the following parameters and click Next:
- Hive Query to Execute: Enter the hive query that you want to raise an alert for.
- Deviation Percentage: Enter the deviation percentage.
- Hive URL: Enter the hive URL along with the host.
- Database Name: Enter the name of the database from which the query is executed.
- Username: (Optional) Enter the username to login.
- Password: (Optional) Enter the password.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Validate Kerberos Ticket Generation
Creates an action script to check if kerberos is generating tickets or not.
Enter the following parameters and click Next:
- Keytab File Path: Path of the keytab file of kerberos.
- Principal Name: Name of the principal for which tickets need to be generated.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
DNS Lookup
Creates an action script to check and validate forward/reverse DNS lookup for given host against all cluster hosts.
Enter the following parameters and click Next:
- Host Name: Enter the Hostname for forward lookup.
- IP Address: Enter an IP Address for reverse lookup
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Hive Analyse Table
Creates an action script to gather statistics over table/partition at table/column level.
Enter the following parameters and click Next:
- Hive URL: Enter the Hive jdbc URL.
- Table Name: Enter the table name to fetch metadata output.
- Partition key value: Enter the partition key.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Ambari Admin Utilities
Creates an action script to execute multiple Ambari Actions.
Enter the Action Command and click Next:. Click
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Hive concatenate table
Creates an action script to merge small files for a given managed table/partition.
Enter the following parameters and click Next:
- Hive URL: Enter the Hive jdbc URL.
- Table Name: Enter table name to fetch metadata output.
- Partition key value: Enter the partition key.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
ZK open connections
Creates an action script to find an active and the number of connections opened on the ZK clients.
- Click Next.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Hive table metadata
Creates an action script to get the Hive table's columns' in the metadata formatted output.
Enter the following parameters and click Next:
- Hive URL: Enter the Hive jdbc URL.
- Table Name: Enter table name to fetch metadata output.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
HDFS top-10 Directories
Creates an action script to find the top 10 large directories in the HDFS.
- Click Next.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Local Log Cleanup
Creates an action script to remove the old service logs on the local.
Enter the following parameters and click Next:
- Service Name: Enter the Name of service's log(s) to be removed.
- Log path: Enter the configured log directory for given service, type 'default' for default service's log path
- Retention Days: Enter the logs to be removed older than above input days.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
HDFS data Utilities
Creates an action script to run HDFS admin utilities related data, containing copy, move.
Enter the following parameters and click Next:
- Action Command: Enter the action command to run HDFS admin utilities.
- Source path: Enter the source path HDFS URL.
- Target Path: Enter the Destination path HDFS URL.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Check Path Accessibility
Creates an action to checks if given path is accessible.
Enter the Directory Path to check accessibility and click Next.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Echo Text
Creates an action to Echo a text to the remote machine.
Enter the Echo Text and click Next.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Open Port Text
Creates an action script to test the connection status for given server and port from specified host(s).
Enter the following parameters and click Next.
- Host Name: Enter the destination host name.
- Port Number: Enter the destination port number.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
API Call
Creates an action to call an API.
Enter the following parameters and click Next:
- API URL: Enter the API URL.
- API Method: API method to be used to call the API.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
HDFS Log Cleanup
Creates an action script to remove the old service logs on the HDFS.
Enter the following parameters and click Next:
- Service Name: Enter the Name of service's log(s) to be removed.
- Log path: Enter the configured log directory for given service, type 'default' for default service's log path
- Retention Days: Enter the logs to be removed older than above input days.
- Remove files: Enter Y/N.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Hbase Compact Tables
Creates an action script to compact Hbase region/table/column family.
Enter the following parameters and click Next:
- Hbase Object: Enter the HBase object to be compacted.
- Compaction Type: Enter the HBase compaction type 'major' / 'minor'.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
HDFS Admin Utilities
Creates an action script to run HDFS admin utilities containing fsck, image backup and balancer.
Enter the Action Command to run HDFS admin utilities. Click
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Hive Purge Table
Creates an action script to drop Hive tables using pattern.
Enter the following parameters and click Next:
- Hive URL: Enter the Hive jdbc URL to be used.
- Database Name: Enter the name of the Database to be operated.
- Table Pattern: Enter the tablename or table pattern.
- Drop Check: Enter Y/N.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Hbase Hbck Action
Creates an Action script to run Hbck command to detect and fix the region inconsistencies.
Enter the Action Command. Enter the single operation in the field.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Hive Straggler Queries
Creates an action script to find the list of the long running Tez queries in the cluster.
Enter the following parameters and click Next:
- Time Filter: Enter the time in minutes. Filters the queries that are running more than this value.
- Ambari IPAddress: Enter the IP address of the hosted ambari-server.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Fire Command
Creates an action script to run any command on the given host(s).
Enter the Command to be fired and click Next.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
HDFS Balancer
Creates an action script to run HDFS datanode balancer with network bandwidth option. User requires path privileges and permissions.
Enter the following parameters and click Next:
- (Optional) Network Bandwidth: Enter the network bandwidth consumed by each DataNode, default bandwidth is 500MB/s.
- (Optional)Threshold: Enter the threshold(%) limit for balancer to move data, default threshold is 5.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Hive Compact Table
Creates an action script to run compaction over transactional tables.
Enter the following parameters and click Next:
- Hive URL: Enter the Hive jdbc URL.
- Compact Type: Enter the compaction type major or minor.
- Table Name: Enter table name to fetch metadata output.
- Partition key value: Enter the partition key.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique ID of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) Kerberos Enable: Click on the checkbox if the Kerberos is enabled for your environment. Select the Principle from the drop-down.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Step 2
Enter the following parameters in the step 2 and click Next:
(Optional) Include Hosts: Enter the hosts to include. You can select the hosts by the following two methods:
- Click the Include Host box, select the hosts from the drop-down menu.
- (Optional) Click the
icon next to the include host box, Select Host window pop-ups. Select the host and click Select. The hosts is selected.
(Optional) Exclude Hosts: Enter the hosts to exclude. To select the host click the
icon, Select Host window pop-ups. Select the host and click Select. Runbook: Unique Id of the playbook.
(Optional) Remote User: Click the Remote User box with which the playbook will run on host machine, select the Remote User from the drop-down menu. By default the Remote User will be root.
(Optional) To go to the previous step click Prev.
Step 3 (Optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
(Optional) To disable the notification, click the click here.
Click Next.
You can choose the notification channel, both Email and Slack or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Select the day and time you want to schedule the action.
- Click Save. An Action is created.
Kill Tez Queries
Ends non-LLAP Tez queries that have been running for a long time.
Enter the following parameters and click Next:
- Time Filter: Enter a time limit (in minutes) to kill queries.
- Confirm Kill: To confirm terminating apps, type Y, and to list apps, type N.
- LLAP Queue Name: To avoid stopping long-running apps, add the LLAP queue name.
Step 2
Enter the following parameters in the step 2 and click Next:
- Include Hosts: Comma separated host tags to include when retrieving the associated hosts.
- Exclude Hosts: Comma separated host tags to exclude when retrieving the associated hosts.
- Runbook: The unique identifier of the playbook to be executed.
- Remote User: The remote user with whom the playbook will be run on the host machine. Optional; defaults to 'root'.
Step 3 (optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
(Optional) To disable the notification, click the click here.
Click Next.
You can choose the notification channel, both Email and Slack or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action.
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Select the day and time you want to schedule the action.
- Click Save. An Action is created.
YARN Kill App
This runbook creates an action script to delete a YARN application.
Step 1
- RM Hostname: Enter the hostname or IP address of the resource manager of your cluster.
- applicationID: Enter the ID of the application to be killed. You can enter "any" to automatically select applications based on threshold parameters.
- Memory or Vcore: You must either enter memory or vcore. The threshold will be set for the variable chosen here.
- Threshold Value: Enter the threshold value for the variable selected in the previous step.
- Click Next.
Step 2
- Include Hosts: Enter the host name of the hosts to be included. If you have multiple host names, you can use comma separated names. Click on the field to view host names or click Hosts.
- Exclude Hosts: Enter the host name of the hosts to be excluded. If you have multiple host names, you can use comma separated names. Click on the field to view host names or click Hosts.
- Runbook: The unique ID of the runbook to be executed. Do not alter the value.
- Remote User: Enter the name of the remote user with which the playbook will run on host machine. By default, playbook runs as the root user.
- Kerberos Enable: Select this check box to enable Kerberos. You must also select a Kerberos principle if you enable Kerberos.
- Click Next.
Step 3 (optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action.
- Initial Delay: Specify a value in seconds for the initial delay of the action.
- Description: Enter a description for the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Select the day and time you want to schedule the action.
- Click Save. An Action is created.
Move Pending App Queue
This runbook allows you to change the queue of a YARN application which is in pending state.
Step 1
- Hostname for Resource Manager API: Enter the hostname of the resource manager with port number.
- applicationID: Enter the ID of the application which is pending and needs to be moved. You can enter "any" to automatically select applications based on threshold parameters.
- Elapsed Time: Enter time (in seconds) to filter and move pending applications. Type "na" if you have entered application ID in the previous step.
- Queue Name: Enter the preferred queue name to which the pending application must be moved.
- Click Next.
Step 2
- Include Hosts: Enter the host name of the hosts to be included. If you have multiple host names, you can use comma separated names. Click on the field to view host names or click Hosts.
- Exclude Hosts: Enter the host name of the hosts to be excluded. If you have multiple host names, you can use comma separated names. Click on the field to view host names or click Hosts.
- Runbook: The unique ID of the runbook to be executed. Do not alter the value.
- Remote User: Enter the name of the remote user with which the playbook will run on host machine. By default, playbook runs as the root user.
- Kerberos Enable: Select this check box to enable Kerberos. You must also select a Kerberos principle if you enable Kerberos.
- Click Next.
Step 3 (optional)
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action.
- Initial Delay: Specify a value in seconds for the initial delay of the action.
- Description: Enter a description for the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Select the day and time you want to schedule the action.
- Click Save. An Action is created.
Kill Impala Queries (CDP)
Step 2
Enter the following parameters:
The query will be killed, if any one of these parameters are matched: HDFS Read Threshold, HDFS Write Threshold, Memory Spill Threshold, Query Duration, and Query Substring.
If you have entered the query id, then the above condition will be ignored.
- Cloudera Manager Host: Cloudera manager host in this format
<ip>:<port> - Cluster Name: Name of the cluster
- Auth Basic Token: Authorization token. You can generate the authorization token using the following code:
echo "username:password" | tr -d '\n' | base64 - Query ID: Query id to kill specific query. Fill 'any' to automatically select query based on other threshold parameters.
- HDFS Read Threshold: HDFS read threshold value (in mb) to filter query. Fill 'any' to automatically select query based on other threshold parameters.
- HDFS Write Threshold: HDFS write threshold value (in mb) to filter query. Fill 'any' to automatically select query based on other threshold parameters.
- Memory Spill Threshold: Memory spill threshold value (in mb) to filter query. Fill 'any' to automatically select query based on other threshold parameters.
- Query Duration: Query duration (in secs) to filter query. Fill 'any' to automatically select query based on other threshold parameters.
- Query Substring: Query substring (ex. CREATE/SELECT) to filter query. Fill 'any' to automatically select query based on other threshold parameters.
Step 3
To set up notification, click the click here, setup notification option will be displayed. To set up notification perform the following:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action.
- Initial Delay: Specify a value in seconds for the initial delay of the action.
- Description: Enter a description for the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Select the day and time you want to schedule the action.
- Click Save. An Action is created.
Kill Impala Queries
Step 2
Enter the following parameters:
- Impala Query ID: Impala query which needs to be killed.
- Coordinator Host: Coordinator host for the given Impala query id.
Step 3 (Optional)
To configure notifications, click the click here link to access the setup notification option. Follow these steps to set up notifications:
Email:
- Type an Email address(es) in the Email To box.
- (Optional) You can CC and BCC the notifications to others as well.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
Slack:
- Enter the Slack Webhook URL to get notifications on a Slack channel. You can specify multiple Slack Webhook URLs for different groups or channels by adding commas to separate them.
- Click Notify on. Select the status when the action notification has to be notified from the drop-down menu.
JIRA: This notification type creates a new JIRA ticket.
- Click the Use Default Jira Configuration check box to use the JIRA configs set as organization default. If you select this check box, you need not configure any other fields.
- Notify On: Select when you want to receive JIRA notification. you can either select Completed, Succeeded or Failed.
- Project Key: Enter the project key in which you want to create the JIRA.
- Issue Type: Enter the issue type for the JIRA.
- Labels: Enter labels for the JIRA.
- Priority: Enter a priority for the JIRA.
(Optional) To disable the notification, click the click here.
Click Next.
You can configure the notification channels Email, Slack, and JIRA, or either one of them or none of them. If you do not want to setup notification Click Next.
Step 4
Perform the following in the final step to create an action:
- Name: Enter a name for the action
- Description: Enter a description for the action.
- Initial Delays: Specify a value in seconds for the initial delay of the action.
- Select the Enabled checkbox to enable the action.
- Select the Scheduled checkbox to schedule the action. Once selected, you can either manually enter a Cron Expression or use the Cron Generator to create one by specifying minutes, hours, days, and other parameters.
- Click Save. An Action is created.
Execute Actions
To Execute an action, perform the following:
- Click Execute in the Actions page against the name of the action you want to execute.
- A confirmation dialog box is displayed. Click Ok. The selected action is executed.
View Executions
To view the execution status, click
Edit Actions
From the Actions panel list, click the name of an action you want to edit. The action is displayed in the Actions page. Make your changes and click Save.
Delete Actions
To delete an Action perform the following:
- From the Actions list, click the Remove link from the end of an action row. A confirmation pop-up dialog box is displayed.
- Click Ok. The Action will be deleted.
When the action is deleted, all executions associated with it are deleted as well.
Searching an Action
You can search an Action from the list by using the Search bar. Enter part name or full name of the Action.
Export and Import Actions
You can export and import actions in Pulse. You can use this feature to export and import actions from one cluster to another. The Actions are exported as a JSON format file. Once you export the Actions from a cluster, you can use the import option on another cluster, to import the Actions. Pulse allows you to import JSON format files as Actions. While importing the Action, you must specify various details like list of hosts to be included, list of hosts to be excluded, remote host details, and Kerberos configuration.
To export Actions:
- Navigate to Actions.
- Click the Import & Export Alerts button.
- Click Export Action.
To import Actions:
- Navigate to Actions.
- Click the Import & Export Alerts button.
- Get the JSON file containing the Actions to the Drag file or click to import alerts section by either dragging and dropping the JSON file or by importing it.
- (Optional) Provide the list of hosts whose Actions must be included, in the Include Hosts field. If you have multiple hosts, separate each host with comma.
- (Optional) Provide the list of hosts whose Actions must be excluded, in the Exclude Hosts field. If you have multiple hosts, separate each host with comma.
- (Optional) Select the remote user on whose behalf the Actions must be executed, in the Remote User field.
- (Optional) Select the Kerberos Enable field and provide Kerberos details if you have setup Kerberos.
- Click Submit.
Option to export and import the created playbooks.