Resources API Version


key: name

description:
Name for the resource. Resource group name must be no longer than
80 characters long. It can contain only alphanumeric characters,
dash, underscore, opening parenthesis, closing parenthesis,
and period. The name cannot end with a period.


key: location

description: Specifies the supported Azure location for the resource


key: tags

description: Specifies a dictionary of one or more name and value pairs that describe a tag

type: object


description: Indicate whether the resource exists or if Cloudify should create the resource

default: false


Overrides the Azure-specified "retry_after" response. This property
will set the number of seconds for each task retry interval (in the
case of iteratively checking the status of an asynchronous operation)


A dictionary of values to pass to authenticate with the Azure API


Storage API Version


description:
Name for the resource. Storage account name must be between
3 and 24 characters in length and use numbers and lower-case
letters only.


Name of the Resource Group that the existing resource belongs to
(this is only useful when not using a relationship between a resource
node and a Resource Group node)


key: sku

description: A Storage account SKU if needed.


A dictionary of values to pass as properties when creating the resource


Overrides the Azure-specified "retry_after" response. This propertynwill set the number of seconds for each task retry interval (in the
case of iteratively checking the status of an asynchronous operation)


description:
Name for the resource (include any extension, such as .vhd).
Can be up to 80 characters in length and
contain lowercase letters, numbers, ".", and "_". Must start
with a number or lowercase letter and cannot end with
either "_" or "."


description:
Name for the resource. Can be up to 63 characters in length and
contain lowercase letters, numbers, and dashes. Must start
with a number or lowercase letter and cannot contain
two consecutive dashes.


Network API Version


description: Name for the resource.


Name of the Network Security Group that the existing resource belongs to
(this is only useful when not using a relationship between a resource
node and a Network Security Groupnode)


Name of the Virtual Network that the existing resource belongs to
(this is only useful when not using a relationship between a resource
node and a Virtual Network node)


key: location:


Name of the Network Security Group that the existing resource belongs to
(this is only useful when not using a relationship between a resource
node and a Virtual Network node)


key: primary

description: When using multiple Network Interfaces, a primary must be set


Compute API Version


Tells the deployment to use the public IP (if available) of the resource
for Cloudify Agent connections


key: plan

description:
Specifies information about the marketplace image used to create the virtual
machine. This element is only used for marketplace images.


key: ip

description:
Property specifying the IP address of the resource to
use for the agent installer.


description:
Property specifying what type of operating system family
this compute node will run.

default: linux


This is the suffix for the storage endpoint. Supported values are core.windows.net or local.azurestack.external.


Name of the Virtual Machine that the existing resource belongs to
(this is only useful when not using a relationship between a resource
node and a Virtual Machine node)


description: Specifies the supported Azure location for the resource


description: Specifies a dictionary of one or more name and value pairs that describe a tag


Indicate whether the resource exists or if Cloudify should create the resource


Overrides the Azure-specified "retry_after" response. This property
will set the number of seconds for each task retry interval (in the
case of iteratively checking the status of an asynchronous operation)


A dictionary of values to pass to authenticate with the Azure API


Network API Version


description: Name for the resource.


Name of the Resource Group that the existing resource belongs to
(this is only useful when not using a relationship between a resource
node and a Resource Group node)


A dictionary of values to pass as properties when creating the resource


Path or URL to template file. Ignored if `template` is specified.


key: template

description:
Deployment template. Can be either a string (which will be parsed as
JSON) or a dict (which will be passed as-is to the Azure SDK).


key: params

description: Deployment params


Container service config details


description: SKU details, including location, name, capacity and tier


type: boolean


App config details, including location and plan


description: User details including location, name, kind, user_name,...


Managed Cluster config details, including location, profiles


it will store the kubernetes configuration into a runtime property ['kubeconf'] to
use later to interact with the cluster


Use external resource.


key: id

description: This is the blueprint that the deployment node is a proxy to.


The application blueprint filename. If the blueprint consists many
imported files this is the main blueprint.


The URL of a .zip to upload to the manager.(Can be skipped if external_resource == True)


description: This is the deployment that the node is a proxy to.


key: inputs

description: The inputs to the deployment.


key: outputs

description:
A dictionary of "{ key: value, key: value }".
Get "key" the deployment.
Set "value" runtime property to the value of the output.


Ignored if "outputs" is specified.
Otherwise, if true (the default), then all outputs from the remote
deployment are exposed. If false, then no output is exposed.


key: logs

description: Logs redirect settings, by default {redirect: true}


description: Optional params for executions


key: reexecute

description: Reexecute workflows, on external deployment


key: unvalidated

description: Unvalidated parameters.


key: user

description: The login credentials for ssh server.


key: password

description: optional, ssh password


description: optional, device ip


optional, ssh user key


key: port

description: optional, ssh port


optional, save communication logs


description: optional, list of prompts accepted from device, default is "#/$"

type: array

type: string


key: warnings

description: optional, list of possible warnings without new line


key: errors

description: optional, list of possible errors without new line


key: criticals

description: optional, list of possible criticals without new line


description: optional, command for close connection, default 'exit'

default: exit


optional, use shell extension


The path relative to the blueprint where the file is stored.
Currently this must be packaged in the blueprint. An external URI is
not valid.


The path on the machine where the file should be saved.


key: owner

description: The owner string, such as "centos:wheel"


key: mode

description:
The file permissions, such as 777. Must be provided as an integer.
"0777" and 0777 are not valid. Only 777.


description: Variables to render Jinja templates.


Whether or not to use sudo to move, rename, delete, chown, chmod,
the file.


If the download fails, log the error and continue.


description: The login credentials for ftp server.


description: optional, ftp password


key: ip

description: optional, device ip


description: optional, ftp port


optional, ignore host in ftp response


key: tls

description: optional, use tls connection to ftp


key: client

description:
Client configuration, if empty will be reused manager client:
  host: Host of Cloudify's management machine.
  port: Port of REST API service on management machine.
  protocol: Protocol of REST API service on management machine,
            defaults to http.
  api_version: version of REST API service on management machine.
  headers: Headers to be added to request.
  query_params: Query parameters to be added to the request.
  cert: Path to a copy of the server's self-signed certificate.
  trust_all: if `False`, the server's certificate
            (self-signed or not) will be verified.
  username: Cloudify User username.
  password: Cloudify User password.
  token: Cloudify User token.
  tenant: Cloudify Tenant name.

default: admin


key: plugins

description:
Optional, list of plugins for upload.
  wagon_path: Url for plugin wagon file.
  plugin_yaml_path: Url for plugin yaml file.


key: secrets

description: Optional, dictionary of secrets for set before run deployments.


key: timeout

description: How long (in seconds) to wait for execution to finish before timing out

type: integer


key: interval

description: Polling interval (seconds)


this flag is able to be true only if use_secret_store is true
if this property is false the secret for the key value will be
created, if true then the existing secrets of an existing node
with same key_name will be used as a key, if this property is true
and the secrets does not exist they will be created.


Deprecated. Use resource_config.key_name.


A dictionary of values to pass to configure the key.


description:
Allow the public key material to be stored as a runtime
property. Recommended.


description:
Allow the private key material to be stored as a runtime
property. Not recommended for manager deployments.


terminal credentials, like example:
  user: <user name>
  password: <user password>
  ip: <host name>


description: list files from blueprint to upload


key: files

description: list files with content from blueprint to upload


key: hosts

description: list of hosts name or IP addresses of Rest Servers


key: host

description:
host name or IP addresses of Rest Servers
if list of hosts is not needed single host can be provided by this
property. NOTE: the 'hosts' property overwrite the 'host' property


description:
port number. When -1 default ports are used
(80 for ssl = false and 443 for ssl = true)


key: ssl

description: http or https


key: verify

description:
A boolean which controls whether we verify the server's TLS
certificate. Supported such values:
* `True`: default value, check certificates,
* `False`: ignore server certificates,
* `<file path>`: path to certificate on local system,
* `<certificate content>`: certificate content.


key: cert

description:
Supported such values:
* `None`: default value, ignore client certificates,
* `<file path>`: path to certificate on local system,
* `<certificate content>`: certificate content.


description: Timeout value for requests.


key: proxies

description: List of proxies.


key: params

description: Template parameters. Default is empty dictionary.


description:
Template parameters. Default is empty dictionary. Merged
with params from node properties and has 'ctx' key for
current action context.


Template path in blueprint directory


Save result to runtime properties key. Default is directly
save to runtime properties.


key: prerender

description:
Prerender template before run calls jinja render=>yaml parse.
Default is yaml parse=>jinja render.


Remove calls list from results. Default: save calls in
runtime properties.


Rerun operation if on next operation rerun


Rerun count on warning on caught warnings


Sleep between rerun


key: cloudifyDataTypesAgentConfig

description: Cloudify agent configuration schema.


Specifies how (and if) the cloudify agent should be installed.
Valid values are:
* none - No agent will be installed on the host.
* remote - An agent will be installed using SSH on linux hosts and WinRM on windows hosts.
* init_script - An agent will be installed via a script that will run on the host when it gets created.
                This method is only supported for specific IaaS plugins.
