Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 25 additions & 19 deletions docs/manual/jobs/job-plugins/node-steps/kubernetes-create-object.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,38 @@

## Overview

This plugin creates an 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/).
This plugin creates an 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.

The types of objects that can be created within a Kubernetes cluster include:
- **ConfigMaps**
- **DaemonSets**
- **Deployments**
- **Jobs**
- **Namespaces**
- **Pods**
- **ReplicaSets**
- **Secrets**
- **Services**
- **StatefulSets**

## Configuration

### Required Fields
### Prerequisites

* **YAML Definition**: The YAML definition of the object to be created.
* **Namespace**: The namespace where the object will be created. Default is `default`.

### Optional Fields

* **Object Type**: Select the type of object to create (e.g., Pods, ConfigMaps, Deployments). Default is "Pods".
* **Output Format**: Choose the format for the output (JSON or YAML). Default is JSON.
Before configuring the Kubernetes Create 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).

## Usage
### Add Kubernetes Create Object Step
When building a Job, add the **Kubernetes / Clusters / Create Object** node step:

1. Select the desired object type from the dropdown menu.
2. Provide the YAML definition for the object you want to create.
3. Specify the namespace where the object should be created.
4. Choose the preferred output format.
![Kubernetes Create Object](/assets/img/k8s-clusters-create-object.png)<br>

## Authentication
* **Object Type**: Select the type of object to create (Pods, ConfigMaps, Deployments, etc.)
* **YAML Definition**: The YAML definition of the object to be created. This can be a data-variable that is passed from a prior step - such as a YAML definition that is retrieved from a git repository.
* **Namespace**: The namespace where the object will be created. Default is `default`.
* **Output Format**: Choose the format for the output (JSON or YAML). Default is JSON.

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:
### Invocation Output

1. When disabled, the plugin uses the cloud provider credentials set in the resource model to retrieve the
kube-config for the targeted cluster.
The output of the step will be the object that was created in the Kubernetes cluster. The output format will be the same as the format selected in the step configuration:

2. When enabled, the [Enterprise Runner](/administration/runner/) must be placed in the cluster and uses its pod's K8s service account for authentication.
![Kubernetes Create Object Output](/assets/img/k8s-create-object-output.png)<br>
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To learn more about debugging in Kubernetes with ephemeral containers, see the [

## Setup

Follow the steps outlined in the [**Kubernetes Plugins Overview**](/manual/plugins/kubernetes-plugins-overview) to configure authentication for Kubernetes Job steps.
Follow the steps outlined in the [**Kubernetes Plugins Overview**](/manual/plugins/kubernetes-open-source.md) to configure authentication for Kubernetes Job steps.
Credentials can be configured on a per Job Step basis, Project basis, or for the entire Runbook Automation system.

To see property syntax for configuring properties at the Project or System level, navigate to **System Menu** (gear icon in the upper-right) -> **Plugins** -> **Installed Plugins**.
Expand Down
47 changes: 29 additions & 18 deletions docs/manual/jobs/job-plugins/node-steps/kubernetes-delete-object.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,44 @@

## Overview

This plugin deletes an 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/).

This plugin deletes an 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.

The types of objects that can be deleted within a Kubernetes cluster include:

- **ConfigMaps**
- **DaemonSets**
- **Deployments**
- **Jobs**
- **Namespaces**
- **PersistentVolumes**
- **Pods**
- **ReplicaSets**
- **Secrets**
- **Services**
- **StatefulSets**

## Configuration

### Required Fields
### Prerequisites

* **Name**: The name of the object to be deleted, such as Pod name or Deployment name.
* **Namespace**: The namespace where the object resides. Default is `default`.
Before configuring the Kubernetes Delete 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).

### Optional Fields
### Add Kubernetes Delete Object Step

* **Object Type**: Select the type of object to delete (e.g., Pods, ConfigMaps, Deployments). Default is "Pods".
* **Output Format**: Choose the format for the output (JSON or YAML). Default is JSON.
When building a Job, add the **Kubernetes / Clusters / Delete Object** node step:

## Usage
![Kubernetes Delete Object](/assets/img/k8s-clusters-delete-object.png)<br>

