Parameter |
Choices/Defaults |
Comments |
api_key
|
|
Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.
|
api_version
|
Default:
v1
|
Use to specify the API version. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with kind, name, and namespace to identify a specific object. If resource definition is provided, the apiVersion from the resource_definition will override this option.
aliases: api, version
|
cert_file
|
|
Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.
|
context
|
|
The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.
|
force
bool |
|
If set to True , and state is present , an existing object will be replaced.
|
host
|
|
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
key_file
|
|
Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
kind
|
|
Use to specify an object model. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with api_version, name, and namespace to identify a specific object. If resource definition is provided, the kind from the resource_definition will override this option.
|
kubeconfig
|
|
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
|
merge_type
list
(added in 2.7) |
Choices:
- json
- merge
- strategic-merge
|
Whether to override the default patch merge approach with a specific type. By the default, the strategic merge will typically be used.
For example, Custom Resource Definitions typically aren't updatable by the usual strategic merge. You may want to use merge if you see "strategic merge patch format is not supported"
Requires openshift >= 0.6.2
If more than one merge_type is given, the merge_types will be tried in order
If openshift >= 0.6.2, this defaults to ['strategic-merge', 'merge'] , which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources. For openshift < 0.6.2, the default is simply strategic-merge .
|
name
|
|
Use to specify an object name. Use to create, delete, or discover an object without providing a full resource definition. Use in conjunction with api_version, kind and namespace to identify a specific object. If resource definition is provided, the metadata.name value from the resource_definition will override this option.
|
namespace
|
|
Use to specify an object namespace. Useful when creating, deleting, or discovering an object without providing a full resource definition. Use in conjunction with api_version, kind, and name to identify a specfic object. If resource definition is provided, the metadata.namespace value from the resource_definition will override this option.
|
password
|
|
Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.
|
resource_definition
|
|
Provide a valid YAML definition (either as a string, list, or dict) for an object when creating or updating. NOTE: kind, api_version, name, and namespace will be overwritten by corresponding values found in the provided resource_definition.
aliases: definition, inline
|
src
|
|
Provide a path to a file containing a valid YAML definition of an object or objects to be created or updated. Mutually exclusive with resource_definition. NOTE: kind, api_version, name, and namespace will be overwritten by corresponding values found in the configuration read in from the src file.
Reads from the local file system. To read from the Ansible controller's file system, use the file lookup plugin or template lookup plugin, combined with the from_yaml filter, and pass the result to resource_definition. See Examples below.
|
ssl_ca_cert
|
|
Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to avoid certificate validation errors. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.
|
state
|
Choices:
present ←
- absent
|
Determines if an object should be created, patched, or deleted. When set to present , an object will be created, if it does not already exist. If set to absent , an existing object will be deleted. If set to present , an existing object will be patched, if its attributes differ from those specified using resource_definition or src.
|
username
|
|
Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.
|
verify_ssl
bool |
|
Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.
|