Skip to content

Commit 82c2569

Browse files
committed
wrapping up last plugins
1 parent 0541355 commit 82c2569

File tree

9 files changed

+60
-94
lines changed

9 files changed

+60
-94
lines changed
155 KB
Loading
105 KB
Loading
83.2 KB
Loading
84.5 KB
Loading
79.9 KB
Loading

docs/manual/jobs/job-plugins/node-steps/kubernetes-object-logs.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,37 @@
44

55
## Overview
66

7-
This plugin allows you to view the logs of an object within a Kubernetes cluster. It is designed to work in conjunction with the AWS EKS, GCP GKE, and Azure AKS [Resource Model Source plugins](/manual/projects/resource-model-sources/)
7+
This plugin retrieves logs from a specific object within a Kubernetes cluster. Since this is a node-step plugin, multiple Kubernetes clusters or namespaces can be targeted within a single Job.
8+
9+
The types of objects that can be viewed logs from within a Kubernetes cluster include:
10+
11+
- **Pods**
812

913
## Configuration
1014

11-
### Required Fields
15+
### Prerequisites
16+
17+
Before configuring the Kubernetes Object Logs plugin, the target clusters must be added to the Runbook Automation instance and the authentication method must be configured. This is done by following the steps outlined in the [Kubernetes Plugins Overview](/manual/plugins/kubernetes-plugins-overview.md).
18+
19+
### Add Kubernetes Object Logs Step
1220

13-
* **Name**: The name of the object to view logs from, such as Pod name or Deployment name.
14-
* **Namespace**: The namespace where the object resides. Default is `default`.
21+
When building a Job, add the **Kubernetes / Clusters / Object Logs** node step:
1522

16-
### Optional Fields
23+
![Kubernetes Object Logs](/assets/img/k8s-cluster-object-logs.png)<br>
1724

25+
Configure the following fields:
26+
27+
* **Name**: The name of the object to view logs from, such as Pod name.
1828
* **Container**: Specify a particular container to view logs from within the object.
1929
* **Number of Log Lines**: The number of log lines to retrieve. Default is 50.
2030
* **Time-span (seconds)**: A relative time in seconds before the current time from which to show logs.
2131
* **Follow Logs**: If selected, the plugin will follow the log output. Note that the Job may continue to run until manually stopped.
2232

23-
## Usage
24-
25-
1. Provide the name of the object you want to view logs from.
26-
2. Specify the namespace where the object is located.
27-
3. Optionally, specify a particular container, number of log lines, time-span, or choose to follow logs.
28-
29-
## Authentication
30-
31-
Kubernetes Clusters plugins operate on a per-cluster basis and authenticate in one of two ways, as configured in the [Resource Model Plugin](/manual/projects/resource-model-sources/) used to fetch the nodes. This configuration is controlled by the `Use Pod Service Account for Node Steps` option:
33+
### Invocation Output
3234

33-
1. When disabled, the plugin uses the cloud provider credentials set in the resource model to retrieve the
34-
kube-config for the targeted cluster.
35+
The output of the step will be the logs from the object in the Kubernetes cluster:
3536

36-
2. When enabled, the [Enterprise Runner](/administration/runner/) must be placed in the cluster and uses its pod's K8s service account for authentication.
37+
![Kubernetes Object Logs Output](/assets/img/k8s-cluster-logs-output.png)<br>
3738

3839
## Notes
3940

docs/manual/jobs/job-plugins/node-steps/kubernetes-run-command.md

Lines changed: 13 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,24 @@
44

55
## Overview
66

7-
This plugin allows you to execute a command in a pod within a Kubernetes cluster. It is designed to work in conjunction with the AWS EKS, GCP GKE, and Azure AKS [Resource Model Source plugins](/manual/projects/resource-model-sources/).
8-
## Configuration
9-
10-
### Required Fields
11-
12-
* **Pod Name**: The name of the pod to execute the command in.
13-
* **Namespace**: The namespace where the pod resides. Default is `default`.
14-
* **Command**: The command to execute in the pod.
7+
This plugin executes a command in a specified pod within a Kubernetes cluster. Since this is a node-step plugin, multiple Kubernetes clusters or namespaces can be targeted within a single Job.
158

16-
### Optional Fields
17-
18-
* **Container**: Specify a particular container within the pod to execute the command in.
19-
* **Shell**: Specific shell to use for executing the command in the container. Default is `/bin/sh`.
20-
21-
## Usage
9+
## Configuration
2210