1. Select the desired object type from the dropdown menu.
2. Provide the name of the object you want to delete.
3. Specify the namespace where the object is located.
4. Choose the preferred output format.
Configure the following fields:

* **Object Type**: Select the type of object to delete (e.g., Pods, ConfigMaps, Deployments).
* **Name**: The name of the object to be deleted, such as Pod name or Deployment name.
* **Namespace**: The namespace where the object resides.
* **Output Format**: Choose the format for the output (JSON or YAML).

## Authentication
### Invocation Output

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:
The output of the step will be the object that was deleted in the Kubernetes cluster. The output format will be the same as the format selected in the step configuration:

1. When disabled, the plugin uses the cloud provider credentials set in the resource model to retrieve the
kube-config for the targeted cluster.
![Kubernetes Delete Object Output](/assets/img/k8s-delete-object-output.png)<br>

2. When enabled, the [Enterprise Runner](/administration/runner/) must be placed in the cluster and uses its pod's K8s service account for authentication.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Setup

Follow the steps outlined in the [**Kubernetes Plugins Overview**](/manual/plugins/kubernetes-plugins-overview) to configure authentication for Kubernetes Job steps.
Follow the steps outlined in the [**Kubernetes Plugins Overview**](/manual/plugins/kubernetes-open-source.md) to configure authentication for Kubernetes Job steps.
Credentials can be configured on a per Job Step basis, Project basis, or for the entire Runbook Automation system.

To see property syntax for configuring properties at the Project or System level, navigate to **System Menu** (gear icon in the upper-right) -> **Plugins** -> **Installed Plugins**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,48 @@

## Overview

This plugin describes an 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/).
This plugin describes an 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.

The types of objects that can be described within a Kubernetes cluster include:

- **ConfigMaps**
- **CronJobs**
- **DaemonSets**
- **Deployments**
- **Ingresses**
- **Jobs**
- **Namespaces**
- **Nodes**
- **PersistentVolumes**
- **PersistentVolumeClaims**
- **Pods**
- **ReplicaSets**
- **Secrets**
- **Services**
- **StatefulSets**
- **StorageClasses**

## Configuration

### Required Fields
### Prerequisites

* **Name**: The name of the object to be described, such as Pod name or Deployment name.
* **Namespace**: The namespace where the object resides. Default is `default`.
Before configuring the Kubernetes Describe 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).

### Optional Fields
### Add Kubernetes Describe Object Step

* **Object Type**: Select the type of object to describe (e.g., Pods, ConfigMaps, Deployments). Default is "Pods".
* **Output Format**: Choose the format for the output (JSON or YAML). Default is JSON.
When building a Job, add the **Kubernetes / Clusters / Describe Object** node step:

## Usage
![Kubernetes Describe Object](/assets/img/k8s-clusters-describe-object.png)<br>

1. Select the desired object type from the dropdown menu.
2. Provide the name of the object you want to describe.
3. Specify the namespace where the object is located.
4. Choose the preferred output format.
Configure the following fields:

## Authentication
* **Object Type**: Select the type of object to describe (e.g., Pods, ConfigMaps, Deployments).
* **Name**: The name of the object to be described, such as Pod name or Deployment name.
* **Namespace**: The namespace where the object resides.
* **Output Format**: Choose the format for the output (JSON or YAML).

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:
### Invocation Output

1. When disabled, the plugin uses the cloud provider credentials set in the resource model to retrieve the
kube-config for the targeted cluster.
The output of the step will be the object that was described in the Kubernetes cluster. The output format will be the same as the format selected in the step configuration:

2. When enabled, the [Enterprise Runner](/administration/runner/) must be placed in the cluster and uses its pod's K8s service account for authentication.
![Kubernetes Describe Object Output](/assets/img/k8s-describe-object-output.png)<br>
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Setup

Follow the steps outlined in the [**Kubernetes Plugins Overview**](/manual/plugins/kubernetes-plugins-overview) to configure authentication for Kubernetes Job steps.
Follow the steps outlined in the [**Kubernetes Plugins Overview**](/manual/plugins/kubernetes-open-source.md) to configure authentication for Kubernetes Job steps.
Credentials can be configured on a per Job Step basis, Project basis, or for the entire Runbook Automation system.

