community.okd.openshift inventory – OpenShift inventory source
Note
This inventory plugin is part of the community.okd collection (version 3.0.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.okd
.
You need further requirements to be able to use this inventory plugin,
see Requirements for details.
To use it in a playbook, specify: community.okd.openshift
.
DEPRECATED
- Removed in:
version 4.0.0
- Why:
As discussed in https://github.com/ansible-collections/kubernetes.core/issues/31, we decided to remove the openshift inventory plugin in release 4.0.0.
- Alternative:
Use kubernetes.core.k8s_info and ansible.builtin.add_host instead.
Synopsis
Fetch containers, services and routes for one or more clusters
Groups by cluster name, namespace, namespace_services, namespace_pods, namespace_routes, and labels
Uses openshift.(yml|yaml) YAML configuration file to set parameter values.
Requirements
The below requirements are needed on the local controller node that executes this inventory.
python >= 3.6
kubernetes >= 12.0.0
PyYAML >= 3.11
Parameters
Parameter |
Comments |
---|---|
Optional list of cluster connection settings. If no connections are provided, the default ~/.kube/config and active context will be used, and objects will be returned for all namespaces the active user is authorized to access. |
|
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable. |
|
Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable. |
|
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable. |
|
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable. |
|
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable. |
|
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable. |
|
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable. |
|
Optional name to assign to the cluster. If not provided, a name is constructed from the server and port. |
|
List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized to access. |
|
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable. |
|
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable. |
|
Whether or not to verify the API server’s SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable. Choices:
|
|
token that ensures this is a source file for the ‘openshift’ plugin. Choices:
|
Examples
# File must be named openshift.yaml or openshift.yml
- name: Authenticate with token, and return all pods and services for all namespaces
plugin: community.okd.openshift
connections:
- host: https://192.168.64.4:8443
api_key: xxxxxxxxxxxxxxxx
verify_ssl: false
- name: Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
plugin: community.okd.openshift
connections:
- namespaces:
- testing
- name: Use a custom config file, and a specific context.
plugin: community.okd.openshift
connections:
- kubeconfig: /path/to/config
context: 'awx/192-168-64-4:8443/developer'
Status
This inventory will be removed in version 4.0.0. [deprecated]
For more information see DEPRECATED.