Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelogs/fragments/187-lowercase-booleans.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
trivial:
- Use lowercase true/false for boolean values in module documentation (https://github.com/openshift/community.okd/issues/187).
4 changes: 2 additions & 2 deletions plugins/modules/k8s.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
type: str
strict:
description: whether to fail when passing unexpected properties
default: True
default: true
type: bool
type: dict
append_hash:
Expand Down Expand Up @@ -134,7 +134,7 @@
- Whether to continue on creation/deletion errors when multiple resources are defined.
- This has no effect on the validation step which is controlled by the C(validate.fail_on_error) parameter.
type: bool
default: False
default: false
version_added: 2.0.0

requirements:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/openshift_adm_groups_sync.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
aliases:
- config
- src
required: True
required: true
deny_groups:
description:
- Denied groups, could be openshift group name or LDAP group dn value.
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/openshift_adm_prune_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
- users
- groups
type: str
required: True
required: true
name:
description:
- Use to specify an object name to remove.
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/openshift_adm_prune_builds.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
- If C(true), prune all builds whose associated BuildConfig no longer exists and whose status is
complete, failed, error, or cancelled.
type: bool
default: False
default: false

requirements:
- python >= 3.6
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/openshift_adm_prune_deployments.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
- If C(true), prune all deployments where the associated DeploymentConfig no longer exists,
the status is complete or failed, and the replica size is C(0).
type: bool
default: False
default: false

requirements:
- python >= 3.6
Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/openshift_adm_prune_images.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
- Include images that were imported from external registries as candidates for pruning.
- If pruned, all the mirrored objects associated with them will also be removed from the integrated registry.
type: bool
default: True
default: true
keep_younger_than:
description:
- Specify the minimum age (in minutes) of an image and its referrers for it to be considered a candidate for pruning.
Expand All @@ -50,7 +50,7 @@
- Specify if images which are exceeding LimitRanges specified in the same namespace,
should be considered for pruning.
type: bool
default: False
default: false
registry_url:
description:
- The address to use when contacting the registry, instead of using the default value.
Expand All @@ -70,17 +70,17 @@
type: bool
prune_registry:
description:
- If set to I(False), the prune operation will clean up image API objects, but
- If set to I(false), the prune operation will clean up image API objects, but
none of the associated content in the registry is removed.
type: bool
default: True
default: true
ignore_invalid_refs:
description:
- If set to I(True), the pruning process will ignore all errors while parsing image references.
- If set to I(true), the pruning process will ignore all errors while parsing image references.
- This means that the pruning process will ignore the intended connection between the object and the referenced image.
- As a result an image may be incorrectly deleted as unused.
type: bool
default: False
default: false
requirements:
- python >= 3.6
- kubernetes >= 12.0.0
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/openshift_build.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
description:
- Specify the namespace for the build or the build config.
type: str
required: True
required: true
build_args:
description:
- Specify a list of key-value pair to pass to Docker during the build.
Expand Down Expand Up @@ -106,7 +106,7 @@
- When C(state=started), specify whether to wait for a build to complete
and exit with a non-zero return code if the build fails.
- When I(state=cancelled), specify whether to wait for a build phase to be Cancelled.
default: False
default: false
type: bool
wait_sleep:
description:
Expand Down
8 changes: 4 additions & 4 deletions plugins/modules/openshift_import_image.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@
description:
- Use to specify namespace for image stream to create/update.
type: str
required: True
required: true
name:
description:
- Image stream to import tag into.
- This can be provided as a list of images streams or a single value.
type: raw
required: True
required: true
all:
description:
- If set to I(true), import all tags from the provided source on creation or if C(source) is specified.
type: bool
default: False
default: false
validate_registry_certs:
description:
- If set to I(true), allow importing from registries that have invalid HTTPS certificates.
Expand All @@ -65,7 +65,7 @@
description:
- Set each imported Docker image to be periodically imported from a remote repository.
type: bool
default: False
default: false
source:
description:
- A Docker image repository to import images from.
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/openshift_registry_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
description:
- Attempt to contact the integrated registry using local client.
type: bool
default: False
default: false

requirements:
- python >= 3.6
Expand Down