diff --git a/README.md b/README.md index 8c24237f..0e48d442 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ # ansible-kubernetes-modules -Provides access to the latest pre-release K8s modules. Include this role in a playbook, and any other plays or roles will have access to the modules. +Provides access to the latest pre-release K8s modules. + +Include this role in a playbook, and any other plays, roles, and includes will have access to the modules. The modules are found in the [library folder](./library). Each has full documentation for parameters and the returned data structure. However, not all modules will include examples, only those where [test data](https://github.com/openshift/openshift-restclient-python/tree/master/openshift/ansiblegen/examples) has been created. -If you find an issue with a particular module, or have suggestions, please file an issue [here](https://github.com/openshift/openshift-restclient-python/issues). +If you find an issue with a particular module, or have suggestions, please file an issue at the [OpenShift Rest Client repo](https://github.com/openshift/openshift-restclient-python/issues). Requirements ------------ @@ -35,6 +37,17 @@ Once installed, add it to a playbook: Because the role is referenced, the `hello-world` role is able to deploy an applicatoin using the K8s modules. To see contents of the actual role, check in the [tests/roles](./tests/roles) folder. +Authenticating with the API +--------------------------- +The modules interact directly with the Kubernetes or OpenShift API. It is not required that you have the `kubectl` or `oc` CLI tool installed. + +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 `context` parameter. + +Basic authentication is also supported using the `username` and `password` options. You can override the URL using the `host` parameter. Certificate authentication works through the `ssl_ca_cert`, `cert_file`, and `key_file` parameters, and for token authentication, use the `api_key` parameter. + +To disable SSL certificate verification, set `verify_ssl` to false. + + Role Variables -------------- diff --git a/meta/main.yml b/meta/main.yml index 46e019a8..8f509dd8 100644 --- a/meta/main.yml +++ b/meta/main.yml @@ -46,5 +46,7 @@ galaxy_info: - k8s - kubernetes - openshift + - modules + - api dependencies: []