Use lowercase true/false for boolean values in module documentation (#280)

* docs: use true false for all booleans in docs

* docs: add changelog fragment
This commit is contained in:
Don Naro
2026-08-03 16:48:34 +00:00
committed by GitHub
parent 75b91d1853
commit cc3e4f1a8d
10 changed files with 21 additions and 19 deletions
@@ -0,0 +1,2 @@
trivial:
- Use lowercase true/false for boolean values in module documentation (https://github.com/openshift/community.okd/issues/187).
+2 -2
View File
@@ -83,7 +83,7 @@ options:
type: str
strict:
description: whether to fail when passing unexpected properties
default: True
default: true
type: bool
type: dict
append_hash:
@@ -134,7 +134,7 @@ options:
- 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:
+1 -1
View File
@@ -51,7 +51,7 @@ options:
aliases:
- config
- src
required: True
required: true
deny_groups:
description:
- Denied groups, could be openshift group name or LDAP group dn value.
+1 -1
View File
@@ -37,7 +37,7 @@ options:
- users
- groups
type: str
required: True
required: true
name:
description:
- Use to specify an object name to remove.
@@ -41,7 +41,7 @@ options:
- 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
@@ -41,7 +41,7 @@ options:
- 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
@@ -40,7 +40,7 @@ options:
- 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.
@@ -50,7 +50,7 @@ options:
- 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.
@@ -70,17 +70,17 @@ options:
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
+2 -2
View File
@@ -55,7 +55,7 @@ options:
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.
@@ -106,7 +106,7 @@ options:
- 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:
+4 -4
View File
@@ -36,18 +36,18 @@ options:
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.
@@ -65,7 +65,7 @@ options:
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.
+1 -1
View File
@@ -35,7 +35,7 @@ options:
description:
- Attempt to contact the integrated registry using local client.
type: bool
default: False
default: false
requirements:
- python >= 3.6