* plugin - An agent will be installed via a plugin which will run a script on the host.
          This method is only supported for specific IaaS plugins.
* provided - An agent is assumed to already be installed on the host image.
            That agent will be configured and started via a script that will run on the host when it gets created.
            This method is only supported for specific IaaS plugins.


Used to set the the cloudify agent service name.

If not set, the default value for the service name is:
- Linux: 'cloudify-worker-<id>'
- Windows: '<id>'

where 'id' is the instance id of the compute node in which the agent is running.

Note: the value in this field, takes precedence over the deprecated
'cloudify.nodes.Compute.cloudify_agent.name'.


key: network

description:
The name of the manager network to which the agent should be
connected. By default, the value will be `default` (which is the
manager's private IP, by default)


key: user

description: For host agents, the agent will be installed for this user.


key: key

description:
For host agents that are installed via SSH, this is the path to the private
key that will be used to connect to the host.
In most cases, this value will be derived automatically during bootstrap.


key: password

description:
For host agents that are installed via SSH (on linux) and WinRM (on windows)
this property can be used to connect to the host.
For linux hosts, this property is optional in case the key property is properly configured
(either explicitly or implicitly during bootstrap).
For windows hosts that are installed via WinRM, this property is also optional
and depends on whether the password runtime property has been set by the relevant IaaS plugin,
prior to the agent installation.


key: port

description:
For host agents that are installed via SSH (on linux) and WinRM (on windows),
this is the port used to connect to the host.
The default values are 22 for linux hosts and 5985 for windows hosts.


description: Process management specific configuration. (type: dictionary)


Minimum number of agent workers. By default, the value will be 0.
Note: For windows based agents, this property is ignored and min_workers is set to the value of max_workers.


Maximum number of agent workers. By default, the value will be 5.


key: heartbeat

description:
The interval of the AMQP heartbeats in seconds
Note: the AMQP heartbeat is only used on Linux.


For linux based agents, disables the requiretty setting in the sudoers file. By default, this value will be true.


key: env

description: Optional environment variables that the agent will be started with. (type: dictionary)


key: extra

description: Optional additional low level configuration details. (type: dictionary)


Indicate whether the resource exists or if Cloudify should create the resource, true if you are bringing an existing resource, false if you want cloudify to create it.


If use_external_resource is ``true`` and the resource is missing,create it instead of failing.


Your OpenStack Client Authorization URL.


key: username

description: Your OpenStack username.


description: Your OpenStack password.


The name of your OpenStack project.


The name of your OpenStack tenant.


The region where you want this particular resource to be created.


The user domain id


The Project domain id


Domain name to operate on.


Project domain name to operate on.


key: logging

description: Logging configuration.


key: insecure

description: If true, SSL validation is skipped.


Path to CA certificate to validate OpenStack's endpoint with.


key: kwargs

description:
A dictionary of keys and values that is not validated
but will override other values in the client config.


key: openstackTypesLogging

description:
For logging groups' configuration. Each level can be one of the following values:
critical/error/warning/info/debug/notset


key: openstack

description: Default logging level for openstack component.


Your OpenStack client configuration.


key: kwargs:

description: A dictionary of keys and values that is not validated but will override other values in the resource config.


key: name

description: Resource name.


key: id

description: Resource id


key: description

description: Resource description.


The administrative state of the network, which is up (true) or down (false).


Indicates whether dhcp is enabled or disabled for the subnet. Default is true.


The ID of the network to which the subnet belongs.


description: List of dns name servers associated with the subnet. Default is an empty list.


description: Allocation pools with start and end IP addresses for this subnet. If allocation_pools are not specified, OpenStack Networking automatically allocates pools for covering all IP addresses in the CIDR, excluding the address reserved for the subnet gateway by default.


description: Additional routes for the subnet. A list of dictionaries with destination and nexthop parameters. Default value is an empty list.


The IP protocol version. Value is 4 or 6.


Gateway IP of this subnet. If the value is null that implies no gateway is associated with the subnet. If the gateway_ip is not specified, OpenStack Networking allocates an address from the CIDR for the gateway for the subnet by default.


key: cidr

description: The CIDR of the subnet.


key: prefixlen

description: The prefix length to use for subnet allocation from a subnet pool. If not specified, the default_prefixlen value of the subnet pool will be used.


The IPv6 address modes specifies mechanisms for assigning IP addresses. Value is slaac, dhcpv6-stateful, dhcpv6-stateless.


The IPv6 router advertisement specifies whether the networking service should transmit ICMPv6 packets, for a subnet. Value is slaac, dhcpv6-stateful, dhcpv6-stateless.


description: A set of zero or more allowed address pair objects each where address pair object contains an ip_address and mac_address. While the ip_address is required, the mac_address will be taken from the port if not specified. The value of ip_address can be an IP Address or a CIDR (if supported by the underlying extension plugin). A server connected to the port can send a packet with source address which matches one of the specified allowed address pairs.


The ID of the device that uses this port. For example, a server instance or a logical router.


The entity type that uses this port. For example, compute:nova (server instance), network:dhcp (DHCP agent) or network:router_interface (router interface).


description:
list.
The IP addresses for the port. If you would like to assign multiple IP addresses for the port, specify multiple entries in this field. Each entry consists of IP address (ip_address) and the subnet ID from which the IP address is assigned (subnet_id).
- If you specify both a subnet ID and an IP address, OpenStack Networking tries to allocate the IP address on that subnet to the port.
- If you specify only a subnet ID, OpenStack Networking allocates an available IP from that subnet to the port.
- If you specify only an IP address, OpenStack Networking tries to allocate the IP address if the address is a valid IP for any of the subnets on the specified network.


description: list. The IDs of security groups applied to the port.


The ID of the network associated with the floating IP.


The Name of the network associated with the floating IP.


The fixed IP address that is associated with the floating IP. If an internal port has multiple associated IP addresses, the service chooses the first IP address unless you explicitly define a fixed IP address in the fixed_ip_address parameter.


The floating IP address.


The ID of a port associated with the floating IP. To associate the floating IP with a fixed IP at creation time, you must specify the identifier of the internal port.


The subnet ID on which you want to create the floating IP.


A valid DNS domain.


A valid DNS name.


The remote group UUID to associate with this security group rule. You can specify either the remote_group_id or remote_ip_prefix attribute in the request body.


key: protocol

description: The IP protocol of the security group rule.


key: direction

description: Ingress or egress, which is the direction in which the security group rule is applied.


The minimum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be less than or equal to the port_range_max attribute value. If the protocol is ICMP, this value must be an ICMP type.


The maximum port number in the range that is matched by the security group rule. If the protocol is TCP, UDP, DCCP, SCTP or UDP-Lite this value must be greater than or equal to the port_range_min attribute value. If the protocol is ICMP, this value must be an ICMP type.


The security group ID to associate with this security group rule.


The remote IP prefix that is matched by this security group rule.


The public ssh key to import. If you omit this value,
a keypair is generated for you


The name of the host aggregate.


Format of the image container.


The format of the disk.


key: tags

description:
List of tags for this image. Each tag is a string of at most 255 chars.
The maximum number of tags allowed on an image is set by the operator.


key: ram

description: The amount of RAM a flavor has, in MiB


key: disk

description:
The size of the root disk that will be created in GiB.
If 0 the root disk will be set to exactly the size of the image used
to deploy the instance. However, in this case filter scheduler cannot
select the compute host based on the virtual image size.
Therefore, 0 should only be used for volume booted instances or for testing purposes.


key: vcpus

description: The number of virtual CPUs that will be allocated to the server.


The ID of the default project for the user.
A user's default project must not be a domain.
Setting this attribute does not grant any actual authorization
on the project, and is merely provided for convenience.
Therefore, the referenced project does not need to exist within the user domain. Since v3.1.
If the user does not have authorization to their default project,
the default project is ignored at token creation. Since v3.1.
Additionally, if your default project is not valid, a token is issued without an explicit scope of authorization


The ID of the domain of the user. If the domain ID is not provided
in the request, the Identity service will attempt to pull the
domain ID from the token used in the request.Note that this requires the use of a domain-scoped token.


key: enabled

description: If the user is enabled, this value is true. If the user is disabled, this value is false


key: password

description: The password for the user.


key: email

description: The email for the user.


The ID of the domain of the group. If the domain ID is not provided
in the request, the Identity service will attempt to pull the
domain ID from the token used in the request.Note that this requires the use of a domain-scoped token.


The ID of the domain of the role. If the domain ID is not provided
in the request, the Identity service will attempt to pull the
domain ID from the token used in the request.Note that this requires the use of a domain-scoped token.


Indicates whether the project also acts as a domain.
If set to true, this project acts as both a project and domain.


The ID of the domain for the project.
For projects acting as a domain, the domain_id must not be specified, it will be generated by the Identity service implementation.


The ID of the parent of the project..


description: A list of simple strings assigned to a project. Tags can be used to classify projects into groups.


The UUID of the project in a multi-tenancy cloud.


key: size

description: The size of the volume, in gibibytes (GiB).


The name of the availability zone.


key: imageRef

description:
The UUID of the image from which you want to create the volume.
Required to create a bootable volume.


To create a volume from an existing snapshot,
specify the UUID of the volume snapshot.
The volume is created in same availability zone and with same size as the snapshot.


The volume type (either name or ID).
To create an environment with multiple-storage back ends, you
must specify a volume type. Block Storage volume back ends are
spawned as children to cinder- volume, and they are keyed from a
unique queue. They are named cinder- volume.HOST.BACKEND. For
example, cinder- volume.ubuntu.lvmdriver. When a volume is
created, the scheduler chooses an appropriate back end to handle
the request based on the volume type. Default is None. For
information about how to use volume types to create multiple-
storage back ends,


The UUID of the project in a multi-tenancy cloud..


description:
A key and value pair that contains additional specifications
that are associated with the volume type.
Examples include capabilities, capacity, compression,
and so on, depending on the storage driver in use.


key: ttl

description: TTL (Time to Live) for the zone.


description: e-mail for the zone. Used in SOA records for the zone


key: type

description:
Type of zone. PRIMARY is controlled by Designate,
SECONDARY zones are slaved from another DNS Server.
Defaults to PRIMARY


key: masters

description:
Mandatory for secondary zones.
The servers to slave from to get DNS information


key: attributes

description:
Key:Value pairs of information about this zone,nand the pool the user would like to place the zone in.
This information can be used by the scheduler to placenzones on the correct pool.


description: TTL (Time to Live) for the recordset.


ID for the zone


description: They RRTYPE of the recordset.


key: records

description:
A list of data for this recordset.
Each item will be a separate record in Designate
These items should conform to the DNS spec for
the record type - e.g. A records must be IPv4 addresses,
CNAME records must be a hostname.


A dictionary that may contain these keys https://developer.openstack.org/api-ref/network/v2/#create-network.


A dictionary that may contain these keys https://developer.openstack.org/api-ref/network/v2/#create-subnet. This is not a list of cloudify.


may be used to request a specific fixed IP for the port.
If the IP is unavailable
(either already taken or does not belong to a subnet the port is on)
an error will be raised.


A dictionary that may contain these keys https://developer.openstack.org/api-ref/network/v2/#create-port.


A dictionary that may contain these keys https://developer.openstack.org/api-ref/network/v2/#create-router.


An external network name or ID.
If given, the router will use this external network as a gateway.


(Applicable only when use_external_resource is true)
If true, then allow using this floating IP even if it has already been allocated to
another instance. If false, and the floating IP is already allocated (that is, it is
in 'ACTIVE' state), a recoverable error is raised.


A dictionary that may contain these keys https://developer.openstack.org/api-ref/network/v2/#create-floating-ip.


a flag for removing the default rules. If not set to `true`,
these rules will remain, and exist alongside any additional rules passed using the `rules` property.


description: List of security groups rule.


A dictionary that may contain these keys https://developer.openstack.org/api-ref/network/v2/#create-security-group.


A dictionary that may contain these keys https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule


The ID of the tenant to which the RBAC policy will be enforced.


The type of the object that the RBAC policy affects.
Types include qos-policy or network.


The ID of the object_type resource. An object_type of
network returns a network ID and an object_type of qos-policy returns a QoS ID.


key: action

description: Action for the RBAC policy which is access_as_external or access_as_shared.


The UUID of the image to use for your server instance.
This is not required in case of boot from volume.
In all other cases it is required
and must be a valid UUID otherwise API will return 400


The flavor reference, as an ID (including a UUID) or
full URL, for the flavor for your server instance.


The availability zone from which to launch the server.
When you provision resources, you specify from which availability
zone you want your instance to be built. Typically,
an admin user will use availability zones to arrange
OpenStack compute hosts into logical groups.
An availability zone provides a form of physical isolation
and redundancy from other availability zones.
For instance, if some racks in your data center are
on a separate power source, you can put servers in those racks
in their own availability zone. Availability zones can
also help separate different classes of hardware.
By segregating resources into availability zones,
you can ensure that your application resources are spread across
disparate machines to achieve high availability
in the event of hardware or other failure.
You can list the available availability zones
by calling the os-availability-zone API,
but you should avoid using the default availability zone when
booting the instance. In general,
the default availability zone is named nova.
This AZ is only shown when listing the availability zones as an admin


Configuration information or scripts to use upon launch.
Must be Base64 encoded. Restricted to 65535 bytes.


key: metadata

description:
Metadata key and value pairs.
The maximum size of the metadata key and value is 255 bytes each.


description:
One or more security groups.
Specify the name of the security group in the name attribute.
If you omit this attribute, the API creates the server
in the default security group. Requested security groups are not
applied to pre-existing ports


key: networks

description:
A list of network object.
Required parameter when there are multiple networks
defined for the tenant. When you do not specify the networks parameter,
the server attaches to the only network created for the current tenant.


Key pair name.


description: updates the os_family default as a convenience

default: windows


updates the defaults for the agent_config for Windows)