23-
1. Provide the name of the pod you want to execute the command in.
24-
2. Specify the namespace where the pod is located.
25-
3. Enter the command you want to execute.
26-
4. Optionally, specify a particular container and/or shell to use.
11+
### Prerequisites
2712

28-
## Authentication
13+
Before configuring the Kubernetes Object Logs plugin, the target clusters must be added to the Runbook Automation instance and the authentication method must be configured. This is done by following the steps outlined in the [Kubernetes Plugins Overview](/manual/plugins/kubernetes-plugins-overview.md).
2914

30-
Kubernetes Clusters plugins operate on a per-cluster basis and authenticate in one of two ways, as configured in the [Resource Model Plugin](/manual/projects/resource-model-sources/) used to fetch the nodes. This configuration is controlled by the `Use Pod Service Account for Node Steps` option:
15+
### Add Kubernetes Run Command Step
3116

32-
1. When disabled, the plugin uses the cloud provider credentials set in the resource model to retrieve the
33-
kube-config for the targeted cluster.
17+
When building a Job, add the **Kubernetes / Clusters / Run Command** node step:
3418

35-
2. When enabled, the [Enterprise Runner](/administration/runner/) must be placed in the cluster and uses its pod's K8s service account for authentication.
19+
![Kubernetes Run Command](/assets/img/k8s-cluster-run-command.png)<br>
3620

37-
## Notes
21+
Configure the following fields:
3822

39-
- Make sure the command you're executing is available in the specified container.
40-
- If no specific container is specified, the command will be executed in the first container of the pod.
41-
- The shell option allows you to choose a different shell if the default `/bin/sh` is not available or if you need to use a different shell for specific commands.
23+
* **Pod Name**: The name of the pod to execute the command in.
24+
* **Namespace**: The namespace where the pod resides.
25+
* **Command**: The command to execute in the pod.
26+
* **Container**: (Optional) Specify a particular container within the pod to execute the command in.
27+
* **Shell**: Specific shell to use for executing the command in the container. Default is `/bin/sh`.

docs/manual/jobs/job-plugins/node-steps/kubernetes-run-script.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,34 @@
44

55
## Overview
66

7-
This plugin executes a script using a predefined container image within a Kubernetes cluster. It deploys a Kubernetes Job to run the script in a container, then deletes the Job after execution. This plugin is designed to work in conjunction with the AWS EKS, GCP GKE, and Azure AKS [Resource Model Source plugins](/manual/projects/resource-model-sources/).
7+
This plugin executes a script using a predefined container image within a Kubernetes cluster. It deploys a Kubernetes Job to run the script in a container, then deletes the Job after execution. Since this is a node-step plugin, multiple Kubernetes clusters or namespaces can be targeted within a single Job.
88

99
## Configuration
1010

11-
### Required Fields
11+
### Prerequisites
1212

13-
* **Script**: The script to execute in the container.
14-
* **Invocation Command**: The command to execute the script in the container. Default is `sh -c`.
15-
* **Container Image**: The container image to use for script execution. Default is `amazon/aws-cli`.
16-
* **Namespace**: The namespace where the Kubernetes Job will be deployed. Default is `default`.
17-
18-
### Optional Fields
19-
20-
* **Environment Variables**: Environment variables to pass to the container (YAML syntax).
21-
* **Image Pull Policy**: The image pull policy for the container. Options are "Always", "IfNotPresent", or "Never". Default is "Always".
13+
Before configuring the Kubernetes Run Script plugin, the target clusters must be added to the Runbook Automation instance and the authentication method must be configured. This is done by following the steps outlined in the [Kubernetes Plugins Overview](/manual/plugins/kubernetes-plugins-overview.md).
2214

23-
## Usage
15+
### Add Kubernetes Run Script Step
2416

25-
1. Enter the script you want to execute.
26-
2. Specify the invocation command (if different from default).
27-
3. Choose the container image to use.
28-
4. Specify the namespace for the Job deployment.
29-
5. Optionally, add environment variables and set the image pull policy.
17+
When building a Job, add the **Kubernetes / Clusters / Run Script** node step:
3018

31-
## Authentication
19+
![Kubernetes Run Script](/assets/img/k8s-cluster-run-script.png)<br>
3220

33-
Kubernetes Clusters plugins operate on a per-cluster basis and authenticate in one of two ways, as configured in the [Resource Model Plugin](/manual/projects/resource-model-sources/) used to fetch the nodes. This configuration is controlled by the `Use Pod Service Account for Node Steps` option:
21+
Configure the following fields:
3422

