mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-05-07 05:22:39 +00:00
Fix the docs for the inventory plugins.
Documenting the structure of the dictionary to pass in needs to be done via suboptions rather than putting the structure directoly inside of the toplevel option.
This commit is contained in:
Toshio Kuratomi
@@ -28,60 +28,61 @@ DOCUMENTATION = '''
|
|||||||
- Optional list of cluster connection settings. If no connections are provided, the default
|
- Optional list of cluster connection settings. If no connections are provided, the default
|
||||||
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
|
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
|
||||||
the active user is authorized to access.
|
the active user is authorized to access.
|
||||||
name:
|
suboptions:
|
||||||
description:
|
name:
|
||||||
- Optional name to assign to the cluster. If not provided, a name is constructed from the server
|
description:
|
||||||
and port.
|
- Optional name to assign to the cluster. If not provided, a name is constructed from the server
|
||||||
kubeconfig:
|
and port.
|
||||||
description:
|
kubeconfig:
|
||||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
description:
|
||||||
options are provided, the OpenShift client will attempt to load the default
|
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||||
configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG
|
options are provided, the OpenShift client will attempt to load the default
|
||||||
environment variable.
|
configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG
|
||||||
context:
|
environment variable.
|
||||||
description:
|
context:
|
||||||
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment
|
description:
|
||||||
variable.
|
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment
|
||||||
host:
|
variable.
|
||||||
description:
|
host:
|
||||||
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
description:
|
||||||
api_key:
|
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
||||||
description:
|
api_key:
|
||||||
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment
|
description:
|
||||||
variable.
|
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment
|
||||||
username:
|
variable.
|
||||||
description:
|
username:
|
||||||
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME
|
description:
|
||||||
environment variable.
|
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME
|
||||||
password:
|
environment variable.
|
||||||
description:
|
password:
|
||||||
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
|
description:
|
||||||
environment variable.
|
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
|
||||||
client_cert:
|
environment variable.
|
||||||
description:
|
client_cert:
|
||||||
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
|
description:
|
||||||
environment variable.
|
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
|
||||||
aliases: [ cert_file ]
|
environment variable.
|
||||||
client_key:
|
aliases: [ cert_file ]
|
||||||
description:
|
client_key:
|
||||||
- Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE
|
description:
|
||||||
environment variable.
|
- Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE
|
||||||
aliases: [ key_file ]
|
environment variable.
|
||||||
ca_cert:
|
aliases: [ key_file ]
|
||||||
description:
|
ca_cert:
|
||||||
- Path to a CA certificate used to authenticate with the API. Can also be specified via
|
description:
|
||||||
K8S_AUTH_SSL_CA_CERT environment variable.
|
- Path to a CA certificate used to authenticate with the API. Can also be specified via
|
||||||
aliases: [ ssl_ca_cert ]
|
K8S_AUTH_SSL_CA_CERT environment variable.
|
||||||
validate_certs:
|
aliases: [ ssl_ca_cert ]
|
||||||
description:
|
validate_certs:
|
||||||
- "Whether or not to verify the API server's SSL certificates. Can also be specified via
|
description:
|
||||||
K8S_AUTH_VERIFY_SSL environment variable."
|
- "Whether or not to verify the API server's SSL certificates. Can also be specified via
|
||||||
type: bool
|
K8S_AUTH_VERIFY_SSL environment variable."
|
||||||
aliases: [ verify_ssl ]
|
type: bool
|
||||||
namespaces:
|
aliases: [ verify_ssl ]
|
||||||
description:
|
namespaces:
|
||||||
- List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized
|
description:
|
||||||
to access.
|
- List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized
|
||||||
|
to access.
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.7"
|
- "python >= 2.7"
|
||||||
|
|||||||
@@ -28,60 +28,61 @@ DOCUMENTATION = '''
|
|||||||
- Optional list of cluster connection settings. If no connections are provided, the default
|
- Optional list of cluster connection settings. If no connections are provided, the default
|
||||||
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
|
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
|
||||||
the active user is authorized to access.
|
the active user is authorized to access.
|
||||||
name:
|
suboptions:
|
||||||
description:
|
name:
|
||||||
- Optional name to assign to the cluster. If not provided, a name is constructed from the server
|
description:
|
||||||
and port.
|
- Optional name to assign to the cluster. If not provided, a name is constructed from the server
|
||||||
kubeconfig:
|
and port.
|
||||||
description:
|
kubeconfig:
|
||||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
description:
|
||||||
options are provided, the OpenShift client will attempt to load the default
|
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||||
configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG
|
options are provided, the OpenShift client will attempt to load the default
|
||||||
environment variable.
|
configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG
|
||||||
context:
|
environment variable.
|
||||||
description:
|
context:
|
||||||
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment
|
description:
|
||||||
variable.
|
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment
|
||||||
host:
|
variable.
|
||||||
description:
|
host:
|
||||||
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
description:
|
||||||
api_key:
|
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
||||||
description:
|
api_key:
|
||||||
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment
|
description:
|
||||||
variable.
|
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment
|
||||||
username:
|
variable.
|
||||||
description:
|
username:
|
||||||
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME
|
description:
|
||||||
environment variable.
|
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME
|
||||||
password:
|
environment variable.
|
||||||
description:
|
password:
|
||||||
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
|
description:
|
||||||
environment variable.
|
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
|
||||||
client_cert:
|
environment variable.
|
||||||
description:
|
client_cert:
|
||||||
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
|
description:
|
||||||
environment variable.
|
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
|
||||||
aliases: [ cert_file ]
|
environment variable.
|
||||||
client_key:
|
aliases: [ cert_file ]
|
||||||
description:
|
client_key:
|
||||||
- Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE
|
description:
|
||||||
environment variable.
|
- Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE
|
||||||
aliases: [ key_file ]
|
environment variable.
|
||||||
ca_cert:
|
aliases: [ key_file ]
|
||||||
description:
|
ca_cert:
|
||||||
- Path to a CA certificate used to authenticate with the API. Can also be specified via
|
description:
|
||||||
K8S_AUTH_SSL_CA_CERT environment variable.
|
- Path to a CA certificate used to authenticate with the API. Can also be specified via
|
||||||
aliases: [ ssl_ca_cert ]
|
K8S_AUTH_SSL_CA_CERT environment variable.
|
||||||
validate_certs:
|
aliases: [ ssl_ca_cert ]
|
||||||
description:
|
validate_certs:
|
||||||
- "Whether or not to verify the API server's SSL certificates. Can also be specified via
|
description:
|
||||||
K8S_AUTH_VERIFY_SSL environment variable."
|
- "Whether or not to verify the API server's SSL certificates. Can also be specified via
|
||||||
type: bool
|
K8S_AUTH_VERIFY_SSL environment variable."
|
||||||
aliases: [ verify_ssl ]
|
type: bool
|
||||||
namespaces:
|
aliases: [ verify_ssl ]
|
||||||
description:
|
namespaces:
|
||||||
- List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized
|
description:
|
||||||
to access.
|
- List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized
|
||||||
|
to access.
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.7"
|
- "python >= 2.7"
|
||||||
|
|||||||
Reference in New Issue
Block a user