description:
Metadata key and value pairs. The maximum size for each metadata key and value pair is 255 bytes
All keys values should be provided as string
Example
metadata:
  ssd: 'True'
  max_number: '1233'


key: hosts

description: list of hosts IDs, which will be a members of host aggregate


The openstack resource URL for the image.


description:
key-value user configuration, according to:
https://developer.openstack.org/api-ref/compute/#create-extra-specs-for-a-flavor


key: tenants

description: List of tenants to add to flavor access


key: groups

description:
List of groups assigned to this project in the following format:
  { name: string, roles: [string] }


key: users

description:
List of users assigned to this project in the following format:
  { name: string, roles: [string] }


key: quota

description:
A dictionary mapping service names to quota definitions for a project
e.g:
  quota:
    compute: <quota>
    network: <quota>
    volume: <quota>


description:
The device name this volume will be attached to.
Default value is *auto*,
which means openstack will auto-assign a device.
Note that if you do explicitly set a value,
this value may not be the actual device name assigned.
Sometimes the device requested will not be available and openstack will assign it to a different device,n	his is why we recommend using *auto*.

default: auto


description:
A full path to your ansible_playbook executable if user don't want to
use the included version of executable in the plugin

default: ansible-playbook


A full path/URL that contain playbook specified in playbook_path
or site_yaml_path.


A path to your `site.yaml` or `main.yaml` in your
Ansible Playbook relative to blueprint or playbook_source_path
if playbook_source_path is URL to archive File relative inside the archive.


DEPRECATED.
A path to your `site.yaml` or `main.yaml` in your
Ansible Playbook relative to blueprint or playbook_source_path
if playbook_source_path is URL to archive File relative inside the archive.


description:
A list of string paths blueprint resources that you
would like to download to the playbook directory.
If you use this variable, you must list all of the paths
that you expect to download.


key: sources

description:
Your Inventory sources. Either YAML or a path to a file.
If not provided the inventory will be take from the `sources`
runtime property.


description: Variable values.


description: keys that you want us to obscure


description: Command-line options, such as `tags` or `skip_tags`.


description: A dictionary of environment variables to set.


Debug level


Additional args that you want to use, for example, '-c local'.


Start the playbook at the task matching this name


Specify extra arguments to pass to scp only (e.g. -l)


Specify extra arguments to pass to sftp only (e.g. -f, -l)


Specify extra arguments to pass to ssh only (e.g. -R)


key: timeout

description: Override the connection timeout in seconds (default=10)


Save playbook after action


description: update sources on target node


A boolean value, `true` or `false` whether
to assume the user privileges.


The path to the terraform binary executable.


Directory to store downloaded Terraform templates. The directory must
either already exist and be writable by 'cfyuser', or alternatively
be create-able by 'cfyuser'.
The default is an empty string, which prompts the plugin to use the OS
temporary directory.


Location where Terraform plugins are located. If a value is provided, then
the Terraform plugin uses '--plugin-dir' with that value, ensuring that
no plugins are downloaded on-the-fly, for increased stability.
If a value is not provided, plugins will be downloaded on-the-fly. This is
not recommended in production environments.


key: terraformConfig

description: Terraform directories for executions.


key: name

description: Some name.


key: options

description: Should be a dictionary of key/values.


key: source

description:
Path or URL to the ZIP file containing the Terraform project.
If this is a path, then it must be relative to the blueprint's root.


key: backend

description:
If a backend is not defined in source,
and you want to use a specific backend, define that here.


key: variables

description: A dictionary of variables.


description: A dictionary of environment variables.


If true, use an existing Terraform installation rather than installing it


Location to download the Terraform installation from. Ignored if 'use_existing' is true.


key: plugins

description: List of plugins to download and install.


description:
URL or path to a ZIP/tar.gz file or a Git repository to obtain
new module source from. If omitted, then the module is reloaded
from its last location.


description:
If true, then the plugin destroys the existing Terraform
topology before applying the new one.


key: kubernetesTypesConfigurationVariant

