From 59b80b9146765382f7fbbeefe401fe33b0df033b Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Fri, 21 Aug 2020 20:07:03 +0530 Subject: [PATCH] docs: Update Kubernetes Guide (#71372) Fixes: #61681 Signed-off-by: Abhijeet Kasurde --- .../rst/scenario_guides/guide_kubernetes.rst | 36 +++++++++++-------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/docs/docsite/rst/scenario_guides/guide_kubernetes.rst b/docs/docsite/rst/scenario_guides/guide_kubernetes.rst index 81b0598ea41b42..abd548de17b088 100644 --- a/docs/docsite/rst/scenario_guides/guide_kubernetes.rst +++ b/docs/docsite/rst/scenario_guides/guide_kubernetes.rst @@ -9,19 +9,19 @@ Requirements To use the modules, you'll need the following: - Run Ansible from source. For assistance, view :ref:`from_source`. -- `OpenShift Rest Client `_ installed on the host that will execute the modules +- `OpenShift Rest Client `_ installed on the host that will execute the modules. Installation and use -------------------- -The individual modules, as of this writing, are not part of the Ansible repository, but they can be accessed by installing the role, `ansible.kubernetes-modules `_, and including it in a playbook. +The Kubernetes modules are part of the `Ansible Kubernetes collection `_. -To install, run the following: +To install the collection, run the following: .. code-block:: bash - $ ansible-galaxy install ansible.kubernetes-modules + $ ansible-galaxy collection install community.kubernetes Next, include it in a playbook, as follows: @@ -29,14 +29,23 @@ Next, include it in a playbook, as follows: --- - hosts: localhost - remote_user: root - roles: - - role: ansible.kubernetes-modules - - role: hello-world + tasks: + - name: Create a pod + community.kubernetes.k8s: + state: present + definition: + apiVersion: v1 + kind: Pod + metadata: + name: "utilitypod-1" + namespace: default + labels: + app: galaxy + spec: + containers: + - name: utilitypod + image: busybox -Because the role is referenced, ``hello-world`` is able to access the modules, and use them to deploy an application. - -The modules are found in the ``library`` folder of the role. Each includes full documentation for parameters and the returned data structure. However, not all modules include examples, only those where `testing data `_ has been created. Authenticating with the API --------------------------- @@ -50,6 +59,5 @@ To disable SSL certificate verification, set ``verify_ssl`` to false. Filing issues ````````````` -If you find a bug or have a suggestion regarding individual modules or the role, please file issues at `OpenShift Rest Client issues `_. - -There is also a utility module, k8s_common.py, that is part of the `Ansible `_ repo. If you find a bug or have suggestions regarding it, please file issues at `Ansible issues `_. +If you find a bug or have a suggestion regarding modules, please file issues at `Ansible Kubernetes collection `_. +If you find a bug regarding OpenShift client, please file issues at `OpenShift REST Client issues `_.