35-
1. When disabled, the plugin uses the cloud provider credentials set in the resource model to retrieve the
36-
kube-config for the targeted cluster.
37-
38-
2. When enabled, the [Enterprise Runner](/administration/runner/) must be placed in the cluster and uses its pod's K8s service account for authentication.
23+
* **Script**: The script to execute in the container.
24+
* **Invocation Command**: The command to execute the script in the container. Default is `sh -c`.
25+
* **Container Image**: The container image to use for script execution. Default is `amazon/aws-cli`.
26+
* **Namespace**: The namespace where the Kubernetes Job will be deployed. Default is `default`.
27+
* **Environment Variables**: Environment variables to pass to the container (YAML syntax).
28+
* **Image Pull Policy**: The image pull policy for the container. Options include:
29+
* `Always`
30+
* `IfNotPresent`
31+
* `Never`
3932

4033
## Notes
4134

42-
- The Job is automatically deleted after script execution.
35+
- The pod that was used to execute the script is automatically deleted after script execution.
4336
- Environment variables support the 'valueFrom' field for referencing secrets and other sources. See [Kubernetes Docs](https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/) for detailed syntax and examples.
44-
- Predefined container images include options like `amazon/aws-cli`, `bitnami/kubectl`, `mcr.microsoft.com/azure-cli`, `google/cloud-sdk`, and `dtzar/helm-kubectl`, but custom images can also be specified.
37+
- Predefined container images include options like `amazon/aws-cli`, `bitnami/kubectl`, `mcr.microsoft.com/azure-cli`, `google/cloud-sdk`, and `dtzar/helm-kubectl`, but other images may be used.

docs/manual/jobs/job-plugins/node-steps/kubernetes-update-object.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,23 @@
44

55
## Overview
66

7-
This plugin updates a specified object of a selected kind within a Kubernetes cluster. It is designed to work in conjunction with the AWS EKS, GCP GKE, and Azure AKS [Resource Model Source plugins](/manual/projects/resource-model-sources/).
7+
This plugin updates a specified object of a selected kind within a Kubernetes cluster. Since this is a node-step plugin, multiple Kubernetes clusters or namespaces can be targeted within a single Job.
88

99
## Configuration
1010

11-
### Required Fields
11+
### Prerequisites
1212

13-
* **Object Name**: The name of the object to be updated.
14-
* **YAML Definition**: The YAML definition of the object to be updated.
15-
* **Namespace**: The namespace where the object resides. Default is `default`.
16-
17-
### Optional Fields
18-
19-
* **Object Type**: Select the type of object to update (e.g., Pods, Deployments, Services). Default is "Pods".
20-
21-
## Usage
13+
Before configuring the Kubernetes Update Object plugin, the target clusters must be added to the Runbook Automation instance and the authentication method must be configured. This is done by following the steps outlined in the [Kubernetes Plugins Overview](/manual/plugins/kubernetes-plugins-overview.md).
2214

23-
1. Provide the name of the object you want to update.
24-
2. Select the desired object type from the dropdown menu.
25-
3. Enter the updated YAML definition for the object.
26-
4. Specify the namespace where the object is located.
15+
### Add Kubernetes Update Object Step
2716

28-
## Authentication
17+
When building a Job, add the **Kubernetes / Clusters / Update Object** node step:
2918

30-
Kubernetes Clusters plugins operate on a per-cluster basis and authenticate in one of two ways, as configured in the [Resource Model Plugin](/manual/projects/resource-model-sources/) used to fetch the nodes. This configuration is controlled by the `Use Pod Service Account for Node Steps` option:
19+
![Kubernetes Update Object](/assets/img/k8s-cluster-update-object.png)<br>
3120

32-
1. When disabled, the plugin uses the cloud provider credentials set in the resource model to retrieve the
33-
kube-config for the targeted cluster.
21+
Configure the following fields:
3422

35-
2. When enabled, the [Enterprise Runner](/administration/runner/) must be placed in the cluster and uses its pod's K8s service account for authentication.
36-
37-
## Notes
38-
39-
- The plugin uses a field manager named "runbook-automation/apply-patch" for tracking changes.
40-
- Ensure that the YAML definition provided is complete and correct for the object you're updating.
23+
* **Object Name**: The name of the object to be updated.
24+
* **YAML Definition**: The YAML definition of the object to be updated.
25+
* **Namespace**: The namespace where the object resides. Default is `default`.
26+
* **Object Type**: Select the type of object to update (e.g., Pods, Deployments, Services). Default is "Pods".

0 commit comments

Comments
 (0)