description:
Type representing all Kubernetes API configuration variants.
Each property represents separate supported variant of configuration.
You should choose one variant and fill in only on property.


Name of Kubernetes configuration file attached to blueprint


Path to Kubernetes configuration file placed on Cloudify Manager VM


Content (YAML) of Kubernetes configuration file


description: Set of basic properties describing Kubernetes API access


key: host

description: HTTP/HTTPS URL to Kubernetes API


key: kubernetesTypesAuthenticationVariant

description:
Type representing all authentication variants
for different Kubernetes cloud providers.
Each property represents separate supported variant of authentication.
You should choose one variant and fill in only on property.


(JSON) Content of Google Cloud Platform Service Account file


key: kubernetesTypesClientConfig

description:
Configuration properties of kubernetes API and
authentication properties of Kubernetes Cloud providers.


key: configuration

description:
Configuration properties of Kubernetes API. One of four configuration options can be used
1. Kubernetes config file contained by blueprint archive
2. Kubernetes config file previously uploaded into Cloudify Manager VM
3. Content of Kubernetes config file (YAML)
4. Kubernetes API set o properties


key: authentication

description:
Authentication properties of Kubernetes Cloud providers. Optional.
Currently supported providers: Google Cloud Platform.


key: kubernetesTypesAbstractResource

description:
Type defining common base structure for any Kubernetes resource
It is some kind of wrapper for native Kubernetes YAML definition


key: apiVersion

description: Kubernetes API version as a string


key: kubernetesTypesRoleBindingDefinitio

description:
Type defining single Kubernetes resource e.g. Pod, Service, ...
It is some kind of wrapper for native Kubernetes YAML definition


key: roleRef

description:
RoleRef can only reference a ClusterRole in the global namespace.
If the RoleRef cannot be resolved, the Authorizer must return an error.


key: subjects

description: Subjects holds references to the objects the role applies to.


key: kubernetesTypesRoleDefinitio

description:
Type defining single Kubernetes resource e.g. Role, ...
It is some kind of wrapper for native Kubernetes YAML definition


key: rules

description: Rules holds all the PolicyRules for this Role.


key: kubernetesTypesClusterRoleDefinitio

description:
Type defining single Kubernetes resource e.g. ClusterRole, ...
It is some kind of wrapper for native Kubernetes YAML definition


key: kubernetesTypesSecretDefinition

description:
Secret holds secret data of a certain type.
The total bytes of the values in the Data field must be less than MaxSecretSize bytes


key: type

description: Used to facilitate programmatic handling of secret data.


key: data

description: Data contains the secret data.


key: stringData

description:
stringData allows specifying non-binary secret data in string form.
It is provided as a write-only convenience method.
All keys and values are merged into the data field on write,
overwriting any existing values. It is never output when reading from the API..


key: kubernetesTypesServiceAccountDefinition

description:
ServiceAccount binds together: a name, understood by users,
and perhaps by peripheral systems, for an identity a principal
that can be authenticated and authorized * a set of secrets


key: automountServiceAccountToken

description:
AutomountServiceAccountToken indicates whether pods running
as this service account should have an API token automatically mounted.
Can be overridden at the pod level..


key: imagePullSecrets

description:
ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images
in pods that reference this ServiceAccount. ImagePullSecrets are distinct
from Secrets because Secrets can be mounted in the pod,
but ImagePullSecrets are only accessed by the kubelet


key: secrets

description: Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount.


key: kubernetesTypesResourceDefinition


key: spec

description: Kubernetes resource object specification


description:
Type defining Kubernetes resource for storing data.
It is some kind of wrapper for native Kubernetes YAML definition


description: Contains data to store in ConfigMap, Secret..


description:
Type defining single Kubernetes resource e.g. StorageClass
It is some kind of wrapper for native Kubernetes YAML definition


key: parameters

description: Additional parameters for object creation


key: provisioner

description: Class provisioner for object creation


key: kubernetesTypesApiMappingEntry

description: Type defining python Kubernetes API objects and methods definitions for particular operation

required: api method


key: api

description: Name of python Kubernetes API object which will be used to as request for particular operation type


key: method

description: Method name of python Kubernetes API object which will be used as request for particular operation type


key: payload

description: Name of python Kubernetes API object which will be used as request data for particular operation type


key: kubernetesTypesApiMapping

description: Type containing python Kubernetes API objects and methods definitions for all supported operations


key: create

description: Python Kubernetes API objects and methods definitions for create operation


key: read

description: Python Kubernetes API objects and methods definitions for read operation


key: update

description: Python Kubernetes API objects and methods definitions for update operation


key: delete

description: Python Kubernetes API objects and methods definitions for delete operation


File relative to blueprint path.


Do not use.


key: configuration

description:
Configuration properties of Kubernetes API. One of four configuration options can be used
1. Kubernetes config file contained by blueprint archive
2. Kubernetes config file previously uploaded into Cloudify Manager VM
3. Content of Kubernetes config file (YAML)
4. Kubernetes API set o properties


key: authentication

description:
Authentication properties of Kubernetes Cloud providers. Optional.
Currently supported providers: Google Cloud Platform.


key: nodeTypeKubernetesResourcesResourceBase


Configuration properties of kubernetes API and
authentication properties of Kubernetes Cloud providers.


Permit changing the name and kind and number of resources defined in file.


Set this to "true" if you want Cloudify to wait for a predetermined state.


Indicates that you want to use an existing resource in Kubernetes.


key: definition

description: Definition of resource object using native Kubernetes YAML spec


key: options

description: API options depending on API operations execution


description: Definition of role binding using native Kubernetes YAML spec


description: Definition of role using native Kubernetes YAML spec


description: Definition of cluster role using native Kubernetes YAML spec


key: definitions

description: Definition of secret using native Kubernetes YAML spec


description: Definition of service account using native Kubernetes YAML spec


Python Kubernetes API objects and methods definitions used for given resource type


key: file

description: A path to YAML file containing the resource definition.


key: files

description: A list of paths to YAML files containing the resources definition.


Docker Machine IP to connect to.


Docker Machine rest port.


key: dockerMachine

description: Docker Machine IP,User,Private_key


Docker Machine IP


Docker Machine User


Docker Machine Private Key


Docker Container volume_mapping


key: dockerInstallationConfig

description: Docker Installation type


Docker Installation Link


Docker Installation script


description: Docker Image type


Docker image to build


key: tag

description: Docker image tag


description: Docker Container type


Docker image tag to build container


description:
dict of arguments to pass to container when run
check this URL for details: https://tinyurl.com/v8url54


description: Docker Container Files type


description: Docker Machine IP,User,Private_key


Docker Machine IP,User,Private_keys


key: source

description: Files location that will be mapped to container


key: destination

description:
Location to extract the files into,
that will be mapped to container volume later


description: More files to add to source before it goes to destination


description: special case for ansible sources


description: special case for terraform sources


description:
A full path to your ansible_playbook executable if user don't want to
use the included version of executable in the plugin


description:
A full path/URL that contain playbook specified in playbook_path
or site_yaml_path.


description:
A path to your `site.yaml` or `main.yaml` in your
Ansible Playbook relative to blueprint or playbook_source_path
if playbook_source_path is URL to archive File relative inside the archive.


description:
DEPRECATED.
A path to your `site.yaml` or `main.yaml` in your
Ansible Playbook relative to blueprint or playbook_source_path
if playbook_source_path is URL to archive File relative inside the archive.


description:
A list of string paths blueprint resources that you
would like to download to the playbook directory.
If you use this variable, you must list all of the paths
that you expect to download.


key: sources

description:
Your Inventory sources. Either YAML or a path to a file.
If not provided the inventory will be take from the `sources`
runtime property.


description: Variable values.


description: keys that you want us to obscure


description: Command-line options, such as `tags` or `skip_tags`.


description: A dictionary of environment variables to set.

enum: True False

default: False


description: Debug level


description: Additional args that you want to use, for example, '-c local'.


description: Save playbook after action


description: update sources on target node


description:
A boolean value, `true` or `false` whether
to assume the user privileges.


Docker Machine IP,User,Private_key


description: Terraform Plugins to install


description:
Path or URL to the ZIP file containing the Terraform project.
If this is a path, then it must be relative to the blueprint's root.


key: backend

description:
If a backend is not defined in source,
and you want to use a specific backend, define that here.


key: name

description: Some name.


description: Should be a dictionary of key/values.


key: variables

description: A dictionary of variables.


description: A dictionary of environment variables.


key: cloudifyGetStringOrAwsRegion

