You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-7
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Rundeck Kubernetes Plugin
2
2
3
-
This project provides integration between Rundeck and Kubernetes. This project contains a number of providers allowing job writers to use steps to call various API actions in Kubernetes.
3
+
This project provides integration between Rundeck and Kubernetes. This project contains a number of providers allowing job writers to use steps to call various API actions in Kubernetes.
4
4
5
5
Use cases:
6
6
@@ -13,6 +13,8 @@ Use cases:
13
13
These plugins require the python kubernetes SDK to be installed on the rundeck server.
14
14
For example, you can install it using `pip install kubernetes`.
15
15
16
+
The Python Kubernetes API client requires version 11 of the library. You can confirm it with `python -m pip list | grep kubernetes`.
17
+
16
18
Further information here: [https://github.com/kubernetes-client/python](https://github.com/kubernetes-client/python).
17
19
18
20
### Authentication for Tectonic Environments.
@@ -51,7 +53,7 @@ This plugin allows getting the container pods from kubernetes as rundeck nodes.
51
53
***Default attributes**: List of key=value pairs, example: username=root
52
54
***Custom Mapping**: Custom mapping adding on the rundeck nodes, for example: ```nodename.selector=default:Name,hostname.selector=default:pod_id```
53
55
54
-
***Tags**: List of tags. You can add static and custom tags, for example:
56
+
***Tags**: List of tags. You can add static and custom tags, for example:
***Field Selector**: Filter the list of pods using a response's API fields. For further information check SDK docs [here](https://github.com/kubernetes-client/python/blob/fd5a0c49259e83d928535dd66ab083ddb92ccecf/kubernetes/docs/CoreV1Api.md#return-type-116).
@@ -87,7 +89,7 @@ This plugin allows run commands/scripts to a container pod from rundeck.
87
89
88
90
89
91
## File Copier
90
-
This plugin allows copy files from rundeck to a pod.
92
+
This plugin allows copy files from rundeck to a pod.
91
93
For now just script and text files can be copied to a remote pod.
92
94
93
95
**Configurations:**
@@ -101,18 +103,18 @@ For now just script and text files can be copied to a remote pod.
101
103
The following steps plugins allow you to deploy/un-deploy applications and run/re-run jobs on kubernetes. For example, you can create deployment, services, ingress, etc and update or delete those kubernetes resources.
Theses steps manage deployment resources, you can create, update or delete a deployment and check its status.
106
+
Theses steps manage deployment resources, you can create, update or delete a deployment and check its status.
105
107
106
108
Also, you have a step to wait for a deployment to be ready when the deployment is created. These require that the deployment define a `Readiness Probe` (further information [here](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/#define-readiness-probes))
107
109
108
110
### Create / Update / Delete Services
109
111
110
-
Theses steps manage services resources, you can create, update or delete a service.
112
+
Theses steps manage services resources, you can create, update or delete a service.
111
113
112
114
113
115
### Create / Delete / Re-run Jobs
114
116
115
-
Theses steps manage services resources, you can create or delete a Job.
117
+
Theses steps manage services resources, you can create or delete a Job.
116
118
117
119
Also, you can re-run jobs that are already created. Kubernetes doesn't allow re-run jobs, so what this step does is get the job definition, delete it, and creating it again.
118
120
@@ -128,4 +130,3 @@ These steps provide a generic way to create/delete resources on kubernetes using
0 commit comments