To see property syntax for configuring properties at the Project or System level, navigate to **System Menu** (gear icon in the upper-right) -> **Plugins** -> **Installed Plugins**.
Expand Down
63 changes: 39 additions & 24 deletions docs/manual/jobs/job-plugins/node-steps/kubernetes-list-objects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,54 @@

## Overview

This plugin lists objects 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/).
This plugin lists objects 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.

The types of objects that can be listed within a Kubernetes cluster include:

- **ConfigMaps**
- **Cron Jobs**
- **Custom Resource Definitions**
- **DaemonSets**
- **Deployments**
- **Ingresses**
- **Jobs**
- **Namespaces**
- **Nodes**
- **Persistent Volumes**
- **Persistent Volume Claims**
- **Pods**
- **Pod Disruption Budgets**
- **ReplicaSets**
- **Secrets**
- **Services**
- **StatefulSets**
- **Storage Classes**

## Configuration

### Required Fields
### Prerequisites

* **Namespace**: The namespace to list objects from. Default is `default`.

### Optional Fields

* **Object Type**: Select the type of object to list (e.g., Pods, ConfigMaps, Deployments). Default is "Pods".
* **All Namespaces**: If selected, retrieve objects from across all namespaces. The 'Namespace' field will be ignored.
* **Label Selector**: Filter objects based on labels. Supports equality-based and set-based selectors.
* **Field Selector**: Filter objects based on fields. Supports equality-based and set-based selectors.
* **Output Format**: Choose the format for the output (Simple List, JSON, or YAML). Default is "Simple List".
Before configuring the Kubernetes List Objects 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).

## Usage
### Add Kubernetes List Objects Step

1. Select the desired object type from the dropdown menu.
2. Specify the namespace or choose to list from all namespaces.
3. Optionally, add label or field selectors to filter the results.
4. Choose the preferred output format.
When building a Job, add the **Kubernetes / Clusters / List Objects** node step:

## Authentication
![Kubernetes List Objects](/assets/img/k8s-clusters-list-objects.png)<br>

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:
Configure the following fields:

1. When disabled, the plugin uses the cloud provider credentials set in the resource model to retrieve the
kube-config for the targeted cluster.
* **Object Type**: Select the type of object to list (e.g., Pods, ConfigMaps, Deployments).
* **Namespace**: The namespace to list objects from. Default is `default`.
* **All Namespaces**: If selected, retrieve objects from across all namespaces. The 'Namespace' field will be ignored.
* **Label Selector**: Filter objects based on labels. Supports equality-based and set-based selectors.
* - For detailed information on field selectors, refer to the [Kubernetes documentation on field selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/).
* **Field Selector**: Filter objects based on fields. Supports equality-based and set-based selectors.
* For detailed information on label selectors, refer to the [Kubernetes documentation on label selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors).
* **Output Format**: Choose the format for the output (Simple List, JSON, or YAML).

2. When enabled, the [Enterprise Runner](/administration/runner/) must be placed in the cluster and uses its pod's K8s service account for authentication.
### Invocation Output

## Notes
The output of the step will be the objects that were listed in the Kubernetes cluster. The output format will be the same as the format selected in the step configuration:

- For detailed information on label selectors, refer to the [Kubernetes documentation on label selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors).
- For detailed information on field selectors, refer to the [Kubernetes documentation on field selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/field-selectors/).
![Kubernetes List Objects Output](/assets/img/k8s-clusters-list-objects-output.png)<br>
35 changes: 18 additions & 17 deletions docs/manual/jobs/job-plugins/node-steps/kubernetes-object-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,37 @@

## Overview

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/)
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.

The types of objects that can be viewed logs from within a Kubernetes cluster include:

- **Pods**

## Configuration

### Required Fields
### Prerequisites

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).

### Add Kubernetes Object Logs Step

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

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

Configure the following fields:

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

## Usage

1. Provide the name of the object you want to view logs from.
2. Specify the namespace where the object is located.
3. Optionally, specify a particular container, number of log lines, time-span, or choose to follow logs.

## Authentication

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:
### Invocation Output

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

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

## Notes

Expand Down
Loading
Loading