description:
The server region name, such as us-east-1.
(Not us-east-1b, which is an availability zone, or
US East, which is a Region.)
US East (N. Virginia) - us-east-1
US East (Ohio) - us-east-2
US West (N. California) - us-west-1
US West (Oregon) - us-west-2
Africa (Cape Town) - af-south-1
Asia Pacific (Hong Kong) - ap-east-1
Asia Pacific (Mumbai) - ap-south-1
Asia Pacific (Seoul) - ap-northeast-2
Asia Pacific (Osaka-Local) - ap-northeast-3
Asia Pacific (Singapore) - ap-southeast-1
Asia Pacific (Sydney) - ap-southeast-2
Asia Pacific (Tokyo) - ap-northeast-1
Canada (Central) - ca-central-1
China (Beijing) - cn-north-1
China (Ningxia) - cn-northwest-1
Europe (Frankfurt) - eu-central-1
Europe (Ireland) - eu-west-1
Europe (London) - eu-west-2
Europe (Milan) - eu-south-1
Europe (Paris) - eu-west-3
Europe (Stockholm) - eu-north-1
Middle East (Bahrain) - me-south-1
South America (São Paulo) - sa-east-1
AWS GovCloud (US-East) - us-gov-east-1
AWS GovCloud (US) - us-gov-west-1


key: awsConnectionConfig

description: A dictionary of values to pass to authenticate with the AWS API.


The ID of your AWS ACCESS KEY ID.


The ID of your AWS SECRET ACCESS KEY.


key: awsResourceId

description:
The AWS resource ID of the external resource, if
use_external_resource is true. Otherwise it is an empty string.


description:
Indicate whether the resource exists or if Cloudify should create the resource,
true if you are bringing an existing resource, false if you want cloudify to create it.


description:
Configuration key-value data to be passed as-is to the corresponding
Boto3 method. Key names must match the case that Boto3 requires.

required: Device InstanceId VolumeId


key: Device

description: The device name (for example, /dev/sdh or xvdh )


key: InstanceId

description: The ID of the instance.


key: VolumeId

description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone


key: DryRun

description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .


key: AvailabilityZone

description: The Availability Zone in which to create the volume.


key: Size

description: The size of the volume, in GiBs.


key: Encrypted

description:
Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types .


key: Iops

description:
The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances . Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1) volumes.


key: KmsKeyId

description:
The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1 :012345678910 :key/abcd1234-a123-456a-a12b-a123b4cd56ef .
Alias ARN. For example, arn:aws:kms:us-east-1 :012345678910 :alias/ExampleAlias .
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.


key: OutpostArn

description: The Amazon Resource Name (ARN) of the Outpost.


description:
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.

Constraints: 1-16,384 for gp2 , 4-16,384 for io1 , 500-16,384 for st1 , 500-16,384 for sc1 , and 1-1,024 for standard . If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.


key: SnapshotId

description: The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.


key: VolumeType

description:
The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2


description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation.


key: ResourceType

description: The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | customer-gateway | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | natgateway | network-acl | route-table | security-group | spot-fleet-request | spot-instances-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-peering-connection | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log | vpn-connection | vpn-gateway.


description: A boolean to choose another available zone if the one provided is not available.


required: MaxCount MinCount


key: ImageId

description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template


key: InstanceType

description:
The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
Default: m1.small


key: BlockDeviceMappings

description: The block device mapping entries.


[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.


key: KernelId

description: The ID of the kernel.


key: KeyName

description: The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair


key: SecondaryPrivateIpAddressCount

description: The number of secondary private IPv4 addresses to assign to a network interface.


key: SubnetId

description: The ID of the subnet for the network interface.


key: SecurityGroupIds

description:
The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface.


description:
Configuration key-value data to be passed as-is to the corresponding
Boto3 method. Key names must match the case that Boto3 requires.


key: kwargs


key: Description

description: A description for the network interface.


key: Groups

description: The IDs of one or more security groups.


The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true , you can specify 0 to override this setting.


key: PrivateIpAddress

description: The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).


description:
The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses .

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide .


key: InterfaceType

description: Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa . For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.


description: The ID of the subnet to associate with the network interface.


description:
http://boto3.readthedocs.io/en/latest/reference/services/ec2.html#EC2.Client.authorize_security_group_ingress
http://boto3.readthedocs.io/en/latest/reference/services/ec2.html#EC2.Client.authorize_security_group_egress


required: Description GroupName


key: GroupName

description: The name of the security group.


description: The description for the security group.


key: VpcId

description: The ID of the VPC. Required for EC2-VPC.


Helm binary path.


description:
Type representing all Kubernetes API configuration variants. Each property represents separate supported variant of configuration. For now, until Helm support "--insecure" one of "blueprint_file_name",
      "manager_file_path" and "file_content" must be used.
      "api_key" inputs will override kubeconfig data.


Name of Kubernetes configuration file attached to blueprint(path).


Path to Kubernetes configuration file placed on Cloudify Manager VM.


Content (YAML) of Kubernetes configuration file. kubeconfig string or dict are supported.


Set of basic properties describing Kubernetes API access.


key: host

description: HTTP/HTTPS URL to Kubernetes API.


Bearer token used for authentication.


description:
Type representing all authentication variants.
 for different Kubernetes cloud providers.
 Each property represents separate supported variant of authentication.
 You should choose one variant and fill in only on property.


(JSON) Content of Google Cloud Platform Service Account file.


key: cloudifyDatatypesHelmClientConfig

description:
Configuration properties for Helm to interact with kubernetes cluster.
 If kube_config file not provided then kube_token and kube_api_server should provided.


key: cloudifyDatatypesHelmReleaseConfig

description: configuration properties for release node type.

required: name chart


key: name

description: Name of the created release.


key: chart

description: Name of the chart to install.For example: stable/mysql.


Path to values files.


 List of variables names and values to set. For example:
          - name: x
            value: y
          - name: a
            value: b
          It equals to --set x=y --set a=b in helm command.


key: flags

description:
List of flags add to both "helm install" and "helm uninstall" commands.
          For example:
          - name: namespace
            value: my_namespace
          If the flag not requires value, omit "value" and specify only the name as element in the list.


key: cloudifyDatatypesHelmRepoConfig

description: configuration properties for repo node type.


description: Name of the repo that added/removed.


URL of the repo to add.


description: List of flags add to both "helm repo add" and "helm repo remove" commands.


If true, use an existing helm installation rather than installing it.


Location to download the Helm installation from. Ignored if 'use_existing_resource' is true.


Indicate whether the resource exists or if Cloudify should create the resource,
true if you are bringing an existing resource, false if you want cloudify to create it.


description: Flags to add only to `helm install` command.The format is the same as "flags".


description: Flags to add only to `helm uninstall` command.The format is the same as "flags".


description: Flags to add only to `helm repo add` command.The format is the same as "flags".


description: Flags to add only to `helm repo remove` command.The format is the same as "flags".


key: tags

description: Tags to add to an EC2 resource


key: nodeTemplateInterfaces

description: Interfaces enable you to map logical tasks to executable operations.


key: implementation

description: The script or plugin task name to execute.


key: inputs

description: Schema of inputs to be passed to the implementation as kwargs.


key: executor

description: Valid values: central_deployment_agent, host_agent. See the Plugins Specification for more info.


description: Maximum number of retries for a task. -1 means infinite retries (Default: task_retries in the Cloudify Manager config.yaml file for remote workflows, and task_retries workflow configuration for local workflows).

type: number


description: Minimum wait time (in seconds) between task retries (Default: task_retry_interval in the Cloudify Manager config.yaml file for remote workflows and task_retry_interval workflow configuration for local workflows).


key: timeone

description: Number of seconds to wait before the operation is terminated by the orchestrator. A value of 0 (or no value at all, which is the default) means no timeout.


description: If true (the default), and a timeout occurred, then, the operation will raise a RecoverableError, resulting in the operation being retried. Otherwise, a NonRecoverableError is raised, ending the execution with a failure.


key: nodeTemplateRelationships

description: relationships enable you to define how nodes relate to one another. For example, a web_server node can be contained_in a vm node or an application node can be connected_to a database node.


key: type

description: Either a newly-declared relationship type or one of the relationship types provided by default when importing the types.yaml file.


key: target

description: The name of the node to which the current node is related.


description: Valid values: all_to_all and all_to_one (See explanation below.)


description: A dictionary of interfaces.


description: A string referencing a parent type.


key: interfaces

description: A dictionary of node interfaces.


key: properties

description: A dictionary of node properties.


description: tosca_definitions_version is a top level property of the blueprint which is used to specify the DSL version used. For Cloudify, the versions that are currently defined are cloudify_dsl_1_0, cloudify_dsl_1_1, cloudify_dsl_1_2 and cloudify_dsl_1_3.


key: imports

description: imports enable the author of a blueprint to reuse blueprint files, or parts of them, and to use predefined types (e.g. from the types.yaml file).


description: inputs are parameters that are injected into a blueprint when a deployment is created. These parameters can be referenced by using the get_input intrinsic function.


description: A manifest file for a Slack app, as described on this page: https://api.slack.com/reference/manifests

enum: message global

required: name callback_id description type

required: command description


description:
Settings that describe the manifest.
https://api.slack.com/reference/manifests#metadata


description: An integer that specifies the major version of the manifest schema to target.


description: An integer that specifies the minor version of the manifest schema to target.


description:
Settings that describe parts of an app's appearance within Slack. If you're distributing the app via the App Directory, read our listing guidelines to pick the best values for these settings.
https://api.slack.com/reference/manifests#display


description: The name of the app.


