Kovair DevOps and Kubernetes Integration Plugin

Kubernetes Plugin Details

Overview

Kubernetes Information:

Version Supported:

Plugin Operations:

1. DeployFile

This operation deploys a file in Kubernetes Cluster.

Input parameter(s):

Parameter	Is Mandatory	Help Text
File Name	true	Provide the name of the file to be created along with file extension. For Kubernetes, it makes sense to deploy a JSON or a YAML file.
Deployment Location	true	Provide the location in the system where Agent Service is running and where the file will be deployed, this should start from Linux file system root (/). Please ensure necessary privileges of the user account in the provided path through which the Agent Service is running.
File Content	true	Provide the content of the file here.

Output parameter(s):

Parameter	Help Text
Status	Status of file deployment operation.
DeployedAt	Location where file has been deployed. Value in this output parameter will be obtained only when deployment has been successful.

2. DeleteFile

This operation deletes the specified file.

Input parameter(s):

Parameter	Is Mandatory	Help Text
File Path	true	Provide the complete path of the file starting from Linux file system root(/) with file extension.Please ensure necessary privileges of the user account in the provided path through which the Agent Service is running.

Output parameter(s):

Parameter	Help Text
Status	Status of file delete operation.

3. CreateNamespace

This operation creates namespace in Kubernetes Cluster.

Input parameter(s):

Parameter	Is Mandatory	Help Text
Namespace Name	false	Provide the name of the namespace to be created in the cluster. Ensure following Kubernetes’s naming convention.
File Path	false	Provide the path of JSON/YAML file based on which new namespace will be created. The JSON/YAML file should be physically present in the system where command will be run.

Output parameter(s):

Parameter	Help Text
Status	Status of namespace create operation.
OutputLog	Output log of the operation.

4. CreateJob

This operation creates a normal/scheduled job in Kubernetes Cluster.

Input parameter(s):

Parameter	Is Mandatory	Help Text
Job Name	false	Provide the name of the job to be created.Ensure following Kubernetes’s naming convention.
Image Name	false	Provide the name of the Image to be used in job creation.
File Path	false	Provide the path of the JSON/YAML file in which the job is defined.Please ensure necessary privileges of the user account in the provided path through which the Agent Service is running.

Note: End user need to provide value for either ‘Job Name’ and ‘Image Name’ or ‘File Path’. If ‘Job Name’ and ‘Image Name’ are provided, then Job will be created based on the supplied values; if ‘File Path’ is provided, the Job will be created based on the template file whose path is provided. If all are provided, then ‘File Path’ parameter value will be considered.

Output parameter(s):

Parameter	Help Text
Status	Status of job creation operation.
OutputLog	Output log of the operation.

5. CheckJobStatus

This operation checks the status of the specified job.

Input parameter(s):

Parameter	Is Mandatory	Help Text
Job Name	true	Provide the name of the job whose status is to be checked.

Output parameter(s):

Parameter	Help Text
Status	Status of the operation.
OutputLog	Output log of the operation.

6. DeleteJob

This operation deletes the specified job.

Input parameter(s):

Parameter	Is Mandatory	Help Text
Job Name	true	Provide the name of the job which is to be deleted.

Output parameter(s):

Parameter	Help Text
Status	Status of job delete operation.
OutputLog	Output log of the operation.

7. CreateDeployment

Creates a deployment or job to manage the created container(s).

Input parameter(s):

Parameter	Is Mandatory	Help Text
Deployment Name	false	Provide the name of the deployment to be created.
Image Name	false	Provide the name of the image to be used while creating the deployment.
Other Optional Parameters	false	Provide other optional flags for creating a deployment. e.g.: Replicas / Environment Variables / Port etc. maintaining proper syntax.
File Path	false	Provide the path of JSON/YAML file based on which new deployment will be created. Please ensure necessary privileges of the user account in the provided path through which the Agent Service is running.

Output parameter(s):

Parameter	Help Text
Status	Status of deployment operation.
OutputLog	Output log of the operation.

8. ExecuteGenericCommand

This operation executes the supplied command in Kubernetes Cluster.

Input parameter(s):

Parameter	Is Mandatory	Help Text
Command	true	Provide the command here.

Output parameter(s):

Parameter	Help Text
Status	Status of the execution of command.
OutputLog	Output log of the operation.

Pass/Fail Conditions:

Status	Condition	Method
Passed	If ‘OutputLog’ is empty.	DeployFile / DeleteFile
Failed	If ‘OutputLog’ is not empty.	DeployFile / DeleteFile
Passed	If ‘OutputLog’ contains the word ‘created’.	CreateNamespace / CreateJob / CreateDeployment
Failed	If ‘OutputLog’ does not contain the word ‘created’.	CreateNamespace / CreateJob / CreateDeployment
Passed	If ‘OutputLog’ contains the word ‘deleted’.	DeleteJob
Failed	If ‘OutputLog’ does not contain the word ‘deleted’.	DeleteJob
Passed	If ‘OutputLog’ does not contain the word ‘not found’.	CheckJobStatus
Failed	If ‘OutputLog’ contains the word ‘not found’.	CheckJobStatus
Passed	If ‘OutputLog’ does not contain the word ‘error’.	ExecuteGenericCommand
Failed	If ‘OutputLog’ contains the word ‘error’.	ExecuteGenericCommand

Limitations:

Release Details:

Contact us: