Kubernetes Action

Creating an Action Using Action Type: Kubernetes

Overview

This document provides step-by-step instructions for creating and configuring an action using the Kubernetes action type in Callgoose SQIBS automation platform. The Kubernetes action type allows users to execute Kubernetes operations for container orchestration and automation workflows. Below are the configuration options and their descriptions:

Steps to Add a Kubernetes Action

1. Navigate to Add Action

• Access the automation section in the Callgoose SQIBS automation platform.
• Go to Automation, and you can see Action.
• Click on Action and then click on Add Actions to create a new action.

1. Select Action Type

• Choose Kubernetes as the action type from the list of available options.

1. Copy from Existing Actions

• Copy From:
• Click on Copy From to copy an existing action.
• You can copy actions from:
• Callgoose Actions: Predefined task-based scripts and programs available free of charge.
• Team Actions: Actions shared within your team.
• Global Actions: Actions available globally across the platform.
• Callgoose Actions provide several task-based scripts and programs that you can use and modify according to your requirements.

1. Fill in the Details

• Name*:
• Provide a descriptive name for the action.
• Example: Deploy Kubernetes Resources.
• Description*:
• Add a detailed description of what the action does.
• Example: This action applies Kubernetes YAML files to deploy resources.
• Version:
• Select the required Kubernetes version.
• Example: 1.30.1.
• Success Response*:
• Define the expected output when the operation runs successfully. The success response is similar to the exit status in Linux.
• Example: 0 exit status indicates the script or command executed successfully.

1. Configure Arguments

• Have Argument:
• Choose whether the action requires arguments.
• Yes: Enables input fields to define arguments for the Kubernetes operation.
• No: Indicates that no arguments are required.

1. Set Expected Run Time

• Expected Run Time (in Minutes)*:
• Specify the estimated time for the execution.
• Example: 10 (indicating 10 minutes).

1. Choose Kubernetes Operation

• Apply:
• Kubernetes File:
• Upload the Kubernetes YAML file to be applied.
• Add Commands:
• Add additional kubectl Kubernetes commands to be executed after the kubectl apply operation.
• You can add multiple commands by clicking the + symbol.
• Example:
• kubectl get pod
• kubectl get svc
• kubectl get deployment
• Command:
• Add Commands:
• Add kubectl Kubernetes commands to be executed.
• You can add multiple commands by clicking the + symbol.
• Example:
• kubectl get pod
• kubectl get svc
• kubectl get deployment

1. Upload Multiple Files

• If you have multiple files to upload:
• First, create the action.
• Then, open that action.
• Click on Show Details.
• Click on Edit, and you will be able to see the Other Files option.
• Upload the additional files as required by your Kubernetes setup.
• Click on Save after uploading the files if necessary.

Additional Notes

• Fields marked with an asterisk (*) are mandatory.
• Ensure the Kubernetes YAML files and commands are tested locally before configuring the action to avoid runtime errors.
• Use descriptive names and success responses to make it easier for team members to understand the action.
• The "Expected Run Time" should be realistic to help with workflow monitoring and optimization.

Example Configuration

Name: Deploy Kubernetes Resources

Description: This action applies Kubernetes YAML files to deploy resources.

Version: 1.30.1

Success Response: 0 (indicating the operation executed successfully).

Operation: Apply

Kubernetes File: Upload a file named deployment.yaml.

Add Commands: Add post-operation commands such as kubectl get pods.

Have Argument: Yes

Expected Run Time (in Minutes): 10

Conclusion

By following these steps, you can effectively configure and execute a Kubernetes action in Callgoose SQIBS automation platform. This capability enhances the automation of container orchestration tasks and simplifies workflow management.