mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-03-26 21:33:02 +00:00
6360763098
minor(doc): use the same style of version_added across repo SUMMARY Currently is no single style of version_added, in some places it's unquoted, somewhere single quote is used, in another places it's double quoted. Moreover, some file had different styles in one single file. The aim of this PR is to update whole repo to single style for version_added ISSUE TYPE Docs Pull Request COMPONENT NAME kustomize helm helm_info helm_plugin helm_plugin_info helm_pull helm_repository helm_template k8s_cluster_info k8s_cp k8s_drain k8s_exec k8s_log k8s_rollback k8s_taint ADDITIONAL INFORMATION The same style is proposed as used in amazon.aws collections Reviewed-by: Kelv Gooding Reviewed-by: Alina Buzachis Reviewed-by: Mike Graves <mgraves@redhat.com>
52 lines
1.5 KiB
Python
52 lines
1.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2020, Red Hat | Ansible
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
# Options for specifying object wait
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
delete_options:
|
|
type: dict
|
|
version_added: 1.2.0
|
|
description:
|
|
- Configure behavior when deleting an object.
|
|
- Only used when I(state=absent).
|
|
suboptions:
|
|
propagationPolicy:
|
|
type: str
|
|
description:
|
|
- Use to control how dependent objects are deleted.
|
|
- If not specified, the default policy for the object type will be used. This may vary across object types.
|
|
choices:
|
|
- "Foreground"
|
|
- "Background"
|
|
- "Orphan"
|
|
gracePeriodSeconds:
|
|
type: int
|
|
description:
|
|
- Specify how many seconds to wait before forcefully terminating.
|
|
- Only implemented for Pod resources.
|
|
- If not specified, the default grace period for the object type will be used.
|
|
preconditions:
|
|
type: dict
|
|
description:
|
|
- Specify condition that must be met for delete to proceed.
|
|
suboptions:
|
|
resourceVersion:
|
|
type: str
|
|
description:
|
|
- Specify the resource version of the target object.
|
|
uid:
|
|
type: str
|
|
description:
|
|
- Specify the UID of the target object.
|
|
"""
|