Add types to arguments

This commit is contained in:
Fabian von Feilitzsch
2020-02-18 13:01:41 -05:00
parent 75bf82d42c
commit 14bc933a21

View File

@@ -28,7 +28,8 @@ description:
- Authenticate using either a config file, certificates, password or token. - Authenticate using either a config file, certificates, password or token.
- Supports check mode. - Supports check mode.
- Analogous to `kubectl logs` or `oc logs` - Analogous to `kubectl logs` or `oc logs`
extends_documentation_fragment:
- community.kubernetes.k8s_auth_options
options: options:
api_version: api_version:
description: description:
@@ -39,6 +40,7 @@ options:
aliases: aliases:
- api - api
- version - version
type: str
kind: kind:
description: description:
- Use to specify an object model. Use in conjunction with I(api_version), I(name), and I(namespace) to identify a - Use to specify an object model. Use in conjunction with I(api_version), I(name), and I(namespace) to identify a
@@ -46,28 +48,31 @@ options:
- If using I(label_selector), cannot be overridden - If using I(label_selector), cannot be overridden
required: no required: no
default: Pod default: Pod
type: str
namespace: namespace:
description: description:
- Use to specify an object namespace. Use in conjunction with I(api_version), I(kind), and I(name) - Use to specify an object namespace. Use in conjunction with I(api_version), I(kind), and I(name)
to identify a specfic object. to identify a specfic object.
type: str
name: name:
description: description:
- Use to specify an object name. Use in conjunction with I(api_version), I(kind) and I(namespace) to identify a - Use to specify an object name. Use in conjunction with I(api_version), I(kind) and I(namespace) to identify a
specific object. specific object.
- Only one of I(name) or I(label_selector) may be provided - Only one of I(name) or I(label_selector) may be provided
type: str
label_selectors: label_selectors:
description: description:
- List of label selectors to use to filter results - List of label selectors to use to filter results
- Only one of I(name) or I(label_selector) may be provided - Only one of I(name) or I(label_selector) may be provided
type: list
elements: str
container: container:
description: description:
- Use to specify the container within a pod to grab the log from. - Use to specify the container within a pod to grab the log from.
- If there is only one container, this will default to that container. - If there is only one container, this will default to that container.
- If there is more than one container, this option is required. - If there is more than one container, this option is required.
required: no required: no
type: str
extends_documentation_fragment:
- community.kubernetes.k8s_auth_options
requirements: requirements:
- "python >= 2.7" - "python >= 2.7"
@@ -145,7 +150,7 @@ class KubernetesLogModule(KubernetesAnsibleModule):
name=dict(), name=dict(),
namespace=dict(), namespace=dict(),
container=dict(), container=dict(),
label_selectors=dict(type='list', default=[]), label_selectors=dict(type='list', elements='str', default=[]),
) )
) )
return args return args