key: description

description: A short description of the app for display to users.


description: A longer version of the description of the app.


description: A hex color value that specifies the background color used on hovercards that display information about your app. Can be 3-digit (#000) or 6-digit (#000000) hex values. Once an app has set a background color value, it cannot be removed, only updated.


key: settings

description:
Settings section of the app config pages.
https://api.slack.com/reference/manifests#settings


description: IP addresses that conform to the Allowed IP Ranges feature


description: Events API configuration for the app.


description: The full https URL that acts as the Events API request URL. If set, you'll need to manually verify the Request URL in the App Manifest section of App Management.


description: The event types you want to the app to subscribe to.


description: The event types you want to the app to subscribe to on behalf of authorized users.


key: interactivity

description: Interactivity configuration for the app.


description: Whether or not interactivity features are enabled.


description: The full https URL that acts as the interactive Request URL.


description: The full https URL that acts as the interactive Options Load URL.


description: Whether or not org-wide deploy is enabled.


description: Whether or not Socket Mode is enabled.


description: Whether or not token rotation is enabled for access tokens.


key: features

description:
Features section of the app config pages.
https://api.slack.com/reference/manifests#features


description: App Home configuration.


description: Whether or not the Home tab is enabled.


description: Whether or not the Messages tab in your App Home is enabled.


description: Whether or not the users can send messages to your app in the Messages tab of your App Home.


description: Bot user configuration.


description: The display name of the bot user. Allowed characters: a-z, 0-9, -, _, and .


description: Whether or not the bot user will always appear to be online.


key: shortcuts

description: Shortcuts configuration.


key: name

description: The name of the shortcut.


description: The callback_id of this shortcut.


description: A short description of this shortcut.


description: Specifies which type of shortcut is being described.


description: Slash commands configuration.


key: command

description: The actual slash command. Should include the leading / character


description: A description of the slash command that will be displayed to users.


description: Whether or not channels, users, and links typed with the slash command should be escaped.


key: url

description: The full https URL that acts as the slash command's request URL.


description: A short usage hint about the slash command for users.


description: Valid unfurl domains to register. Please consult the unfurl docs for a list of domain requirements.


description: Workflow steps configuration.


description: The name of the workflow step.


description: The callback_id of the workflow step.


description:
OAuth configuration for the app.
https://api.slack.com/reference/manifests#oauth


description: OAuth redirect URLs.


key: scopes

description: Permission scopes configuration.


key: bot

description: Bot scopes to request upon app installation.


key: user

description: User scopes to request upon app installation.


description:
publiccode.yml is a metadata standard for repositories containing software developed or acquired by the Public Administration, aimed at making them easily discoverabile and thus reusable by other entities.

By including a publiccode.yml file in the root of a repository, and populating it with information about the software, technicians and civil servants can evaluate it. Automatic indexing tools can also be built, since the format is easily readable by both humans and machines.

publiccode.yml is mandatory for all public software developed in Italy, according to the national guidelines: this enables the Developers Italia crawler to build the national software catalog. The standard is designed to be interoperable internationally, thus the country-specific keys are separated by the core part and are defined in specific sections that each government can rule.

format: email

required: name until

format: date

format: uri

enum: web windows mac linux ios android

enum: accounting agile-project-management applicant-tracking application-development appointment-scheduling backup billing-and-invoicing blog budgeting business-intelligence business-process-management cad call-center-management cloud-management collaboration communications compliance-management contact-management content-management crm customer-service-and-support data-analytics data-collection data-visualization digital-asset-management digital-citizenship document-management donor-management e-commerce e-signature email-management email-marketing employee-management enterprise-project-management enterprise-social-networking erp event-management facility-management feedback-and-reviews-management financial-reporting fleet-management fundraising gamification geographic-information-systems grant-management graphic-design help-desk hr ide identity-management instant-messaging inventory-management it-asset-management it-development it-management it-security it-service-management knowledge-management learning-management-system marketing mind-mapping mobile-marketing mobile-payment network-management office online-booking online-community payment-gateway payroll predictive-analysis procurement productivity-suite project-collaboration project-management property-management real-estate-management remote-support resource-management sales-management seo service-desk social-media-management survey talent-management task-management taxes-management test-management time-management time-tracking translation video-conferencing video-editing visitor-management voip warehouse-management web-collaboration web-conferencing website-builder workflow-management

enum: concept development beta stable obsolete

enum: standalone/mobile standalone/iot standalone/desktop standalone/web standalone/backend standalone/other addon library configurationFiles

enum: agriculture culture defence education emergency-services employment energy environment finance-and-economic-development foreign-affairs government healthcare infrastructures justice local-authorities manufacturing research science-and-technology security society sport tourism transportation welfare

enum: internal contract community none

required: localisationReady availableLanguages

required: publiccodeYmlVersion name url releaseDate platforms categories developmentStatus softwareType description legal maintenance localisation


key: additionalProperties

description: While the standard is structured to be meaningful on an international level, there are additional information that can be added that makes sense in specific countries, such as declaring compliance with local laws or regulations. The provided extension mechanism is the usage of country-specific sections.


key: countryExtensionVersion

description:
This key specifies the version to which the current extension schema adheres to, for forward compatibility.

Please note how the value of this key is independent from the top-level publiccodeYmlVersion one (see The Standard (core)). In such a way, the extensions schema versioning is independent both from the core version of the schema and from every other Country.


description: This key contains the full name of one of the technical contacts. It must be a real person; do NOT populate this key with generic contact information, company departments, associations, etc.


key: email

description: This key contains the e-mail address of the technical contact. It must be an email address of where the technical contact can be directly reached; do NOT populate this key with mailing-lists or generic contact points like "info@acme.inc". The e-mail address must not be obfuscated. To improve resistance against e-mail collection, use \x64 to replace @, as allowed by the YAML specification.


key: phone

description: phone number (with international prefix). This has to be a string.


key: affiliation

description: This key contains an explicit affiliation information for the technical contact. In case of multiple maintainers, this can be used to create a relation between each technical contact and each maintainer entity. It can contain for instance a company name, an association name, etc.


description: The name of the contractor, whether it's a company or a physical person.


key: until

description: This is a date (YYYY-MM-DD). This key must contain the date at which the maintenance is going to end. In case of community maintenance, the value should not be more than 2 years in the future, and thus will need to be regularly updated as the community continues working on the project.


key: website

description: This key points to the maintainer website. It can either point to the main institutional website, or to a more project-specific page or website.


description: The name of the dependency (e.g. MySQL, NFC Reader)


key: versionMin

description: The first compatible version


key: versionMax

description: The latest compatible version


key: version

description: The only major version for which the software is compatible. It assumes compatibility with all patches and bugfixes later applied to this version.


key: optional

description: Whether the dependency is optional or mandatory


key: publiccodeYmlVersion

description: This key specifies the version to which the current publiccode.yml adheres to, for forward compatibility.


key: name

description: This key contains the name of the software. It contains the (short) public name of the product, which can be localised in the specific localisation section. It should be the name most people usually refer to the software. In case the software has both an internal "code" name and a commercial name, use the commercial name.


key: applicationSuite

description: This key contains the name of the "suite" to which the software belongs.


key: url

description:
A unique identifier for this software. This string must be a URL to the source code repository (git, svn, …) in which the software is published. If the repository is available under multiple protocols, prefer HTTP/HTTPS URLs which don't require user authentication.

Forks created for the purpose of contributing upstream should not modify this file; this helps software parsing publiccode.yml to immediately skip technical forks. On the contrary, a complete fork that is meant to be maintained separately from the original software should modify this line, to give themselves the status of a different project.


key: landingURL

description: If the url parameter does not serve a human readable or browsable page, but only serves source code to a source control client, with this key you have an option to specify a landing page. This page, ideally, is where your users will land when they will click a button labeled something like "Go to the application source code". In case the product provides an automated graphical installer, this URL can point to a page which contains a reference to the source code but also offers the download of such an installer.


key: isBasedOn

description:
In case this software is a variant or a fork of another software, which might or might not contain a publiccode.yml file, this key will contain the url of the original project(s).

The existence of this key identifies the fork as a software variant, descending from the specified repositories.


key: softwareVersion

description:
This key contains the latest stable version number of the software. The version number is a string that is not meant to be interpreted and parsed but just displayed; parsers should not assume semantic versioning or any other specific version format.

The key can be omitted if the software is currently in initial development and has never been released yet.


key: releaseDate

description: This key contains the date at which the latest version was released. This date is mandatory if the software has been released at least once and thus the version number is present.


key: logo

description: This key contains the path to the logo of the software. Logos should be in vector format; raster formats are only allowed as a fallback. In this case, they should be transparent PNGs, minimum 1000px of width. The key value can be the relative path to the file starting from the root of the repository, or it can be an absolute URL pointing to the logo in raw version. In both cases, the file must reside inside the same repository where the publiccode.yml file is stored.


key: monochromeLogo

description: A monochromatic (black) logo. The logo should be in vector format; raster formats are only allowed as a fallback. In this case, they should be transparent PNGs, minimum 1000px of width. The key value can be the relative path to the file starting from the root of the repository, or it can be an absolute URL pointing to the logo in raw version. In both cases, the file must reside inside the same repository where the publiccode.yml file is stored.


key: inputTypes

description:
A list of Media Types (MIME Types) as mandated in RFC 6838 which the application can handle as input.

In case the software does not support any input, you can skip this field or use application/x.empty.


key: outputTypes

description:
A list of Media Types (MIME Types) as mandated in RFC 6838 which the application can handle as output.

In case the software does not support any output, you can skip this field or use application/x.empty.


key: platforms

description:
This key specifies which platform the software runs on. It is meant to describe the platforms that users will use to access and operate the software, rather than the platform the software itself runs on.

Use the predefined values if possible. If the software runs on a platform for which a predefined value is not available, a different value can be used.


key: categories

description: A list of words that can be used to describe the software and can help building catalogs of open software.


key: usedBy

description:
A list of the names of prominent public administrations (that will serve as "testimonials") that are currently known to the software maintainer to be using this software.

Parsers are encouraged to enhance this list also with other information that can obtain independently; for instance, a fork of a software, owned by an administration, could be used as a signal of usage of the software.


key: roadmap

description: A link to a public roadmap of the software.


key: countries

description: This key explicitly includes certain countries in the intended audience, i.e. the software explicitly claims compliance with specific processes, technologies or laws. All countries are specified using lowercase ISO 3166-1 alpha-2 two-letter country codes.


key: unsupportedCountries

description: This key explicitly marks countries as NOT supported. This might be the case if there is a conflict between how software is working and a specific law, process or technology. All countries are specified using lowercase ISO 3166-1 alpha-2 two-letter country codes.


key: scope

description: This key contains a list of tags related to the field of application of the software.


key: description

description:
This section contains a general description of the software. Parsers can use this section for instance to create a web page describing the software.,

Note: since all the strings contained in this section are user-visible and written in a specific language, you must specify the language you are editing the text in (using the IETF BCP 47 specifications) by creating a sub-section with that name. The primary language subtag cannot be omitted, as mandated by the BCP 47.

required: genericName shortDescription


key: localisedName

description: This key is an opportunity to localise the name in a specific language. It contains the (short) public name of the product. It should be the name most people usually refer to the software. In case the software has both an internal "code" name and a commercial name, use the commercial name.


key: genericName

description: This key is the "Generic name", which refers to the specific category to which the software belongs. You can usually find the generic name in the presentation of the software, when you write: "Software xxx is a yyy". Notable examples include "Text Editor", "Word Processor", "Web Browser", "Chat" and so on… The generic name can be up to 35 characters long.


key: shortDescription

description: This key contains a short description of the software. It should be a single line containing a single sentence. Maximum 150 characters are allowed.


key: longDescription

description:
This key contains a longer description of the software, between 500 and 10000 chars. It is meant to provide an overview of the capabilities of the software for a potential user. The audience for this text should be that of users of the software, not developers. You can think of this text as the description of the software that would be in its website (if the software had one).

This description can contain some basic markdown: *italic*, **bold**, bullet points and [links](#).


key: documentation

description:
This key contains a reference to the user-level (not developer-level) documentation of the software. The value must be a URL to a hosted version of the documentation.

It is suggested that the URL points to a hosted version of the documentation that is immediately readable through a common web browser in both desktop and mobile format. The documentation should be rendered in HTML and browsable like a website (with a navigation index, a search bar, etc.).

If the documentation is instead available only as a document, put a direct view/download link as URL in this key. You should commit the document as part of the source code repository, and then link to it using the code hosting source browser URL (e.g.: GitHub URL to the file). Prefer using open formats like PDF or ODT for maximum interoperability.

Whichever the format for the documentation, remember to make its source files available under an open license, possibly by committing them as part of the repository itself.


key: apiDocumentation

description:
This key contains a reference to the API documentation of the software. The value must be a URL to a hosted version of the documentation.

It is suggested that the URL points to a hosted version of the documentation that is immediately readable through a common web browser. The documentation should be rendered in HTML and browsable like a website (with a navigation index, a search bar, etc.), and if there is a reference or test deployment, possibly offer an interactive interface (e.g. Swagger).

If the documentation is instead available only as a document, put a direct view/download link as URL in this key. You should commit the document as part of the source code repository, and then link to it using the code hosting source browser URL (e.g.: GitHub URL to the file). Prefer using open formats like PDF or ODT for maximum interoperability.

Whichever the format for the documentation, remember to make its source files available under an open license, possibly by committing them as part of the repository itself.


key: features

description:
This key contains a list of software features, describing what capabilities the software allows to do. The audience for this text should be that of public decision makers who will be commissioning the software. The features should thus not target developers; instead of listing technical features referring to implementation details, prefer listing user-visible functionalities of the software.

While the key is mandatory, there is no mandatory minimum or maximum number of features that should be listed in this key. Each feature must use a maximum of 100 characters.

The suggested number of features to list is between 5 and 20, depending on the software size and complexity. There is no need for exhaustiveness, as users can always read the documentation for additional information.


key: screenshots

description: This key contains one or multiple paths to files showing screenshots of the software. They are meant to give a quick idea on how the software looks like and how it works. The key value can be the relative path to the file starting from the root of the repository, or it can be an absolute URL pointing to the screenshot in raw version. In both cases, the file must reside inside the same repository where the publiccode.yml file is stored.


key: videos

description:
This key contains one or multiple URLs of videos showing how the software works. Like screenshots, videos should be used to give a quick overview on how the software looks like and how it works. Videos must be hosted on a video sharing website that supports the oEmbed standard; popular options are YouTube and Vimeo.

Since videos are an integral part of the documentation, it is recommended to publish them with an open license.


key: awards

description: A list of awards won by the software.


key: license

description: This string describes the license under which the software is distributed. The string must contain a valid SPDX expression, referring to one (or multiple) open-source license. Please refer to the SPDX documentation for further information.


key: mainCopyrightOwner

description:
This string describes the entity that owns the copyright on "most" of the code in the repository. Normally, this is the line that is reported with the copyright symbol at the top of most files in the repo.

It is possible to list multiple owners if required so, using an English sentence. It is also possible to informally refer to a community of group of people like "Linus Torvalds and all Linux contributors".

In case it is not possible to name a main copyright owner, it is possible to omit this key; in those cases, if the repo has a authors file, you can point to it through legal/authorsFile.


key: repoOwner

description: This string describes the entity that owns this repository; this might or might not be the same entity who owns the copyright on the code itself. For instance, in case of a fork of the original software, the repoOwner is probably different from the mainCopyrightOwner.


key: authorsFile

description: Some open-source software adopt a convention of identify the copyright holders through a file that lists all the entities that own the copyright. This is common in projects strongly backed by a community where there are many external contributors and no clear single/main copyright owner. In such cases, this key can be used to refer to the authors file, using a path relative to the root of the repository.


key: maintenance

description: This section provides information on the maintenance status of the software, useful to evaluate whether the software is actively developed or not.


key: type

description: This key describes how the software is currently maintained.


key: contractors

description: This key describes the entity or entities, if any, that are currently contracted for maintaining the software. They can be companies, organizations, or other collective names.


key: contacts

description:
One or more contacts maintaining this software.

This key describes the technical people currently responsible for maintaining the software. All contacts need to be a physical person, not a company or an organisation. If somebody is acting as a representative of an institution, it must be listed within the affiliation of the contact.

In case of a commercial agreement (or a chain of such agreements), specify the final entities actually contracted to deliver the maintenance. Do not specify the software owner unless it is technically involved with the maintenance of the product as well.


key: localisation

description: This section provides an overview of the localization features of the software.


key: localisationReady

description: If yes, the software has infrastructure in place or is otherwise designed to be multilingual. It does not need to be available in more than one language.


key: availableLanguages

description: If present, this is the list of languages in which the software is available. Of course, this list will contain at least one language. The primary language subtag cannot be omitted, as mandated by the BCP 47.


key: dependsOn

description:
This section provides an overview on the system-level dependencies required to install and use this software.

NOTE: do not list dependencies at the source code level (e.g.: software libraries being used), and focus only on runtime and/or system-level dependencies that must be installed and maintained separately. For instance, a database is a good example of such dependencies.


key: open

description: This key contains a list of runtime dependencies that are distributed under an open-source license.


key: proprietary

description: This key contains a list of runtime dependencies that are distributed under a proprietary license.


key: hardware

description: This key contains a list of hardware dependencies that must be owned to use the software.


key: countryExtensionVersion

description:
This key specifies the version to which the current extension schema adheres to, for forward compatibility.

Please note how the value of this key is independent from the top-level publiccodeYmlVersion one (see The Standard (core)). In such a way, the extensions schema versioning is independent both from the core version of the schema and from every other Country.


key: conforme

description: This section contains the keys for auto-declaring the compliance with the current legislation, with respect to the following sections. Not including these keys implies that the compliance is not known or not declared.


key: lineeGuidaDesign

description: If present and set to yes, the software is compliant with the Italian accessibility laws (L. 4/2004), as further explained in the linee guida di design (Italian language).


key: modelloInteroperatibilita

description:
If present and set to yes, the software is compliant with the linee guida sull'interoperabilità.

Regulatory reference: Art. 73 del CAD (Italian language).


key: misureMinimeSicurezza

description: If present and set to yes, the software is compliant with the Misure minime di sicurezza ICT per le Pubbliche amministrazioni (Italian language).


key: gdpr


key: spid

description: If present and set to yes, the software interfaces with SPID - il Sistema Pubblico di Identità Digitale.


key: cie

description: If present and set to yes, the software interfaces with the Italian electronic ID card (Carta di Identità Elettronica).


key: anpr

description: If present and set to yes, the software interfaces with ANPR.


key: pagopa

description: If present and set to yes, the software interfaces with pagoPA.


key: codiceIPA

description: This key represents the administration code inside the Public Administration index (codice IPA).


description: Dockerfile linter, validate inline bash, written in Haskell

const: error

const: warning

const: info

const: style

const: ignore

enum: tty json checkstyle codeclimate gitlab_codeclimate gnu codacy


key: disable-ignore-pragma

description: Disable inline ignore pragmas `# hadolint ignore=DLxxxx`


key: failure-threshold

description: A threshold controlling how severe a rule violation must be before the return code indicates failure.


description: Never return failure.


description: Return failure if only rules of severity above `warning` are violated


description: Return failure if only rules of severity above `info` are violated


description: Return failure if only rules of severity above `style` are violated


description: Return failure if any rule is violated.


description: Return failure if any rule is violated.


key: format

description: Output format


key: strict-labels

description: Strictly adhere to label-schem, don't allow additional labels.


key: label-schema

description: A label-schema. See https://github.com/hadolint/hadolint#linting-labels for reference.


key: no-color

description: Don't colorize output.


key: no-fail

description: Don't exit with a failure status code when any rule is violated.


key: error

description: A list of rules to be treated with "error" severity


key: warning

description: A list of rules to be treated with "warning" severity


key: info

description: A list of rules to be treated with "info" severity


key: style

description: A list of rules to be treated with "style" severity


key: ignored

description: A list of rules to be ignored


key: items

description: Use absolute WORKDIR.


description: For some bash commands it makes no sense running them in a Docker container like ssh, vim, shutdown, service, ps, free, top, kill, mount, ifconfig.


description: Last user should not be root.


description: Use WORKDIR to switch to a directory.


description: Do not use sudo as it leads to unpredictable behavior. Use a tool like gosu to enforce root.


description: Do not use apt-get upgrade or dist-upgrade.


description: Always tag the version of an image explicitly.


description: Using latest is prone to errors if the image will ever update. Pin the version explicitly to a release tag.


description: Pin versions in apt-get install.


description: Delete the apt-get lists after installing something.


description: Use ADD for extracting archives into an image.


description: Valid UNIX ports range from 0 to 65535.


description: Multiple `HEALTHCHECK` instructions.


description: Pin versions in pip.


description: Use the `-y` switch.


description: Avoid additional packages by specifying --no-install-recommends.


description: Pin versions in `npm`.


description: Pin versions in apk add. Instead of `apk add <package>` use `apk add <package>=<version>`.


description: Use the `--no-cache` switch to avoid the need to use `--update` and remove `/var/cache/apk/*` when done installing packages.


description: Use `COPY` instead of `ADD` for files and folders.


description: `COPY` with more than 2 arguments requires the last argument to end with `/`


description: `COPY --from` should reference a previously defined `FROM` alias


description: `COPY --from` cannot reference its own `FROM` alias


description: `FROM` aliases (stage names) must be unique


description: Use arguments JSON notation for CMD and ENTRYPOINT arguments


description: Use only an allowed registry in the FROM image


description: Do not use `apt` as it is meant to be an end-user tool, use `apt-get` or `apt-cache` instead


description: Pin versions in gem install. Instead of `gem install <gem>` use `gem install <gem>:<version>`


description: Do not use --platform flag with FROM.


description: Use the `-y` switch to avoid manual input `yum install -y <package>`


description: `yum clean all` missing after yum command.


description: Specify version with `yum install -y <package>-<version>`


description: Non-interactive switch missing from `zypper` command: `zypper install -y`


description: Do not use `zypper dist-upgrade`.


description: `zypper clean` missing after zypper use.


description: Specify version with `zypper install -y <package>[=]<version>`.


description: Use the `-y` switch to avoid manual input `dnf install -y <package>`


description: `dnf clean all` missing after dnf command.


description: Specify version with `dnf install -y <package>-<version>`


description: Avoid cache directory with `pip install --no-cache-dir <package>`.


description: `ONBUILD`, `FROM` or `MAINTAINER` triggered from within `ONBUILD` instruction.


description: Do not refer to an environment variable within the same `ENV` statement where it is defined.


description: `COPY` to a relative destination without `WORKDIR` set.


description: `useradd` without flag `-l` and high UID will result in excessively large Image.


description: `wget` without flag `--progress` will result in excessively bloated build logs when downloading larger files.


description: Invalid Label Key


description: Label `<label>` is missing.


description: Superfluous label(s) present.


description: Label `<label>` is empty.


description: Label `<label>` is not a valid URL.


description: Label `<label>` is not a valid time format - must conform to RFC3339.


description: Label `<label>` is not a valid SPDX license identifier.


description: Label `<label>` is not a valid git hash.


description: Label `<label>` does not conform to semantic versioning.


description: `HEALTHCHECK` instruction missing.


description: Label `<label>` is not a valid email format - must conform to RFC5322.


description: Multiple consecutive `RUN` instructions. Consider consolidation.


description: `yarn cache clean` missing after `yarn install` was run.


description: MAINTAINER is deprecated.


description: Either use Wget or Curl but not both.


description: Multiple `CMD` instructions found.


description: Multiple `ENTRYPOINT` instructions found.


description: Use `SHELL` to change the default shell.


description: Set the `SHELL` option -o pipefail before `RUN` with a pipe in it


description: `$` is not used specially and should therefore be escaped.


description: This `\c` will be a regular `'c'`  in this context.


description: Remove space after `=` if trying to assign a value (or for empty string, use `var='' ...`).


description: Use semicolon or linefeed before `done` (or quote to make it literal).


description: This is a unicode non-breaking space. Delete it and retype as space.


description: You need a space here


description: It's not `foo &; bar`, just `foo & bar`.


description: Trying to declare parameters? Don't. Use `()` and refer to params as `$1`, `$2` etc.


description: Don't use $ on the left side of assignments.


description: Don't put spaces around the `=` in assignments.


description: For command expansion, the tick should slant left (\` vs ´).


description: Did you forget to close this double-quoted string?


description: This is actually an end quote, but due to next char, it looks suspect.


description: Scripts are case sensitive. Use `if`, not `If`.


description: This `{/}` is literal. Check expression (missing `;/\n`?) or quote it.


description: Don't use `$` on the iterator name in for loops.


description: Braces are required when expanding arrays, as in `${array[idx]}`.


description: You need a space or linefeed between the function name and body.


description: Unexpected `==`. For assignment, use `=`. For comparison, use `[ .. ]` or `[[ .. ]]`.


description: Quote/escape special characters when using `eval`, e.g. `eval "a=(b)"`.


description: You need a space before the `#`.


description: Useless cat. Consider `cmd < file | ..` or `cmd file | ..` instead.


description: Note that `A && B || C` is not if-then-else. C may run when A is true.


description: This word is outside of quotes. Did you intend to 'nest '"'single quotes'"' instead'?


description: `echo` won't expand escape sequences. Consider `printf`.


description: Use `./*glob*` or `-- *glob*` so names with dashes won't become options.


description: In POSIX sh, something is undefined.


description: Quote this to prevent word splitting


description: Double quote to prevent globbing and word splitting.


description: Word is in the form `"A"B"C"` (B indicated). Did you mean `"ABC"` or `"A\"B\"C"`?


description: var is referenced but not assigned.


description: Declare and assign separately to avoid masking return values.


description: Use `cd ... || exit` in case `cd` fails.


description: In POSIX sh, 'source' in place of '.' is undefined.


key: trustedRegistries

description: A list of trusted registries. Ex: docker.io


description: Monika monitoring configuration schema

required: host port database

required: host port

required: host port username password database

default: Name of the database

enum: GET POST DELETE PUT PATCH

default: GET

required: host port data

required: assertion message

default: response.status != 200

default: Http Response status code is not 200!

required: query message

examples: get-user login-check web-heatlh-check

required: id type

const: desktop

required: id type data

const: discord

const: workplace

const: google-chat


key: incidentThreshold

description: Number of times an alert should return true before Monika sends incident notifications


key: recoveryThreshold

description: Number of times an alert should return false before Monika sends recovery notifications


key: interval

description: The number of seconds to repeat the probe


key: postgres

description: Monitor postgres readiness


key: uri

description: Postgres uri connection configuration