mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-30 12:10:22 -07:00
Adjust YAML in module docs (#10240)
* Adjust YAML in module docs. * adjust modules --------- Co-authored-by: Alexei Znamensky <russoz@gmail.com>
This commit is contained in:
Felix Fontein
GitHub
parent
e938ca5f20
commit
e8f965fbf8
89 changed files with 2085 additions and 1675 deletions
|
|
@ -49,219 +49,219 @@ EXAMPLES = r"""
|
|||
|
||||
RETURN = r"""
|
||||
result:
|
||||
description: List with dictionary contains jobs info
|
||||
returned: success
|
||||
type: list
|
||||
sample: [
|
||||
{
|
||||
description: List with dictionary contains jobs info.
|
||||
returned: success
|
||||
type: list
|
||||
sample:
|
||||
[
|
||||
{
|
||||
"Affinities": null,
|
||||
"AllAtOnce": false,
|
||||
"Constraints": null,
|
||||
"ConsulToken": "",
|
||||
"CreateIndex": 13,
|
||||
"Datacenters": [
|
||||
"dc1"
|
||||
],
|
||||
"Dispatched": false,
|
||||
"ID": "example",
|
||||
"JobModifyIndex": 13,
|
||||
"Meta": null,
|
||||
"ModifyIndex": 13,
|
||||
"Multiregion": null,
|
||||
"Name": "example",
|
||||
"Namespace": "default",
|
||||
"NomadTokenID": "",
|
||||
"ParameterizedJob": null,
|
||||
"ParentID": "",
|
||||
"Payload": null,
|
||||
"Periodic": null,
|
||||
"Priority": 50,
|
||||
"Region": "global",
|
||||
"Spreads": null,
|
||||
"Stable": false,
|
||||
"Status": "pending",
|
||||
"StatusDescription": "",
|
||||
"Stop": false,
|
||||
"SubmitTime": 1602244370615307000,
|
||||
"TaskGroups": [
|
||||
{
|
||||
"Affinities": null,
|
||||
"AllAtOnce": false,
|
||||
"Constraints": null,
|
||||
"ConsulToken": "",
|
||||
"CreateIndex": 13,
|
||||
"Datacenters": [
|
||||
"dc1"
|
||||
],
|
||||
"Dispatched": false,
|
||||
"ID": "example",
|
||||
"JobModifyIndex": 13,
|
||||
"Meta": null,
|
||||
"ModifyIndex": 13,
|
||||
"Multiregion": null,
|
||||
"Name": "example",
|
||||
"Namespace": "default",
|
||||
"NomadTokenID": "",
|
||||
"ParameterizedJob": null,
|
||||
"ParentID": "",
|
||||
"Payload": null,
|
||||
"Periodic": null,
|
||||
"Priority": 50,
|
||||
"Region": "global",
|
||||
"Spreads": null,
|
||||
"Stable": false,
|
||||
"Status": "pending",
|
||||
"StatusDescription": "",
|
||||
"Stop": false,
|
||||
"SubmitTime": 1602244370615307000,
|
||||
"TaskGroups": [
|
||||
{
|
||||
"Affinities": null,
|
||||
"Constraints": null,
|
||||
"Count": 1,
|
||||
"EphemeralDisk": {
|
||||
"Migrate": false,
|
||||
"SizeMB": 300,
|
||||
"Sticky": false
|
||||
},
|
||||
"Meta": null,
|
||||
"Migrate": {
|
||||
"HealthCheck": "checks",
|
||||
"HealthyDeadline": 300000000000,
|
||||
"MaxParallel": 1,
|
||||
"MinHealthyTime": 10000000000
|
||||
},
|
||||
"Name": "cache",
|
||||
"Networks": null,
|
||||
"ReschedulePolicy": {
|
||||
"Attempts": 0,
|
||||
"Delay": 30000000000,
|
||||
"DelayFunction": "exponential",
|
||||
"Interval": 0,
|
||||
"MaxDelay": 3600000000000,
|
||||
"Unlimited": true
|
||||
},
|
||||
"RestartPolicy": {
|
||||
"Attempts": 3,
|
||||
"Delay": 15000000000,
|
||||
"Interval": 1800000000000,
|
||||
"Mode": "fail"
|
||||
},
|
||||
"Scaling": null,
|
||||
"Services": null,
|
||||
"ShutdownDelay": null,
|
||||
"Spreads": null,
|
||||
"StopAfterClientDisconnect": null,
|
||||
"Tasks": [
|
||||
{
|
||||
"Affinities": null,
|
||||
"Artifacts": null,
|
||||
"CSIPluginConfig": null,
|
||||
"Config": {
|
||||
"image": "redis:3.2",
|
||||
"port_map": [
|
||||
{
|
||||
"db": 6379.0
|
||||
}
|
||||
]
|
||||
},
|
||||
"Constraints": null,
|
||||
"DispatchPayload": null,
|
||||
"Driver": "docker",
|
||||
"Env": null,
|
||||
"KillSignal": "",
|
||||
"KillTimeout": 5000000000,
|
||||
"Kind": "",
|
||||
"Leader": false,
|
||||
"Lifecycle": null,
|
||||
"LogConfig": {
|
||||
"MaxFileSizeMB": 10,
|
||||
"MaxFiles": 10
|
||||
},
|
||||
"Meta": null,
|
||||
"Name": "redis",
|
||||
"Resources": {
|
||||
"CPU": 500,
|
||||
"Devices": null,
|
||||
"DiskMB": 0,
|
||||
"IOPS": 0,
|
||||
"MemoryMB": 256,
|
||||
"Networks": [
|
||||
{
|
||||
"CIDR": "",
|
||||
"DNS": null,
|
||||
"Device": "",
|
||||
"DynamicPorts": [
|
||||
{
|
||||
"HostNetwork": "default",
|
||||
"Label": "db",
|
||||
"To": 0,
|
||||
"Value": 0
|
||||
}
|
||||
],
|
||||
"IP": "",
|
||||
"MBits": 10,
|
||||
"Mode": "",
|
||||
"ReservedPorts": null
|
||||
}
|
||||
]
|
||||
},
|
||||
"RestartPolicy": {
|
||||
"Attempts": 3,
|
||||
"Delay": 15000000000,
|
||||
"Interval": 1800000000000,
|
||||
"Mode": "fail"
|
||||
},
|
||||
"Services": [
|
||||
{
|
||||
"AddressMode": "auto",
|
||||
"CanaryMeta": null,
|
||||
"CanaryTags": null,
|
||||
"Checks": [
|
||||
{
|
||||
"AddressMode": "",
|
||||
"Args": null,
|
||||
"CheckRestart": null,
|
||||
"Command": "",
|
||||
"Expose": false,
|
||||
"FailuresBeforeCritical": 0,
|
||||
"GRPCService": "",
|
||||
"GRPCUseTLS": false,
|
||||
"Header": null,
|
||||
"InitialStatus": "",
|
||||
"Interval": 10000000000,
|
||||
"Method": "",
|
||||
"Name": "alive",
|
||||
"Path": "",
|
||||
"PortLabel": "",
|
||||
"Protocol": "",
|
||||
"SuccessBeforePassing": 0,
|
||||
"TLSSkipVerify": false,
|
||||
"TaskName": "",
|
||||
"Timeout": 2000000000,
|
||||
"Type": "tcp"
|
||||
}
|
||||
],
|
||||
"Connect": null,
|
||||
"EnableTagOverride": false,
|
||||
"Meta": null,
|
||||
"Name": "redis-cache",
|
||||
"PortLabel": "db",
|
||||
"Tags": [
|
||||
"global",
|
||||
"cache"
|
||||
],
|
||||
"TaskName": ""
|
||||
}
|
||||
],
|
||||
"ShutdownDelay": 0,
|
||||
"Templates": null,
|
||||
"User": "",
|
||||
"Vault": null,
|
||||
"VolumeMounts": null
|
||||
}
|
||||
],
|
||||
"Update": {
|
||||
"AutoPromote": false,
|
||||
"AutoRevert": false,
|
||||
"Canary": 0,
|
||||
"HealthCheck": "checks",
|
||||
"HealthyDeadline": 180000000000,
|
||||
"MaxParallel": 1,
|
||||
"MinHealthyTime": 10000000000,
|
||||
"ProgressDeadline": 600000000000,
|
||||
"Stagger": 30000000000
|
||||
},
|
||||
"Volumes": null
|
||||
}
|
||||
],
|
||||
"Type": "service",
|
||||
"Update": {
|
||||
"AutoPromote": false,
|
||||
"AutoRevert": false,
|
||||
"Canary": 0,
|
||||
"HealthCheck": "",
|
||||
"HealthyDeadline": 0,
|
||||
"MaxParallel": 1,
|
||||
"MinHealthyTime": 0,
|
||||
"ProgressDeadline": 0,
|
||||
"Stagger": 30000000000
|
||||
"Count": 1,
|
||||
"EphemeralDisk": {
|
||||
"Migrate": false,
|
||||
"SizeMB": 300,
|
||||
"Sticky": false
|
||||
},
|
||||
"VaultNamespace": "",
|
||||
"VaultToken": "",
|
||||
"Version": 0
|
||||
}
|
||||
"Meta": null,
|
||||
"Migrate": {
|
||||
"HealthCheck": "checks",
|
||||
"HealthyDeadline": 300000000000,
|
||||
"MaxParallel": 1,
|
||||
"MinHealthyTime": 10000000000
|
||||
},
|
||||
"Name": "cache",
|
||||
"Networks": null,
|
||||
"ReschedulePolicy": {
|
||||
"Attempts": 0,
|
||||
"Delay": 30000000000,
|
||||
"DelayFunction": "exponential",
|
||||
"Interval": 0,
|
||||
"MaxDelay": 3600000000000,
|
||||
"Unlimited": true
|
||||
},
|
||||
"RestartPolicy": {
|
||||
"Attempts": 3,
|
||||
"Delay": 15000000000,
|
||||
"Interval": 1800000000000,
|
||||
"Mode": "fail"
|
||||
},
|
||||
"Scaling": null,
|
||||
"Services": null,
|
||||
"ShutdownDelay": null,
|
||||
"Spreads": null,
|
||||
"StopAfterClientDisconnect": null,
|
||||
"Tasks": [
|
||||
{
|
||||
"Affinities": null,
|
||||
"Artifacts": null,
|
||||
"CSIPluginConfig": null,
|
||||
"Config": {
|
||||
"image": "redis:3.2",
|
||||
"port_map": [
|
||||
{
|
||||
"db": 6379.0
|
||||
}
|
||||
]
|
||||
},
|
||||
"Constraints": null,
|
||||
"DispatchPayload": null,
|
||||
"Driver": "docker",
|
||||
"Env": null,
|
||||
"KillSignal": "",
|
||||
"KillTimeout": 5000000000,
|
||||
"Kind": "",
|
||||
"Leader": false,
|
||||
"Lifecycle": null,
|
||||
"LogConfig": {
|
||||
"MaxFileSizeMB": 10,
|
||||
"MaxFiles": 10
|
||||
},
|
||||
"Meta": null,
|
||||
"Name": "redis",
|
||||
"Resources": {
|
||||
"CPU": 500,
|
||||
"Devices": null,
|
||||
"DiskMB": 0,
|
||||
"IOPS": 0,
|
||||
"MemoryMB": 256,
|
||||
"Networks": [
|
||||
{
|
||||
"CIDR": "",
|
||||
"DNS": null,
|
||||
"Device": "",
|
||||
"DynamicPorts": [
|
||||
{
|
||||
"HostNetwork": "default",
|
||||
"Label": "db",
|
||||
"To": 0,
|
||||
"Value": 0
|
||||
}
|
||||
],
|
||||
"IP": "",
|
||||
"MBits": 10,
|
||||
"Mode": "",
|
||||
"ReservedPorts": null
|
||||
}
|
||||
]
|
||||
},
|
||||
"RestartPolicy": {
|
||||
"Attempts": 3,
|
||||
"Delay": 15000000000,
|
||||
"Interval": 1800000000000,
|
||||
"Mode": "fail"
|
||||
},
|
||||
"Services": [
|
||||
{
|
||||
"AddressMode": "auto",
|
||||
"CanaryMeta": null,
|
||||
"CanaryTags": null,
|
||||
"Checks": [
|
||||
{
|
||||
"AddressMode": "",
|
||||
"Args": null,
|
||||
"CheckRestart": null,
|
||||
"Command": "",
|
||||
"Expose": false,
|
||||
"FailuresBeforeCritical": 0,
|
||||
"GRPCService": "",
|
||||
"GRPCUseTLS": false,
|
||||
"Header": null,
|
||||
"InitialStatus": "",
|
||||
"Interval": 10000000000,
|
||||
"Method": "",
|
||||
"Name": "alive",
|
||||
"Path": "",
|
||||
"PortLabel": "",
|
||||
"Protocol": "",
|
||||
"SuccessBeforePassing": 0,
|
||||
"TLSSkipVerify": false,
|
||||
"TaskName": "",
|
||||
"Timeout": 2000000000,
|
||||
"Type": "tcp"
|
||||
}
|
||||
],
|
||||
"Connect": null,
|
||||
"EnableTagOverride": false,
|
||||
"Meta": null,
|
||||
"Name": "redis-cache",
|
||||
"PortLabel": "db",
|
||||
"Tags": [
|
||||
"global",
|
||||
"cache"
|
||||
],
|
||||
"TaskName": ""
|
||||
}
|
||||
],
|
||||
"ShutdownDelay": 0,
|
||||
"Templates": null,
|
||||
"User": "",
|
||||
"Vault": null,
|
||||
"VolumeMounts": null
|
||||
}
|
||||
],
|
||||
"Update": {
|
||||
"AutoPromote": false,
|
||||
"AutoRevert": false,
|
||||
"Canary": 0,
|
||||
"HealthCheck": "checks",
|
||||
"HealthyDeadline": 180000000000,
|
||||
"MaxParallel": 1,
|
||||
"MinHealthyTime": 10000000000,
|
||||
"ProgressDeadline": 600000000000,
|
||||
"Stagger": 30000000000
|
||||
},
|
||||
"Volumes": null
|
||||
}
|
||||
],
|
||||
"Type": "service",
|
||||
"Update": {
|
||||
"AutoPromote": false,
|
||||
"AutoRevert": false,
|
||||
"Canary": 0,
|
||||
"HealthCheck": "",
|
||||
"HealthyDeadline": 0,
|
||||
"MaxParallel": 1,
|
||||
"MinHealthyTime": 0,
|
||||
"ProgressDeadline": 0,
|
||||
"Stagger": 30000000000
|
||||
},
|
||||
"VaultNamespace": "",
|
||||
"VaultToken": "",
|
||||
"Version": 0
|
||||
}
|
||||
]
|
||||
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue