change and update readme

ericsysmin · Mar 5, 2024 · 9dfd15c · 9dfd15c
1 parent e2eb9ab
commit 9dfd15c
Show file tree

Hide file tree

Showing 5 changed files with 74 additions and 71 deletions.
diff --git a/README.md b/README.md
@@ -6,8 +6,8 @@ Ansible collection that holds roles, that can be used to configure common kubern
 
 | Role    | Build Status                                                                                                                                                                                                                                                                      | Documentation                                                                                            |
 | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| kubectl | [![ericsysmin.kubernetes.kubectl](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kubectl.yml/badge.svg)](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kubectl.yml) | [Documentation](https://github.com/ericsysmin/ansible-collection-kubernetes/blob/master/docs/kubectl.md) |
-| kompose | [![ericsysmin.kubernetes.kompose](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kompose.yml/badge.svg)](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kompose.yml) | [Documentation](https://github.com/ericsysmin/ansible-collection-kubernetes/blob/master/docs/kompose.md) |
+| kubectl | [![ericsysmin.kubernetes.kubectl](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kubectl.yml/badge.svg)](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kubectl.yml) |  |
+| kompose | [![ericsysmin.kubernetes.kompose](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kompose.yml/badge.svg)](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kompose.yml) |  |
 
 ## Usage
 

diff --git a/docs/kompose.md b/docs/kompose.md
diff --git a/docs/kubectl.md b/docs/kubectl.md
diff --git a/roles/kompose/readme.md b/roles/kompose/readme.md
@@ -0,0 +1,36 @@
+# ericsysmin.kubernetes.kompose
+
+[![ericsysmin.kubernetes.kompose](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kompose.yml/badge.svg)](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kompose.yml)
+
+This role installs kompose on linux systems.
+
+## Requirements
+
+None
+
+## Role Variables
+
+| Variable          | Required | Default  | Comments                           |
+| ----------------- | -------- | -------- | ---------------------------------- |
+| `kompose_version` | No       | `1.32.0` | Version of Kompose to be installed |
+
+## Dependencies
+
+None
+
+## Example Playbook
+
+```yaml
+- hosts: servers
+  roles:
+    - role: ericsysmin.kompose
+      kompose_version: 1.17.0
+```
+
+## License
+
+MIT
+
+## Author Information
+
+[ericsysmin](https://ericsysmin.com)
diff --git a/roles/kubectl/readme.md b/roles/kubectl/readme.md
@@ -0,0 +1,36 @@
+# ericsysmin.kubernetes.kubectl
+
+[![ericsysmin.kubernetes.kubectl](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kubectl.yml/badge.svg)](https://github.com/ericsysmin/ansible-collection-kubernetes/actions/workflows/kubectl.yml)
+
+A brief description of the role goes here.
+
+## Requirements
+
+None
+
+## Role Variables
+
+| Variable          | Required | Default | Comments                           |
+| ----------------- | -------- | ------- | ---------------------------------- |
+| `kubectl_version` | No       | `1.29`  | Version of kubectl to be installed |
+
+## Dependencies
+
+None
+
+## Example Playbook
+
+```yaml
+- hosts: servers
+    roles:
+      - role: ericsysmin.kubectl
+        kubectl_version: 1.29
+```
+
+## License
+
+MIT
+
+## Author Information
+
+[ericsysmin](https://ericsysmin.com)