Skip to content

Commit e78dde4

Browse files
committed
Updated requirements in readme
1 parent fd2d1fc commit e78dde4

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Rundeck Kubernetes Plugin
22

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

55
Use cases:
66

@@ -13,6 +13,8 @@ Use cases:
1313
These plugins require the python kubernetes SDK to be installed on the rundeck server.
1414
For example, you can install it using `pip install kubernetes`.
1515

16+
The Python Kubernetes API client requires version 11 of the library. You can confirm it with `python -m pip list | grep kubernetes`.
17+
1618
Further information here: [https://github.com/kubernetes-client/python](https://github.com/kubernetes-client/python).
1719

1820
### Authentication for Tectonic Environments.
@@ -51,7 +53,7 @@ This plugin allows getting the container pods from kubernetes as rundeck nodes.
5153
* **Default attributes**: List of key=value pairs, example: username=root
5254
* **Custom Mapping**: Custom mapping adding on the rundeck nodes, for example: ```nodename.selector=default:Name,hostname.selector=default:pod_id```
5355

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:
5557
```tag.selector=default:image, tag.selector=default:status, kubernetes```
5658

5759
* **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.
8789

8890

8991
## File Copier
90-
This plugin allows copy files from rundeck to a pod.
92+
This plugin allows copy files from rundeck to a pod.
9193
For now just script and text files can be copied to a remote pod.
9294

9395
**Configurations:**
@@ -101,18 +103,18 @@ For now just script and text files can be copied to a remote pod.
101103
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.
102104

103105
### Create / Update / Delete / Check / Wait a Deployment
104-
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.
105107

106108
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))
107109

108110
### Create / Update / Delete Services
109111

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

112114

113115
### Create / Delete / Re-run Jobs
114116

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

117119
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.
118120

@@ -128,4 +130,3 @@ These steps provide a generic way to create/delete resources on kubernetes using
128130
* PersistentVolume
129131
* PersistentVolumeClaim
130132
* Secret
131-

0 commit comments

Comments
 (0)