Getting Started with Kubernetes and OpenShift¶
Modules for interacting with the Kubernetes (K8s) and OpenShift API are under development, and can be used in preview mode. To use them, review the requirements, and then follow the installation and use instructions.
To use the modules, you’ll need the following:
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.
To install, run the following:
$ ansible-galaxy install ansible.kubernetes-modules
Next, include it in a playbook, as follows:
--- - hosts: localhost remote_user: root roles: - role: ansible.kubernetes-modules - role: hello-world
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¶
By default the OpenShift Rest Client will look for
~/.kube/config, and if found, connect using the active context. You can override the location of the file using the``kubeconfig`` parameter, and the context, using the
Basic authentication is also supported using the
password options. You can override the URL using the
host parameter. Certificate authentication works through the
key_file parameters, and for token authentication, use the
To disable SSL certificate verification, set
verify_ssl to false.
If you find a bug or have a suggestion regarding individual modules or the role, please file issues at OpenShift Rest Client issues.