key: enable-dual-channel-support

description: If active, PDUs on both channels will be configured with channel mask 'AB' and channel postfixes (e.g. xy_Ch_A, xy_Ch_B) will be created for ambiguous objects.


key: postfixes-for-ambiguous-pdus-on-channel

description: Definition of postfix settings if dual channel support is not activated.

enum: A B A&B no-postfixes

default: A&B


key: autosar-pdu-layer

description:
Configure the PDU layer in relation to AUTOSAR databases.
'no-pdus' : Creation of frames only
'from-autosar-4.0' : Creation of AUTOSAR PDUs for AUTOSAR DBs >= 4.0
'from-autosar-4.2' : Creation of AUTOSAR PDUs for AUTOSAR DBs >= 4.2

type: string


key: autosar-text-table-entries

description: Control naming of text table entries and influence signal qualification. Use text from COMPU-CONST nodes or SHORT-LABEL nodes.

default: compu-const

enum: compu-const short-label

examples: compu-const short-label


key: some-ip-pdus-without-service-context

description: Control the generation of services for SOME/IP PDUs without service context.

default: ignore

enum: ignore generate-service

examples: ignore generate-service


key: full

description: Absolute or relative path to an external file containing system variables. Relative path specifications are resolved relative to the defining configuration file.

type: object

type: array

when: SCENARIO_NAME == "my_scenario_name"


description: Absolute or relative path to an external database file (.dbc / .ldf / ...). Relative path specifications are resolved relative to the defining configuration file.

required: name file-path


key: network-name

description: Select a network from the database (cluster name if .arxml). If selected, 'name' must match 'network-name'.


description: A Network using the CAN protocol taking part in a simulation.

type: integer

mapping: internal-simulator


key: baudrate

description:
Baudrate of this CAN bus.
 If this value is set, it has priority.
 If this value is not set, the baudrate is read from the database. If the baudrate is missing from the database, the default value is used.


key: application-channel

description: Index of the application channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the application channels!


description: A Network using the CANFD protocol taking part in a simulation.

enum: iso non-iso

default: iso

required: arbitration-baudrate data-baudrate

mode: iso


key: mode

description: Operation Mode setting (iso or non-iso Mode).


key: arbitration-baudrate

description:
Baudrate for the arbitration phase of CAN FD in Baud.
 If this value is set, it has priority.
 If this value is not set, the baudrate is read from the database. If the baudrate is missing from the database, the default value is used.


key: data-baudrate

description:
Baudrate for the data phase of CAN FD.
 If this value is set, it has priority.
 If this value is not set, the baudrate is read from the database. If the baudrate is missing from the database, the default value is used.


description: A Network using the Ethernet protocol taking part in a simulation.

database: DB

mapping: external-sil-kit

address-configuration: static

address-configuration: dhcp


description: Index of the application channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.


description: A cluster using the FlexRay protocol taking part in a simulation.

required: name database

mode: manual

usage: startup

mask: A

mode: automatic


description: Index of the Application Channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.


description: A network using the LIN protocol taking part in a simulation.

const: commander

const: responder

default: commander

examples: commander responder

mode: responder


description: Index of the application channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 64. Value '0' is not allowed.


description: Working mode of the LIN interface.


description: The LIN network interface is able to output message headers on the network.


description: The LIN network interface responds to received LIN headers if a response to the LIN ID contained within the header has been configured.


description: Represents a simulation node used in a simulation

required: name network-assignments

type: boolean

otherNameThanInDb

database-node: nameFromDB


key: database-node

description: Use to assign explicitely a database node to a simulation node. If not set, the simulation-node name will be used as database-node. To deactivate automatic assignement, it should be set to false.


key: modeling-libraries

description: For assignment of modeling libraries to this simulation node.


description: Declares when to add this node.

examples: some_int_variable > 42 && some_other_int_variable <= 42


description: List of defines to be passed to capl / vcdl.


description: Represents an application used in a scenario


description: Programming modules file paths (capl-library or c-library). Entry can be deactivated with when.


description: Absolute or relative path to user files that can be read/written by CAPL/.NET Scripts. Relative path specifications are resolved relative to the defining configuration file.


description: Absolute or relative path to an external xcpcfg file. Relative path specifications are resolved relative to the defining configuration file.


description: Absolute or relative path to a FDX description file. Relative path specifications are resolved relative to the configuration file.


key: stepsize-in-sec

description: Step size in seconds.

type: number


key: debug-output

description: Is the debug output active.


key: active-model-variables

description: List of the FMU variables which should be exported


key: inactive-model-variables

description: List of the FMU variables which should be excluded from the export


description: Represents a functional mockup unit used in a scenario.

required: file-path stepsize-in-sec


description: Absolute or relative path to a SIL Kit config file (.yaml or .json). Relative path specifications are resolved relative to the configuration file.


description: Name of a blf file, supporting the field codes: {ComputerName}, {LocalTime}, {MeasurementIndex}, {MeasurementStart}, {IncSize|001|100MB} and {IncTime|001|01h00m}.


description: Advanced logging configurations.


description: A replay block for the CAN protocol.

ReplayBlock

when: SCENARIO_NAME == "MyScenario"

condition: immediately

default-mapping: as-in-original


key: replay-on-measurement-start

description: Replay starts with measurement start.


key: send-system-variables

description: Send system variable values.


key: send-tx-messages

description: Replay the tx messages.


key: send-rx-messages

description: Replay the rx messages.


key: full

description: A replay block for the ethernet protocol.


description: Replay starts with measurement start


description: A replay block for the LIN protocol.

default: all-responses

enum: all-responses master-responses-only master-requests-only no-headers

replay-mode: master-responses-only


key: replay-mode

description:
Select events to be replayed.
'all-responses': replay all the responses.
'master-responses-only': replay the responses only for frames published by the Master node.
'master-requests-only': replay only 0x3c responses.
'no-headers': disable replay of the LIN frame headers.


key: send-events

description:
Select which events from rx-responses, tx-responses and wakeup-signals are replayed. If not set, the default value depends on the value of replay-mode.
 For 'all-responses' or 'master-responses-only': all events are sent.
 For 'master-requests-only': only wakeup-events are sent.
 For 'no-headers': none of the events are sent.


key: autosar-pdu-layer

description:
Configure the PDU layer in relation to AUTOSAR databases.
'no-pdus' : Creation of frames only
'from-autosar-4.0' : Creation of AUTOSAR PDUs for AUTOSAR DBs >= 4.0
'from-autosar-4.2' : Creation of AUTOSAR PDUs for AUTOSAR DBs >= 4.2


key: autosar-text-table-entries

description: Control naming of text table entries and influence signal qualification. Use text from COMPU-CONST nodes or SHORT-LABEL nodes.


description: Represents a simulation node used in a simulation


description: Use to assign explicitely a database node to a simulation node. If not set, the simulation-node name will be used as database-node. To deactivate automatic assignement, it should be set to false.


description: For assignment of modeling libraries to this simulation node.


description: A Network using the CAN protocol taking part in a simulation.


key: baudrate

description: Baudrate of this CAN bus.


key: application-channel

description: Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!


description: A Network using the CANFD protocol taking part in a simulation.


key: mode

description: Operation Mode setting (iso or non-iso Mode).


key: arbitration-baudrate

description: Baudrate for the arbitration phase of CAN FD in Baud.


key: data-baudrate

description: Baudrate for the data phase of CAN FD.


description: A Network using the Ethernet protocol taking part in a simulation.


description: Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.


description: A network using the LIN protocol taking part in a simulation.


description: Index of the Application Channel. Each bus type should provide consecutive indices. Starts counting at 1. Value between 1 and 64. Value '0' is not allowed.


description: Working mode of the LIN interface.


description: The LIN network interface is able to output message headers on the network.


description: The LIN network interface responds to received LIN headers if a response to the LIN ID contained within the header has been configured.


key: access-mode

description: Mode of the underlying Ethernet bus. Classic approach is the 'Channel-based' setup.       More recent and recommended mode is the switched 'Network-based' mode (port based).

enum: network-based channel-based

default: network-based


key: signal-updates

description: Specifies how signals are updated on Network-based access. Will be ignored on Channel-based setups. Always: Events of all ports are used to update a signal without qualified ethernet port. rx-only: Only packets received by the interface are used, which leads to less duplicated updates. never: Signals without qualified ethernet ports are not updated.

const: always

const: rx-only

const: never


description: Events of all ports are used to update a signal without qualified ethernet port.


description: Only packets received by the interface are used, which leads to less duplicated updates.


description: Signals without qualified ethernet ports are not updated.


description: This variable can be used in any other node and overwritten by a scenario.

const: int

const: uint

enum: string path

const: bool

const: float

value: implicit-type

var

type: float

value: path/to/somewhere

type: path

type: uint


description: Represents an application used in a scenario


key: stepsize-in-sec

description: step size in seconds


key: debug-output

description: Are the debug outputs on


key: active-model-variables

description: List of the FMU variables which should be exported


key: inactive-model-variables

description: List of the FMU variables which should be excluded from the export


description: Represents a functional mockup unit used in a scenario


description: Absolute or relative path to an external xcpcfg file. Relative path specifications are resolved relative to the defining configuration file.


description: Advanced logging configurations


description: Represents a simulation node used in a simulation

mynode

database: mydatabase

node: mynode


key: modeling-libraries

description: For assignment of modeling libraries to this simulation node


key: full

description: Absolute or relative path to an external database file (.dbc / .ldf / ...). Relative path specifications are resolved relative to the defining configuration file.


description: A Network using the CAN protocol taking part in a simulation.


description: Baudrate in Baud.


description: Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 255. Value '0' is not allowed. Caution: CAN and CANFD share the Application Channels!


description: A Network using the CANFD protocol taking part in a simulation.


description: Operation Mode setting (iso or non-iso Mode).


description: Baudrate for the arbitration phase of CAN FD in Baud.


description: Baudrate for the data phase of CAN FD in Baud.


description: A Network using the Ethernet protocol taking part in a simulation.


description: Index of the Application Channel. Each busytype should provide consecutive indices. Starts counting at 1. Value between 1 and 32. Value '0' is not allowed.


description: A replay block for the CAN protocol.


key: replay-on-measurement-start

description: Replay starts with measurement start


key: send-system-variables

description: Send system variable values.


key: send-tx-messages

description: Replay the tx messages.


key: send-rx-messages

description: Replay the rx messages.


description: A replay block for the ethernet protocol.


description: A scenario with the option to define / override variables or defines

const: Default


description: Represents an application used in a scenario


description: Defines to be passed to capl / vcdl.


key: baudrate

description: Baudrate in Baud.


key: application-channel


description: Define to be passed to capl / vcdl.


description: Global configuration for the TCP/IP stack.

const: operating-system

examples: canoe operating-system

const: canoe

selected-stack: canoe

selected-stack: operating-system


key: selected-stack

description: If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided


description: If set to operating-system, the machines configuration is used. (use 'canoe' if settings should be manually provided)


description: If set to canoe, a custom configuration can be provided. (remove other elements for option operating-system)


description: Absolute or relative path to a vsysvar file. Relative path specifications are resolved relative to the configuration file.


description: A C-identifier for this element (case sensitive)


description: Absolute or relative path to an external database file (.arxml/.dbc/.ldf). Relative path specifications are resolved relative to the YAML configuration file.


description: Define the mapping of application channels to an underlying layer.

const: internal-simulator

const: external-sil-kit

default: internal-simulator

examples: internal-simulator external-sil-kit


description: Connect application channel to simulated network.


description: Connect application channel to SIL Kit.


description: Address configuration for an TCP/IP stack.


description: Via the key slot configuration it is possible to transmit two start-up/sync frames. Thus an external start-up node is not required for the start-up of a flexray cluster.


description: Absolute or relative path to a source file of a simulation node. Relative path specifications are resolved relative to the defining configuration file.


description: List of networks represented by this application.


description: Absolute or relative path to a vmodule modeling library. Relative path specifications are resolved relative to the configuration file.


description: Simulation node configuration for the TCP/IP stack.

enum: operating-system canoe

default: individual

examples: operating-system canoe individual


description:
If set to operating-system, the machines configuration is used.
 If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet/tcp-ip-stack/selected-stack to be set to canoe).
 If set to individual, a custom configuration can be provided


description: Reference to external datasource files (.vcdl/.vcodm). Absolute or relative path. Relative path specifications are resolved relative to the defining configuration file.


description: Absolute or relative path to a source file of an application model (can/canencr/cs/sln/py/vmodule). Relative path specifications are resolved relative to the defining configuration file.


description: Absolute or relative path to a vmodule file. Relative path specifications are resolved relative to the configuration file.


description: Absolute or relative path to a xcpcfg file. Relative path specifications are resolved relative to the configuration file.


description: Absolute or relative path to a YAML file. Relative path specifications are resolved relative to the configuration file.


description: Absolute or relative path to a source file of a functional mockup unit (.fmu). Relative path specifications are resolved relative to the defining configuration file.


description: Absolute or relative path to a replay file. Relative path specifications are resolved relative to the configuration file.


description: Timing conditions for a replay block.

const: immediately

const: first-event-time

const: delayed

condition: first-event-time

condition: delayed

condition: ${variable}


key: condition

description: The condition when the replay shall start.


description: The first event of the replayed file occurs with measurement start.


description: The original timestamp of the replayed file are used.


description: The first event is delayed. Can be configured by the 'delayed-ms' element.


key: delay-ms

description: The delay in ms if the condition 'delayed' is selected. No effect otherwise.


description: The channel mapping for a replay block.

const: as-in-original

const: ignore-all

required: source-channel target-network

required: source-network target-network

default-mapping: ignore-all


key: default-mapping

description: The default mapping of a channel if it is not explicitely mapped.


description: The channel is mapped to itself if there is an active network.


description: The channels are ignored by default.


key: mappings

description: The explicitly mapped channels. Overwrites the default mapping for the source.


key: items

description: Mapping from application channel of the replay file to a target network.


key: source-channel

description: The source application channel from the replayed file.


key: target-network

description: The target network name.


description: Mapping from a named source network of the replay file to a named target network.


key: source-network

description: The source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.


description: Ignores an application channel of the replay file.


key: ignore-source-channel

description: The ignored source channel.


description: Ignores a named source network of the replay file.


key: ignore-source-network

description: The ignored source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.


key: full

description: Absolute or relative path to a vmodule file. Relative path specifications are resolved relative to the configuration file.


description: Global configuration for the TCP/IP stack.


description: If set to operating-system, the machines configuration is used. If set to canoe, a custom configuration can be provided


description: If set to operating-system, the machines configuration is used. (use 'canoe' if settings should be manually provided)


description: If set to canoe, a custom configuration can be provided. (remove other elements for option operating-system)


description: Absolute or relative path to a source file of an application model (can/cs/sln/py/vmodule). Relative path specifications are resolved relative to the defining configuration file.


description: Absolute or relative path to a source file of a simulation node.  Relative path specifications are resolved relative to the defining configuration file.


description: List of network nodes represented by this application

lin-role: master

lin-role: master config-tester


description: Simulation node configuration for the TCP/IP stack.


description:
If set to operating-system, the machines configuration is used.
 If set to canoe, the configuration on the global level is used (this requires globals-settings/ethernet-settings/tcp-ip-stack/selected-stack to be set to canoe).
 If set to individual, a custom configuration can be provided


description: A list of C-identifiers for referenced elements (case sensitive)


description: Define the mapping of application channels to an underlying layer


description: Connect application channel to simulated network.


description: Connect application channel to SIL Kit.


description: Timing conditions for a replay block.


description: The condition when the replay shall start.


description: The first event of the replayed file occurs with measurement start.


description: The original timestamp of the replayed file are used.


description: The first event is delayed. Can be configured by the 'delayed-ms' element.


description: The delay in ms if the condition 'delayed' is selected. No effect otherwise.


description: The channel mapping for a replay block.


description: The default mapping of a channel if it is not explicitely mapped.


description: The channel is mapped to itself if there is an active network.


description: The channels are ignored by default.


description: The explicitly mapped channels. Overwrites the default mapping for the source.


description: Mapping from application channel of the replay file to a target network.


description: The source application channel from the replayed file.


description: The target network name.


description: Mapping from a named source network of the replay file to a named target network.


description: The source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.


description: Ignores an application channel of the replay file.


description: The ignored source channel.


description: Ignores a named source network of the replay file.


description: The ignored source network name. Only works if the replay file was created by CANoe and contains the relevant metadata.


description: List of defines to be passed to capl / vcdl.


description: Define to be passed to capl / vcdl.


description: List of network nodes represented by this application


description: Absolute or relative path to a dll or vmodule file. Relative path specifications are resolved relative to the configuration file.


description: A list of C-identifiers for referenced elements (case sensitive)


description: Activates TCP Routing


description: Activates the TCP Delayed Ack Option.


description: IPv4-Address of the Gateway


description: IPv6-Address of the Gateway


description: MAC-Address of the current TcpIpStack. (Can't be a multicast address.)


description: Maximum Transmittion Unit.


description: Configurations for IPv4.

examples: dhcp static linked-local

enum: dhcp linked-local

required: address-configuration addresses

const: static


key: address-configuration

description: Defines how the addresses are configured. Use 'static' to configure them manually with the 'addresses' property or use 'dhcp' for automatic configuration.


description: Configurations for IPv6.

examples: dhcp static


key: vlan-settings

description: Defines a VLAN with its relevant seetings.

required: id priority


key: id

description: Id of the current VLAN.


key: priority

description: Priority of the current VLAN.


description: A list of VLANs with their relevant seetings.


description: Configuration of a key slot node.

default: automatic

const: automatic

const: off

const: manual

examples: manual automatic

enum: startup sync

default: startup

enum: A B AB

default: A

required: usage slot mask leading-cold-start


key: mode

description:
Key slot operating modes.
'automatic': The key slot is possibly active. Any active frame in the Tx buffer will be selected for this key slot, if marked as start-up and/or sync frame.
'off': The key slot is not used.
'manual': Explicity definition of the key slot properties.


key: usage

description: The frame in this slot can be send as start-up or only as sync frame.


key: slot

description: Explicit slot number of the static segment that will be used as the key slot.


key: mask

description: Explicit channel mask used for the key slot.


key: leading-cold-start

description: If deactivated the key slot can only act as a following start-up or integrating sync frame.


description: A network node represented by this application.


key: network

description: Assign the simulation node to a network.


description: Timestamp Option for TCP (RFC1323).


description: Time To Live.


description: For assignment of this NetworkNode to a Network.


key: modeling-libraries

description: For assignment of modeling libraries to this NetworkNode


description: A C-identifier for a referenced element (case sensitive)


description: IPv4 address


description: IPv6 address


Subnet mask of an IPv4 Address


description: Subnet prefix of an IPv4 Address


description: List of IPv4 addresses with their subnet definition


description: List of IPv6 addresses with their subnet definition

required: address subnet-prefix-length


key: subnet-prefix-length

description: Subnetprefix of an IPv6 Address


description: Reference to a certain node from a database

required: node database


key: node

description: The node from the database


key: database

description: The database


description: Role of a node in a LIN network.

enum: master slave config-tester

examples: master slave config-tester


key: plugins

description:
The plugins field, related to plugins in options, has either an array of plugin names (or paths) or plugin–options tuples, or an object mapping plugins to their options.
Plugin options can be false, which specifies that a plugin should not be used. In all other cases, they are treated as an object, and merged by the cascade. Thus, it's possible to specify part of the options from one configuration file, and overwrite or extend it from another file.


key: fragment

description: Specify whether to parse a fragment, instead of a complete document. In document mode, unopened html, head, and body elements are opened in just the right places.


key: space

description:
Which space the document is in.

If an svg element is found in the HTML space, parse automatically switches to the SVG space when entering the element, and switches back when exiting.

Note: make sure to set fragment: true if space: 'svg'.

enum: svg html

default: html


key: emitParseErrors

description:
Emit parse errors while parsing on the vfile.

Setting this to true starts emitting HTML parse errors.

Specific rules can be turned off by setting them to false (or 0). The default, when emitParseErrors: true, is true (or 1), and means that rules emit as warnings. Rules can also be configured with 2, to turn them into fatal errors.


key: verbose

description: Patch extra positional information. If specified, the following element:


key: entities

description: Configuration for stringify-entities. Do not use escapeOnly, attribute, or subset (toHtml already passes those, so they won't work). However, useNamedReferences, useShortestReferences, and omitOptionalSemicolons are all fine.


key: useNamedReferences

description: Prefer named character references (&) where possible.


key: useShortestReferences

description: Prefer the shortest possible reference, if that results in less bytes.


key: omitOptionalSemicolons

description: Whether to omit semicolons when possible.


key: voids

description:
Tag names of elements to serialize without closing tag.

Not used in the SVG space.


key: upperDoctype

description: Use a <!DOCTYPE… instead of <!doctype…. Useless except for XHTML.


key: quote

description: Preferred quote to use.


key: quoteSmart

description: Use the other quote if that results in less bytes.


key: preferUnquoted

description:
Leave attributes unquoted if that results in less bytes.

Not used in the SVG space.


key: omitOptionalTags

description:
Omit optional opening and closing tags. For example, in

one

two

, both
 closing tags can be omitted. The first because it's followed by another li, the last because it's followed by nothing.

Not used in the SVG space.


key: collapseEmptyAttributes

description:
Collapse empty attributes: get class instead of class="". Note: boolean attributes, such as hidden, are always collapsed.

Not used in the SVG space.


key: closeSelfClosing

description:
Close self-closing nodes with an extra slash (/): <img /> instead of <img>. See tightSelfClosing to control whether a space is used before the slash.

Not used in the SVG space.


key: closeEmptyElements

description:
Close SVG elements without any content with slash (/) on the opening tag instead of an end tag: <circle /> instead of <circle></circle>. See tightSelfClosing to control whether a space is used before the slash.

Not used in the HTML space.


key: tightCommaSeparatedLists

description: Join known comma-separated attribute values with just a comma (,), instead of padding them on the right as well (,·, where · represents a space).


key: tightAttributes

description:
Join attributes together, without whitespace, if possible: get class="a b"title="c d" instead of class="a b" title="c d" to save bytes. Note: creates invalid (but working) markup.

Not used in the SVG space.


key: tightDoctype

description: Drop unneeded spaces in doctypes: <!doctypehtml> instead of <!doctype html> to save bytes. Note: creates invalid (but working) markup.


key: bogusComments

description: Use "bogus comments" instead of comments to save byes: <?charlie> instead of <!--charlie-->. Note: creates invalid (but working) markup.


key: allowParseErrors

description:
Do not encode characters which cause parse errors (even though they work), to save bytes. Note: creates invalid (but working) markup.

Not used in the SVG space.


key: allowDangerousHtml

description: Allow raw nodes and insert them as raw HTML. When falsey, encodes raw nodes. Note: Only set this if you completely trust the content.


key: name

description: The name of the plugin.


key: main

description: Plugin main class.


key: version

description: Plugin version.


key: author

description: Plugin author.


key: depends

description: Plugin hard dependencies.


key: softDepends

description: Plugin soft dependencies.


key: description

description: Optional description.


description: Defines how to build a Docker image and how to run predictions on your model inside that image.

type: string number

required: type id target


key: build

description: This stanza describes how to build the Docker image your model runs in.


key: cuda

description: Cog automatically picks the correct version of CUDA to install, but this lets you override it for whatever reason.


key: cudnn

description: Cog automatically picks the correct version of cuDNN to install, but this lets you override it for whatever reason.


key: gpu

description: Enable GPUs for this model. When enabled, the [nvidia-docker](https://github.com/NVIDIA/nvidia-docker) base image will be used, and Cog will automatically figure out what versions of CUDA and cuDNN to use based on the version of Python, PyTorch, and Tensorflow that you are using.


description: The minor (`3.8`) or patch (`3.8.1`) version of Python to use.


description: A list of Python packages to install, in the format `package==version`.


description: A list of setup commands to run in the environment before your Python packages are installed.


description: A pip requirements file specifying the Python packages to install.


description: A list of Ubuntu APT packages to install.


key: run

description: A list of setup commands to run in the environment after your system packages and Python packages have been installed. If you're familiar with Docker, it's like a `RUN` instruction in your `Dockerfile`.


key: image

description: The name given to built Docker images. If you want to push to a registry, this should also include the registry name.


key: predict

description: The pointer to the `Predictor` object in your code, which defines how predictions are run on your model.


key: train


key: windowsAuthentication

description: Set to true to enable windows authentication for your site in IIS and IIS Express.


key: anonymousAuthentication

description: Set to true to enable anonymous authentication for your site in IIS and IIS Express.


key: iisExpress

description: Site settings to use with IISExpress profiles.


key: iis

description: Site settings to use with IIS profiles.


key: applicationUrl

description: The URL of the web site.

format: uri


key: sslPort

description: The SSL port to use for the web site.


key: commandName

description: Identifies the debug target to run.

enum: Executable Project IIS IISExpress DebugRoslynComponent Docker DockerCompose MsixPackage


key: commandLineArgs

description: The arguments to pass to the target being run.


key: executablePath

description: An absolute or relative path to the executable.


key: workingDirectory

description: Sets the working directory of the command.


key: launchBrowser

description: Set to true if the browser should be launched.


key: launchUrl

description: The relative URL to launch in the browser.


key: environmentVariables

description: Set the environment variables as key/value pairs.


description: A semi-colon delimited list of URL(s) to configure for the web server.


key: nativeDebugging

description: Set to true to enable native code debugging.


key: externalUrlConfiguration

description: Set to true to disable configuration of the site when running the Asp.Net Core Project profile.


description: Set to true to run the 64 bit version of IIS Express, false to run the x86 version.


key: ancmHostingModel

description: Specifies the hosting model to use when running ASP.NET core projects in IIS and IIS Express.

enum: InProcess OutOfProcess


key: sqlDebugging

description: Set to true to enable debugging of SQL scripts and stored procedures.


description: Set to true to enable the JavaScript debugger for Microsoft Edge (Chromium) based WebView2.


key: leaveRunningOnClose

description: Set to true to leave the IIS application pool running when the project is closed.


key: remoteDebugEnabled

description: Set to true to have the debugger attach to a process on a remote computer.


key: remoteDebugMachine

description: The name and port number of the remote machine in name:port format.


key: authenticationMode

description: The authentication scheme to use when connecting to the remote computer.


key: hotReloadEnabled

description: Set to true to enable applying code changes to the running application.


key: publishAllPorts

description: Publish all exposed ports to random ports in Docker (-P).


key: useSSL

description: Set to true to bind the SSL port.


key: sslPort

description: The SSL port to use for the web site.


key: httpPort

description: The HTTP port to use for the web site.


key: dotnetRunMessages

description: Set to true to display a message when the project is building.


key: inspectUri

description: The url to enable debugging on a Blazor WebAssembly application.


key: targetProject

description: A relative ot absolute path to the .NET project file on which Roslyn component should be executed. Relative to the current project's folder.


key: profiles

description: A list of debug profiles


key: iisSettings

description: IIS and IIS Express settings


description: Settings for project analysis by the Application Inspector

enum: Wildcard ExactMatch RegExp

required: Cookie Type

required: Form Type

required: Http Type

enum: Auto Manual

required: FormDetection Login Password FormAddress ValidationTemplate LoginKey PasswordKey FormXPath

required: Login Password ValidationAddress

enum: Form Http RawCookie None

enum: None Fast Full Normal

enum: Domain Folder Path

enum: None Solution WebSite

format: email

required: Enabled MailProfileName EmailRecipients

enum: Java CSharp VB Php JavaScript Python ObjectiveC Swift CAndCPlusPlus Go Kotlin Sql

enum: Configuration Components BlackBox DataFlowAnalysis PatternMatching VulnerableSourceCode


key: AdditionalHttpHeaders

description: Dictionary of additional HTTP headers


key: WhiteListedAddresses

description: Addresses, that was added in white list


key: Address

description: Address value


key: Format

description: Type of address


key: BlackListedAddresses

description: Addresses, that was added in black list


key: Cookie

description: Cookie authentication options


key: ValidationAddress

description: Verification address


key: ValidationTemplate

description: String to search for


key: Form

description: Form-based authentication options

required: FormDetection Login Password FormAddress ValidationTemplate


key: FormDetection

description: Type of form authentication detection


description: String to search for


key: Http

description: HTTP Basic authentication options


key: ProxySettings

description: Proxy server settings


key: RunAutocheckAfterScan

description: Autocheck vulnerabilities after scanning


key: CustomParameters

description: Custom kernel startup parameters


key: SolutionFile

description: Path to a solution or project


key: MailingProjectSettings

description: Report mailing options


key: SkipGitIgnoreFiles

description: Exclude from scanning the files from the .gitignore file


key: UsePublicAnalysisMethod

description: Search from available public and protected methods


key: UseSastRules

description: Enable SAST Analysis rules


key: UseCustomPmRules

description: Enable custom PM rules


key: UseSecurityPolicies

description: Check for compliance with the security policy


key: plugins

description:
The plugins field, related to plugins in options, has either an array of plugin names (or paths) or plugin–options tuples, or an object mapping plugins to their options.
Plugin options can be false, which specifies that a plugin should not be used. In all other cases, they are treated as an object, and merged by the cascade. Thus, it's possible to specify part of the options from one configuration file, and overwrite or extend it from another file.


key: bullet

description: Marker to use to for bullets of items in unordered lists.


key: closeAtx

description: Whether to add the same number of number signs (#) at the end of an ATX heading as the opening sequence.


key: emphasis

description: Marker to use to serialize emphasis.


key: fence

description: Marker to use to serialize fenced code.


key: fences

description: Whether to use fenced code always. The default is to fenced code if there is a language defined, if the code is empty, or if it starts or ends in empty lines


key: incrementListMarker

description: Whether to increment the value of bullets of items in ordered lists.


key: listItemIndent

description: Whether to indent the content of list items with the size of the bullet plus one space (when 'one') or a tab stop ('tab'), or depending on the item and its parent list ('mixed', uses 'one' if the item and list are tight and 'tab' otherwise)

enum: one tab mixed

default: tab


key: quote

description: Marker to use to serialize titles.


key: resourceLink

description: Whether to use resource links ([text](url)) always. The default is to use autolinks (<https://example.com>) when possible.


key: rule

description: Marker to use for thematic breaks.


key: ruleRepetition

description: Number of markers to use for thematic breaks.


key: ruleSpaces

description: Whether to add spaces between markers in thematic breaks.


key: setext

description: Whether to use setext headings when possible. Setext headings are not possible for headings with a rank more than 2 or when they're empty.


key: strong

description: Marker to use to serialize strong.


key: tightDefinitions

description: Whether to join definitions w/o a blank line.


key: ConfigMapArgs

description: ConfigMapArgs contains the metadata of how to generate a configmap

enum: create replace merge


key: env

description: Deprecated.  Use envs instead.


key: envs

description: A list of file paths. The contents of each file should be one key=value pair per line


key: files

description: A list of file sources to use in creating a list of key, value pairs


key: literals

description: A list of literal pair sources. Each literal source should be a key and literal value, e.g. `key=value`


key: name

description: Name - actually the partial name - of the generated resource


key: namespace

description: Namespace for the configmap, optional


key: FieldSelector

description: Contains the fieldPath to an object field


key: GeneratorOptions

description: GeneratorOptions modify behavior of all ConfigMap and Secret generators


key: annotations

description: Annotations to add to all generated resources


key: disableNameSuffixHash

description: DisableNameSuffixHash if true disables the default behavior of adding a suffix to the names of generated resources that is a hash of the resource contents


key: immutable

description: Immutable if true add to all generated resources


key: labels

description: Labels to add to all generated resources


key: Inventory

description: Inventory appends an object that contains the record of all other objects, which can be used in apply, prune and delete


key: bases

description: DEPRECATED. Bases are relative paths or git repository URLs specifying a directory containing a kustomization.yaml file.


key: commonAnnotations

description: CommonAnnotations to add to all objects


key: buildMetadata

description: BuildMetadata is a list of strings used to toggle different build options


key: commonLabels

description: CommonLabels to add to all objects and selectors


key: configMapGenerator

description: ConfigMapGenerator is a list of configmaps to generate from local data (one configMap per list item)


key: configurations

description: Configurations is a list of transformer configuration files


key: crds

description: Crds specifies relative paths to Custom Resource Definition files. This allows custom resources to be recognized as operands, making it possible to add them to the Resources list. CRDs themselves are not modified.


key: generators

description: Generators is a list of files containing custom generators


key: helmCharts

description: HelmCharts is a list of helm chart configuration instances


key: helmGlobals

description: HelmGlobals contains helm configuration that isn't chart specific


key: chartHome

description: ChartHome is a file path, relative to the kustomization root, to a directory containing a subdirectory for each chart to be included in the kustomization


key: configHome

description: ConfigHome defines a value that kustomize should pass to helm via the HELM_CONFIG_HOME environment variable


key: images

description: Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.


description: Labels to add to all objects but not selectors


key: metadata

description: Contains metadata about a Resource


key: namePrefix

description: NamePrefix will prefix the names of all resources mentioned in the kustomization file including generated configmaps and secrets


key: nameSuffix

description: NameSuffix will suffix the names of all resources mentioned in the kustomization file including generated configmaps and secrets


key: namespace

description: Namespace to add to all objects


key: replacements

description: Substitute field(s) in N target(s) with a field from a source


key: openapi

description: OpenAPI contains information about what kubernetes schema to use


key: patches

description: Apply a patch to multiple resources


description: JSONPatches is a list of JSONPatch for applying JSON patch. See http://jsonpatch.com


key: patchesStrategicMerge

description: PatchesStrategicMerge specifies the relative path to a file containing a strategic merge patch. URLs and globs are not supported


key: replicas

description: Replicas is a list of (resource name, count) for changing number of replicas for a resources. It will match any group and kind that has a matching name and that is one of: Deployment, ReplicationController, Replicaset, Statefulset.


key: resources

description: Resources specifies relative paths to files holding YAML representations of kubernetes API objects. URLs and globs not supported.


key: components

description: Components are relative paths or git repository URLs specifying a directory containing a kustomization.yaml file of Kind Component.


key: secretGenerator

description: SecretGenerator is a list of secrets to generate from local data (one secret per list item)


key: transformers

description: Transformers is a list of files containing transformers


key: validators

description: Validators is a list of files containing validators


key: vars

description: Allows things modified by kustomize to be injected into a container specification. A var is a name (e.g. FOO) associated with a field in a specific resource instance.  The field must contain a value of type string, and defaults to the name field of the instance


key: pairs

description: Pairs contains the key-value pairs for labels to add


key: includeSelectors

description: IncludeSelectors inidicates should transformer include the fieldSpecs for selectors


key: includeTemplates

description: IncludeTemplates inidicates should transformer include the template labels


key: fields

description: FieldSpec completely specifies a kustomizable field in a k8s API object. It helps define the operands of transformations


key: path

description: relative file path for a json patch file inside a kustomization


key: target

description: Refers to a Kubernetes object that the json patch will be applied to. It must refer to a Kubernetes resource under the purview of this kustomization


key: patch

description: inline json patch


key: op

description: The operation

enum: add remove replace move copy test


key: from

description: The source location.


description: The target location.


description: Refers to a Kubernetes object that the patch will be applied to. It must refer to a Kubernetes resource under the purview of this kustomization


key: source

description: The source of the value


key: group

description: The group of the referent


key: version

description: The version of the referent


key: kind

description: The kind of the referent


key: name

description: The name of the referent


key: namespace

description: The namespace of the referent


key: fieldPath

description: The structured path to the source value


key: targets

description: The N fields to write the value to


key: select

description: Include objects that match this


key: reject

description: Exclude objects that match this


key: items

description: Exclude objects that match this


key: fieldPaths

description: The structured path(s) to the target nodes


description: The structured path to the source value


key: SecretArgs

description: SecretArgs contains the metadata of how to generate a secret


description: Name - actually the partial name - of the generated resource


description: Namespace for the secret, optional


key: type

description: Type of the secret, optional


key: Var

description: Represents a variable whose value will be sourced from a field in a Kubernetes object.

required: name objref


key: fieldref

description: Refers to the field of the object referred to by objref whose value will be extracted for use in replacing $(FOO)


description: Value of identifier name e.g. FOO used in container args, annotations, Appears in pod template as $(FOO)


key: objref

description: Refers to a Kubernetes resource under the purview of this kustomization


description: JSON schema for SIL Kit Participant configuration files

enum: Send Receive Both

enum: A B AB None

enum: A B

enum: SingleShot Continuous

enum: Critical Error Warn Info Debug Trace Off

enum: Remote File Stdout

default: Info


key: Description

description: Free text commenting on or summarizing this configuration. Optional


key: Name

description: Name of the endpoint


key: Network

description: Name of the network. Optional; Defaults to the endpoint name


key: UseTraceSinks

description: Names of trace sinks to use


key: UseTraceSource

description: Name of a trace source used as a simulation message source for this controller


key: Direction

description: Filter messages to use from the trace source by their direction. May be Send, Receive or Both


key: ChannelName

description: Name of an MDF channel in the trace source


key: ChannelSource

description: Name of an MDF channel's source information object


key: ChannelPath

description: Path of an MDF channel's source information object


key: GroupName

description: Name of an MDF channel group


key: GroupSource

description: Name of an MDF channel group's source information object


key: GroupPath

description: Path of an MDF channel group's source information object


key: gColdstartAttempts

description: Number of attempts for a cold start before giving up (range 2-31)


key: gCycleCountMax

description: Max cycle count value in a given cluster (range 7-63, must be an odd integer)


key: gdActionPointOffset

description: Time offset for a static slot in macroticks (range 1 - 63)


key: gdDynamicSlotIdlePhase

description: Duration of the idle phase within a dynamic slot in gdMiniSlots (range 0 - 2)


key: gdMiniSlot

description: Duration of a mini slot in macroticks (2 - 63)


key: gdMiniSlotActionPointOffset

description: Time offset for a mini slot in macroticks (range 1- 31)


key: gdStaticSlot

description: Duration of a static slot in macroticks (range 3 - 664)


key: gdSymbolWindow

description: Duration of the symbol window in macroticks (range 0 - 162)


key: gdSymbolWindowActionPointOffset

description: Time offset for a static symbol windows in macroticks (range 1 - 63)


key: gdTSSTransmitter

description: Duration of TSS (Transmission Start Sequence) in gdBits (range 1 - 15)


key: gdWakeupTxActive

description: Duration of LOW Phase of a wakeup symbol in gdBit (range 15 - 60)


key: gdWakeupTxIdle

description: Duration of the idle of a wakeup symbol in gdBit (45 - 180)


key: gListenNoise

description: Upper limit for the startup listen timeout and wakeup listen timeout in the presence of noise; Used as a multiplier of pdListenTimeout (range 2 - 16)


key: gMacroPerCycle

description: Number of macroticks per cycle (range 8 - 16000)


key: gMaxWithoutClockCorrectionFatal

description: Threshold used for testing the vClockCorrectionFailed counter (range 1 - 15)


key: gMaxWithoutClockCorrectionPassive


key: gNumberOfMiniSlots

description: Number of mini slots (range 0 - 7988)


key: gNumberOfStaticSlots

description: Number of static slots in a cycle (range 2 - 1023)


key: gPayloadLengthStatic

description: Length of the payload of a static frame in 16-Bits words (range 0 - 127)


key: gSyncFrameIDCountMax

description: Maximum number of distinct sync frame identifiers present in a given cluster (range 2 - 15)


key: pAllowHaltDueToClock

description: Controls the transition to halt state due to clock synchronization errors. (values 0, 1)


key: pAllowPassiveToActive

description: Required number of consecutive even / odd cycle pairs for normal passive to normal active (range 0 - 31)


key: pChannels

description: Channel(s) to which the controller is connected


key: pClusterDriftDamping

description: Cluster drift damping factor for rate correction in microticks (range 0 - 10)


key: pdAcceptedStartupRange

description: Allowed deviation for startup frames during integration in microticks (range 29 - 2743)


key: pdListenTimeout

description: Duration of listen phase in microticks (range 1926 - 2567692)


key: pKeySlotId

description: Slot ID of the key slot (range 0 - 1023; value 0 means that there is no key slot)


key: pKeySlotOnlyEnabled

description: Shall the node enter key slot only mode after startup. (values 0, 1) (AUTOSAR pSingleSlotEnabled)


key: pKeySlotUsedForStartup

description: Key slot is used for startup (values 0, 1)


key: pKeySlotUsedForSync

description: Key slot is used for sync (values 0, 1)


key: pLatestTx

description: Last mini slot which can be transmitted (range 0 - 7988)


key: pMacroInitialOffsetA

description: Initial startup offset for frame reference point on channel A (range 2 - 68 macroticks)


key: pMacroInitialOffsetB

description: Initial startup offset for frame reference point on channel B (range 2 - 68 macroticks)


key: pMicroInitialOffsetA

description: Offset between secondary time reference and MT boundary (range 0 - 239 microticks)


key: pMicroInitialOffsetB


key: pMicroPerCycle

description: Nominal number of microticks in the communication cycle (range 960 - 1280000)


key: pOffsetCorrectionOut

description: Maximum permissible offset correction value (range 15 - 16082 microticks)


key: pOffsetCorrectionStart

description: Start of the offset correction phase within the NIT, (7 - 15999 macroticks)


key: pRateCorrectionOut

description: Maximum permissible rate correction value (range 3 - 3846 microticks)


key: pWakeupChannel

description: Channel used by the node to send a wakeup pattern


key: pWakeupPattern

description: Number of repetitions of the wakeup symbol (range 0 - 63, value 0 or 1 prevents sending of WUP)


key: pdMicrotick

description: Duration of a FlexRay microtick


key: pSamplesPerMicrotick

description: Number of samples per microtick (values 1, 2)


key: channels

description: Channel(s)


key: slotId

description: The slot Id of frame


key: offset

description: Base offset for cycle multiplexing (values 0 - 63)


key: repetition

description: Repetition for cycle multiplexing (values 1, 2, 4, 8, 16, 32, 64)


key: PPindicator

description: Set the PPindicator


key: headerCrc

description: Header CRC, 11 bits


key: transmissionMode

description: SingleShot or Continuous transmission mode


key: FlexrayControllers

description: Reconfigures the FlexrayControllers of the participant


key: Topic

description: Name of the communication channel between DataPublisher and DataSubscribers


key: RpcFunctionName

description: Name of the RPC function called by RpcClients on RpcServers


key: Logging

description: Configures the properties of the SIL Kit Logging Service


key: LogFromRemotes

description: Enables receiving of remote log messages from other participants


key: LogName

description: Log name; Results in the following filename: <LogName>_%y-%m-%dT%h-%m-%s.txt


key: $schema

description: The schema file


key: schemaVersion

description: Version of the schema used to validate this document


key: ParticipantName

description: Name of the participant


key: CanControllers

description: Reconfigures the CanControllers of the participant


key: LinControllers

description: Reconfigures the LinControllers of the participant


key: EthernetControllers

description: Reconfigures the EthernetControllers of the participant


key: DataPublishers

description: Reconfigures the DataPublishers of the participant


key: DataSubscribers

description: Reconfigures the DataSubscribers of the participant


key: RpcClients

description: Reconfigures the RpcClients of the participant


key: RpcServers

description: Reconfigures the RpcServers of the participant


key: HealthCheck

description: Node to configure properties to determine the health status of the simulation


key: SoftResponseTimeout

description: If a simulation step is not finished before this limit, a warning is logged. Optional; Unit is in milliseconds


key: HardResponseTimeout

description: If a simulation step is not finished before this limit, the participant enters error state. Optional; Unit is in milliseconds


key: Tracing

description: Configures the tracing service of the participant

enum: PcapFile PcapPipe Mdf4File


key: Name

description: Name of the trace sink


key: OutputPath

description: File path of output file


key: Type

description: File format specifier


description: Name of the trace source


key: InputPath

description: File path of input file


key: Extensions

description: Optional configuration for the extension loading mechanism


key: items

description: A filesystem path to additionally search for extensions


key: Middleware

description: Optional configuration of the SIL Kit middleware


key: strictSSL

description: Enabled by default, setting this option to false disables strict SSL. Passed to request package. Useful behind (corporate) proxies that act like man-in-the middle on https connections.


key: proxy

description: Any standard http-proxy as supported by the request package.


key: token

description: The OAuth token can be used to boost the GitHub API rate-limit from 60 to 5000 (non-cached) requests per hour. The is token needs just 'read-only access to public information' so no additional OAuth scopes are necessary.


description: A trim pattern for a Minecraft data pack config schema


description: JFrog File Spec schema definition.

enum: true false

default: false

repo: my-local-repo

path: my-path

file: my-file

examples: buildName buildName/buildNumber

default: true

enum: asc desc

default: asc

required: pattern exclusions props targetProps excludeProps recursive regexp archiveEntries

required: bundle limit offset

required: build limit offset


key: files

description: Details of files to be uploaded or downloaded from Artifactory.


key: ant

description: If true, the command will interpret the patterns which describes the local file-system paths, as ANT patterns.


key: aql

description: An AQL query that specified artifacts in Artifactory.


key: archive

description: Set to "zip" to pack and deploy the files to Artifactory inside a ZIP archive. Currently, the only packaging format supported is zip.


key: archiveEntries

description: If specified, only archive artifacts containing entries matching this pattern are matched. You can use wildcards to specify multiple artifacts.


key: build

description: If specified, only artifacts of the specified build are matched. The property format is build-name/build-number. If you do not specify the build number, the artifacts are filtered by the latest build number.


key: bundle

description: If specified, only artifacts of the specified bundle are matched. The value format is bundle-name/bundle-version.


key: excludeArtifacts

description: If specified, build artifacts are not matched.


key: excludeProps

description: List of "key=value" pairs separated by a semi-colon. Only artifacts without all of the specified properties names and values will be affected.


key: exclusions

description: An array (enclosed with square brackets) of patterns to be excluded from uploading/downloading.


key: explode

description: If true, archive file is extracted after the operation. The archived file itself is deleted. The supported archive types are: zip, tar; tar.gz; and tgz.


key: bypass-archive-inspection

description: If true, bypass the security inspection the archive go through before it is unarchived.


key: flat

description: If true, artifacts are uploaded/downloaded to the exact target path specified and their hierarchy in the source file system is ignored.


key: includeDeps

description: If specified, also dependencies of the specified build are matched.


key: includeDirs

description: If true, the source path applies to bottom-chain directories and not only to files. Bottom-chain directories are either empty or do not include other directories that match the source path.


key: limit

description: The maximum number of items to fetch. Usually used with the sortBy option.


key: offset

description: The offset from which to fetch items (i.e. how many items should be skipped). Usually used with the 'sort-by' option.


key: pattern

description: Specifies a local file system path or a path in Artifactory.


key: props

description: List of "key=value" pairs separated by a semi-colon. Only artifacts with all of the specified properties names and values will be affected.


key: recursive

description: If true, files are also collected from sub-folders of the source directory.


key: regexp

description: If true, the command will interpret the patterns which describes the local file-system paths, as regular expressions.


key: sortBy

description: A list of fields to sort by. The fields must be part of the 'items' AQL domain.


key: sortOrder

description: The order by which fields in the sortBy option should be sorted.


key: symlinks

description: If true, the command will preserve the soft links structure in Artifactory. The symlink file representation will contain the symbolic link and checksum properties.


key: target


key: targetProps

description: List of "key=value" pairs separated by a semi-colon. The specified properties will be attached to the affected artifacts.


key: validateSymlinks

description: If true, the command will validate that symlinks are pointing to existing and unchanged files, by comparing their sha1. Applicable to files and not directories.


key: include-dirs

description: Set to true if you'd like to also apply the source path pattern for directories and not just for files.


key: from-rt

description: If true, search the files in Artifactory, rather than on the local file system. The --regexp option is not supported when --from-rt is set to true.


key: gpg-key

description: Path to the public GPG key file located on the file system, used to validate downloaded release bundles.


key: sdk

description: Specify information about the SDK.

enum: patch feature minor major latestPatch latestFeature latestMinor latestMajor disable

default: disable


key: version

description: The version of the SDK to use.


key: rollForward

description: The roll-forward policy when selecting an SDK version, either as a fallback to accommodate missing a specific SDK version or as a directive to use a later version.


description: Prometheus configuration file

format: uri-reference

default: Bearer

enum: replace lowercase uppercase keep drop keepequal dropequal hashmod labelmap labeldrop labelkeep

default: replace

const: replace

enum: SRV A AAAA

default: SRV

enum: endpoints service pod node ingress

default: /metrics

default: http


description: Sets the `Authorization` header on every remote write request with the configured username and password. password and password_file are mutually exclusive.


key: authorization

description: Sets the `Authorization` header on every scrape request with the configured credentials.


key: type

description: Sets the authentication type of the request.


key: credentials

description: Sets the credentials of the request. It is mutually exclusive with `credentials_file`.


Sets the credentials of the request with the credentials read from the configured file. It is mutually exclusive with `credentials`.


Optionally configures AWS's Signature Verification 4 signing process to sign requests.


key: region

description: The AWS region. If blank, the region from the default credentials chain is used.


The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are used.


key: profile

description: Named AWS profile used to authenticate.


AWS Role ARN, an alternative to using AWS API keys.


description: Optional OAuth 2.0 configuration. Cannot be used at the same time as basic_auth or authorization.


Read the client secret from a file. It is mutually exclusive with `client_secret`.


key: scopes

description: Scopes for the token request.


The URL to fetch the token from.


description: Optional parameters to append to the token URL.


Configures the token request's TLS settings.


Sets the `Authorization` header on every scrape request with the configured bearer token. It is mutually exclusive with `bearer_token_file`.


Sets the `Authorization` header on every scrape request with the bearer token read from the configured file. It is mutually exclusive with `bearer_token`.


description: The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions.


key: separator

description: Separator placed between concatenated source label values.


description: Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.


key: regex

description: Regular expression against which the extracted value is matched.


key: modulus

description: Modulus to take of the hash of the source label values.


key: replacement

description: Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available.


key: action

description: Action to perform based on regex matching.


CA certificate to validate API server certificate with.


Certificate file for client cert authentication to the server.


Key file for client cert authentication to the server.


ServerName extension to indicate the name of the server.


Disable validation of the server certificate.


description: List of Azure service discovery configurations.


key: items

description: The information to access the Azure API.


description: List of Consul service discovery configurations.


description: The information to access the Consul API. It is to be defined as the Consul documentation requires.


description: List of DigitalOcean service discovery configurations.


description: The information to access the DigitalOcean API.


description: List of Docker service discovery configurations.


description: Docker SD configurations allow retrieving scrape targets from Docker Engine hosts.


description: List of Docker Swarm service discovery configurations.


description: Docker Swarm SD configurations allow retrieving scrape targets from Docker Swarm engine.


description: List of DNS service discovery configurations.


description: A DNS-based service discovery configuration allows specifying a set of DNS domain names which are periodically queried to discover a list of targets. The DNS servers to be contacted are read from /etc/resolv.conf. This service discovery method only supports basic DNS A, AAAA and SRV record queries, but not the advanced DNS-SD approach specified in RFC6763. During the relabeling phase, the meta label __meta_dns_name is available on each target and is set to the record name that produced the discovered target.


key: names

description: A list of DNS domain names to be queried.


description: The type of DNS query to perform. One of SRV, A, or AAAA.


key: port

description: The port number used if the query type is not SRV.


The time after which the provided names are refreshed.


description: List of EC2 service discovery configurations.


description: The information to access the EC2 API.


description: List of Eureka service discovery configurations.


description: The information to access the Eureka API.


description: List of file service discovery configurations.


key: files

description: Patterns for files from which target groups are extracted. Where the pattern may be a path ending in .json, .yml or .yaml. The last path segment may contain a single * that matches any character sequence, e.g. my/path/tg_*.json.


Refresh interval to re-read the files.


description: List of GCE service discovery configurations.


description: The information to access the GCE API.


description: List of Hetzner service discovery configurations.


description: The information to access the Hetzner API.


description: List of HTTP service discovery configurations.


description: HTTP-based service discovery provides a more generic way to configure static targets and serves as an interface to plug in custom service discovery mechanisms.


key: url

description: URL from which the targets are fetched.


Refresh interval to re-query the endpoint.


description: Optional proxy URL.


Configure whether HTTP requests follow HTTP 3xx redirects.


TLS configuration.


description: List of Kubernetes service discovery configurations.


description: The information to access the Kubernetes API.


description: The API server addresses. If left empty, Prometheus is assumed to run inside of the cluster and will discover API servers automatically and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.


key: role

description: The Kubernetes role of entities that should be discovered. One of endpoints, service, pod, node, or ingress.


Configure whether scrape requests follow HTTP 3xx redirects.


key: namespaces

description: Optional namespace discovery. If omitted, all namespaces are used.


key: selectors

description: Optional label and field selectors to limit the discovery process to a subset of available resources.


description: List of Kuma service discovery configurations.


description: The information to access the Kuma API.


description: List of Lightsail service discovery configurations.


description: The information to access the Lightsail API.


description: List of Linode service discovery configurations.


description: The information to access the Linode API.


description: List of Marathon service discovery configurations.


description: List of AirBnB's Nerve service discovery configurations.


description: List of OpenStack service discovery configurations.


description: The information to access the OpenStack API.


description: List of PuppetDB service discovery configurations.


description: The information to access the PuppetDB API.


description: List of Scaleway service discovery configurations.


description: The information to access the Scaleway API.


description: List of Zookeeper Serverset service discovery configurations.


description: List of Triton service discovery configurations.


description: The information to access the Triton discovery API.


description: List of Uyuni service discovery configurations.


description: The information to access the Uyuni API.


description: List of labeled statically configured targets for this job.


key: targets

description: The targets specified by the static config.


key: labels

description: Labels assigned to all metrics scraped from the targets.


key: global

description: The global configuration specifies parameters that are valid in all other configuration contexts. They also serve as defaults for other configuration sections.


How frequently to scrape targets by default.


How long until a scrape request times out.


How frequently to evaluate rules.


The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager).


File to which PromQL queries are logged. Reloading the configuration will reopen the file.


Rule files specifies a list of globs. Rules and alerts are read from all matching files.


description: Settings related to the remote write feature.


description: The URL of the endpoint to send samples to.


Timeout for requests to the remote write endpoint.


key: headers

description: Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten.


List of remote write relabel configurations.


key: name

description: Name of the remote write config, which if specified must be unique among remote write configs. The name will be used in metrics and logging in place of a generated value to help users distinguish between remote write configs.


Enables sending of exemplars over remote write. Note that exemplar storage itself must be enabled for exemplars to be scraped in the first place.


Configures the remote write request's TLS settings.


description: Optional proxy URL.


Configure whether HTTP requests follow HTTP 3xx redirects.


Configures the queue used to write to remote storage.


key: capacity

description: Number of samples to buffer per shard before we block reading of more samples from the WAL. It is recommended to have enough capacity in each shard to buffer several requests to keep throughput up while processing occasional slow remote requests.


Maximum number of shards, i.e. amount of concurrency.


Minimum number of shards, i.e. amount of concurrency.


Maximum number of samples per send.


Maximum time a sample will wait in buffer.


Initial retry delay. Gets doubled for every retry.


Maximum retry delay.


Retry upon receiving a 429 status code from the remote-write storage.


Configures the sending of series metadata to remote storage.


key: send

description: Whether metric metadata is sent to remote storage or not.


How frequently metric metadata is sent to remote storage.


description: Settings related to the remote read feature.


description: The URL of the endpoint to query from.


description: Name of the remote read config, which if specified must be unique among remote read configs. The name will be used in metrics and logging in place of a generated value to help users distinguish between remote read configs.


An optional list of equality matchers which have to be present in a selector to query the remote read endpoint.


Timeout for requests to the remote read endpoint.


description: Custom HTTP headers to be sent along with each remote read request. Be aware that headers that are set by Prometheus itself can't be overwritten.


Whether reads should be made for queries for time ranges that the local storage should have complete data for.


description: Optional proxy URL.


Configure whether HTTP requests follow HTTP 3xx redirects.


Scrape config files specifies a list of globs. Scrape configs are read from all matching files and appended to the list of scrape configs.


description: A list of scrape configurations.


description: The job name assigned to scraped metrics by default. Must be unique across all scrape configurations.


How frequently to scrape targets from this job. Defaults to `global.scrape_interval`.


Per-scrape timeout when scraping this job. Defaults to `global.scrape_timeout`.


description: The HTTP resource path on which to fetch metrics from targets.


Controls how Prometheus handles conflicts between labels that are already present in scraped data and labels that Prometheus would attach server-side ("job" and "instance" labels, manually configured target labels, and labels generated by service discovery implementations).


Controls whether Prometheus respects the timestamps present in scraped data.


key: scheme

description: Configures the protocol scheme used for requests.


key: params

description: Optional HTTP URL parameters.


Configure whether scrape requests follow HTTP 3xx redirects.


Configures the scrape request's TLS settings.


List of target relabel configurations.


List of metric relabel configurations.


An uncompressed response body larger than this many bytes will cause the scrape to fail. 0 means no limit. Example: 100MB.


Per-scrape limit on number of scraped samples that will be accepted. If more than this number of samples are present after metric relabelling the entire scrape will be treated as failed. 0 means no limit.


Per-scrape limit on number of labels that will be accepted for a sample. If more than this number of labels are present post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit.


Per-scrape limit on length of labels name that will be accepted for a sample. If a label name is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit.


Per-scrape limit on length of labels value that will be accepted for a sample. If a label value is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit.


Per-scrape config limit on number of unique targets that will be accepted. If more than this number of targets are present after target relabeling, Prometheus will mark the targets as failed without scraping them. 0 means no limit.


key: alerting

description: Alerting specifies settings related to the Alertmanager.


key: timeout

description: Per-target Alertmanager timeout when pushing alerts.


The api version of Alertmanager.


Prefix for the HTTP path alerts are pushed to.


description: Optional proxy URL.


Configure whether HTTP requests follow HTTP 3xx redirects.


List of labeled statically configured Alertmanagers.


List of Alertmanager relabel configurations.


key: storage

description: Storage related settings that are runtime reloadable.


description: Schema for ArangoDB Foxx service manifests

enum: integer boolean number string json password int bool

default: string


key: configuration

description: An object defining the configuration options this service requires.


key: description

description: A human-readable description of the option.


key: type

description: The type of value expected for this option.


key: default

description: The default value for this option in plain JSON. Can be omitted to provide no default value.


key: required

description: Whether the service can not function without this option. Defaults to true unless a default value is provided.


key: defaultDocument

description: If specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html".


key: dependencies

description: The dependencies this service uses, i.e. which APIs its dependencies need to be compatible with.


key: additionalProperties

description: The semantic version ranges of the API the service expects.


description: Name of the API the service expects.


key: version


description: A description of how the API is used or why it is needed.


description: Whether the service can not function without this dependency.


key: multiple

description: Whether the dependency can be specified more than once.


key: provides

description: The dependencies this provides, i.e. which APIs it claims to be compatible with.


description: The semantic version ranges of the API the service implements.


key: engines

description: An object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with.


key: files

description: An object defining file assets served by this service.


description: Relative path of the file or folder within the service.


key: path


key: gzip

description: If set to true the file will be served with gzip-encoding if supported by the client. This can be useful when serving text files like client-side JavaScript, CSS or HTML.


description: The MIME content type of the file. Defaults to an intelligent guess based on the filename's extension.


key: lib

description: The relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest.


key: main

description: The relative path to the main entry point of this service (relative to lib), e.g. "index.js".


key: scripts

description: An object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services.


description: Path of the script (relative to lib), e.g. "scripts/setup.js".


key: tests

description: A path/pattern or list of paths/patterns of JavaScript tests provided for this service.


key: items

description: A single path/pattern of JavaScript tests provided for this service.


key: author

description: The full name of the author of the service (i.e. you). This will be shown in the web interface.


key: contributors

description: A list of names of people that have contributed to the development of the service in some way. This will be shown in the web interface.


description: Human-readable representation of the contributor, e.g. their name.


key: description

description: A human-readable description of the service. This will be shown in the web interface.


key: keywords

description: A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services.


description: A keyword relevant to the service.


key: license

description: A string identifying the license under which the service is published, ideally in the form of an SPDX license identifier. This will be shown in the web interface.


key: name

description: The name of the Foxx service. This will be shown in the web interface.


key: thumbnail

description: The filename of a thumbnail that will be used alongside the service in the web interface. This should be a JPEG or PNG image that looks good at sizes 50x50 and 160x160.


key: version

description: The version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface.


description: A schema for Cargo.toml.

enumValues: Automatically detect the build file (`build.rs`).

enumValues: Disable automatic detection of the build file.

enumValues: No debug info at all, default for `release` profile

enumValues: Debug info without type or variable-level information. Generates more detailed module-level info than `line-tables-only`.

enumValues: Full debug info, default for `dev` profile

enumValues: Line info directives only. For the nvptx* targets this enables [profiling](https://reviews.llvm.org/D46061). For other use cases, `line-tables-only` is the better, more compatible choice.

enumValues: Line tables only. Generates the minimal amount of debug info for backtraces with filename/line number info, but not anything else, i.e. no variable or function parameter info.

schemas: feature

enumValues: Performs "fat" LTO which attempts to perform optimizations across all crates within the dependency graph.

enumValues:
Performs ["thin" LTO](http://blog.llvm.org/2016/06/thinlto-scalable-and-incremental-lto.html). This is similar to "fat", but takes
substantially less time to run while still achieving performance gains
similar to "fat".

enumValues:
Performs "thin local LTO" which performs "thin" LTO on the local
crate only across its [codegen units](https://doc.rust-lang.org/cargo/reference/profiles.html#codegen-units). No LTO is performed
if codegen units is 1 or [opt-level](https://doc.rust-lang.org/cargo/reference/profiles.html#opt-level) is 0.

enumValues: No optimizations, also turns on [`cfg(debug_assertions)`](https://doc.rust-lang.org/cargo/reference/profiles.html#debug-assertions).

enumValues: Optimize for binary size, but also turn off loop vectorization.

required: name version

enum: unwind abort

enumValues:
Unwind the stack upon panic.
Terminate the process upon panic.

schemas: dependencies

main:
Profile settings can be overridden for specific packages and build-time
crates. To override the settings for a specific package, use the `package`
table to change the settings for the named package:

```toml
# The `foo` package will use the -Copt-level=3 flag.
[profile.dev.package.foo]
opt-level = 3
```

The package name is actually a [Package ID Spec](https://doc.rust-lang.org/cargo/reference/pkgid-spec.html), so you can
target individual versions of a package with syntax such as
`[profile.dev.package."foo:2.1.0"]`.

To override the settings for all dependencies (but not any workspace member),
use the `"*"` package name:

```toml
# Set the default for dependencies.
[profile.dev.package."*"]
opt-level = 2
```

To override the settings for build scripts, proc macros, and their
dependencies, use the `build-override` table:

```toml
# Set the settings for build scripts and proc-macros.
[profile.dev.build-override]
opt-level = 3
```

> Note: When a dependency is both a normal dependency and a build dependency,
> Cargo will try to only build it once when `--target` is not specified. When
> using `build-override`, the dependency may need to be built twice, once as a
> normal dependency and once with the overridden build settings. This may
> increase initial build times.

enumValues:
The package can be published.
The package cannot be published.

enumValues:
Use the `README.md` file.
Do not use the default `README.md` file

format: semver

format: semver-requirement

schemas: version

enumValues:
A runnable executable will be produced. This requires that there is a `main` function in the crate which
will be run when the program begins executing. This will link in all Rust and
native dependencies, producing a distributable binary.

enumValues:
A Rust library will be produced.
This is an ambiguous concept as to what exactly is produced because a library
can manifest itself in several forms. The purpose of this generic `lib` option
is to generate the "compiler recommended" style of library. The output library
will always be usable by rustc, but the actual type of library may change from
time-to-time. The remaining output types are all different flavors of
libraries, and the `lib` type can be seen as an alias for one of them (but the
actual one is compiler-defined).

enumValues:
A "Rust library" file will be produced. This is used as an intermediate artifact and can be thought of as a
"static Rust library". These `rlib` files, unlike `staticlib` files, are
interpreted by the compiler in future linkage. This essentially means
that `rustc` will look for metadata in `rlib` files like it looks for metadata
in dynamic libraries. This form of output is used to produce statically linked
executables as well as `staticlib` outputs.

enumValues:
A dynamic Rust library will be produced. This is different from the `lib` output type in that this forces
dynamic library generation. The resulting dynamic library can be used as a
dependency for other libraries and/or executables. This output type will
create `*.so` files on linux, `*.dylib` files on osx, and `*.dll` files on
windows.

enumValues:
A dynamic system library will be produced. This is used when compiling
a dynamic library to be loaded from another language.  This output type will
create `*.so` files on Linux, `*.dylib` files on macOS, and `*.dll` files on
Windows.

enumValues:
A static system library will be produced. This is different from other library outputs in that
the compiler will never attempt to link to `staticlib` outputs. The
purpose of this output type is to create a static library containing all of
the local crate's code along with all upstream dependencies. The static
library is actually a `*.a` archive on linux and osx and a `*.lib` file on
windows. This format is recommended for use in situations such as linking
Rust code into an existing non-Rust application because it will not have
dynamic dependencies on other Rust code.

enumValues:
The output produced is not specified, but if a `-L` path is provided to it then the
compiler will recognize the output artifacts as a macro and it can be loaded
for a program. Crates compiled with this crate type  must only export
[procedural macros](https://doc.rust-lang.org/reference/procedural-macros.html). The compiler will automatically set the `proc_macro`
[configuration option](https://doc.rust-lang.org/reference/conditional-compilation.html). The crates are always compiled with the same target
that the compiler itself was built with. For example, if you are executing
the compiler from Linux with an `x86_64` CPU, the target will be
`x86_64-unknown-linux-gnu` even if the crate is a dependency of another crate
being built for a different target.

main:
The library target defines a "library" that can be used and linked by other
libraries and executables. The filename defaults to `src/lib.rs`, and the name
of the library defaults to the name of the package. A package can have only
one library. The settings for the library can be [customized](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#configuring-a-target) in the `[lib]`
table in `Cargo.toml`.

```toml
# Example of customizing the library in Cargo.toml.
[lib]
crate-type = ["cdylib"]
bench = false
```


key: Build

description:
The `build` field specifies a file in the package root which is a [build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) for building native code. More information can be found in the [build script guide](https://doc.rust-lang.org/cargo/reference/build-scripts.html).

```toml
[package]
# ...
build = "build.rs"
```

The default is `"build.rs"`, which loads the script from a file named
`build.rs` in the root of the package. Use `build = "custom_build_name.rs"` to
specify a path to a different file or `build = false` to disable automatic
detection of the build script.

enumValues: Automatically detect the build file (`build.rs`).

enumValues: Disable automatic detection of the build file.


description: Path to the build file.


key: DebugLevel

description:
The `debug` setting controls the [`-C debuginfo` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#debuginfo) which controls the
amount of debug information included in the compiled binary.

enumValues: No debug info at all, default for `release` profile

enumValues: Debug info without type or variable-level information. Generates more detailed module-level info than `line-tables-only`.

enumValues: Full debug info, default for `dev` profile

enumValues: Line info directives only. For the nvptx* targets this enables [profiling](https://reviews.llvm.org/D46061). For other use cases, `line-tables-only` is the better, more compatible choice.

enumValues: Line tables only. Generates the minimal amount of debug info for backtraces with filename/line number info, but not anything else, i.e. no variable or function parameter info.


key: branch

description: Specify the Git branch to use in case of a [Git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories).


key: default-features

description: Use the default features of the dependency.


key: features

description: List of features to activate in the dependency.


key: git

description:
To depend on a library located in a `git` repository, the minimum information
you need to specify is the location of the repository with the `git` key:

```toml
[dependencies]
rand = { git = "https://github.com/rust-lang-nursery/rand" }
```

Cargo will fetch the `git` repository at this location then look for a
`Cargo.toml` for the requested crate anywhere inside the `git` repository
(not necessarily at the root - for example, specifying a member crate name
of a workspace and setting `git` to the repository containing the workspace).

Since we haven't specified any other information, Cargo assumes that
we intend to use the latest commit on the main branch to build our package.
You can combine the `git` key with the `rev`, `tag`, or `branch` keys to
specify something else. Here's an example of specifying that you want to use
the latest commit on a branch named `next`:

```toml
[dependencies]
rand = { git = "https://github.com/rust-lang-nursery/rand", branch = "next" }
```

See [Git Authentication](https://doc.rust-lang.org/cargo/appendix/git-authentication.html) for help with git authentication for private repos.

> **Note**: [crates.io](https://crates.io/) does not allow packages to be published with `git`
> dependencies (`git` [dev-dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#development-dependencies) are ignored). See the [Multiple
> locations](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#multiple-locations) section for a fallback alternative.


key: optional

description:
Mark the dependency as optional.

Optional dependencies can be activated through features.


key: package

description:
Specify the name of the package.

When writing a `[dependencies]` section in `Cargo.toml` the key you write for a
dependency typically matches up to the name of the crate you import from in the
code. For some projects, though, you may wish to reference the crate with a
different name in the code regardless of how it's published on crates.io. For
example you may wish to:

* Avoid the need to  `use foo as bar` in Rust source.
* Depend on multiple versions of a crate.
* Depend on crates with the same name from different registries.

To support this Cargo supports a `package` key in the `[dependencies]` section
of which package should be depended on:

```toml
[package]
name = "mypackage"
version = "0.0.1"

[dependencies]
foo = "0.1"
bar = { git = "https://github.com/example/project", package = "foo" }
baz = { version = "0.1", registry = "custom", package = "foo" }
```

In this example, three crates are now available in your Rust code:

```rust
extern crate foo; // crates.io
extern crate bar; // git repository
extern crate baz; // registry `custom`
```

All three of these crates have the package name of `foo` in their own
`Cargo.toml`, so we're explicitly using the `package` key to inform Cargo that
we want the `foo` package even though we're calling it something else locally.
The `package` key, if not specified, defaults to the name of the dependency
being requested.


key: path

description:
Cargo supports **path dependencies** which are typically sub-crates that live within one repository.
Let's start off by making a new crate inside of our `hello_world` package:

```console
# inside of hello_world/
$ cargo new hello_utils
```

This will create a new folder `hello_utils` inside of which a `Cargo.toml` and
`src` folder are ready to be configured. In order to tell Cargo about this, open
up `hello_world/Cargo.toml` and add `hello_utils` to your dependencies:

```toml
[dependencies]
hello_utils = { path = "hello_utils" }
```

This tells Cargo that we depend on a crate called `hello_utils` which is found
in the `hello_utils` folder (relative to the `Cargo.toml` it's written in).


key: registry

description:
To specify a dependency from a registry other than [crates.io](https://crates.io), first the
registry must be configured in a `.cargo/config.toml` file. See the [registries
documentation](https://doc.rust-lang.org/cargo/reference/registries.html) for more information. In the dependency, set the `registry` key
to the name of the registry to use.

```toml
[dependencies]
some-crate = { version = "1.0", registry = "my-registry" }
```

> **Note**: [crates.io](https://crates.io) does not allow packages to be published with
> dependencies on other registries.


key: rev

description: Specify the Git revision to use in case of a [Git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories).


key: tag

description: Specify the Git tag to use in case of a [Git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories).


key: Edition

description:
The `edition` key affects which edition your package is compiled with. Cargo
will always generate packages via [`cargo new`](https://doc.rust-lang.org/cargo/commands/cargo-new.html) with the `edition` key set to the
latest edition. Setting the `edition` key in `[package]` will affect all
targets/crates in the package, including test suites, benchmarks, binaries,
examples, etc.


key: Lto

description:
The `lto` setting controls the [`-C lto` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#lto) which controls LLVM's [link time optimizations](https://llvm.org/docs/LinkTimeOptimization.html). LTO can produce better optimized code, using
whole-program analysis, at the cost of longer linking time.

See also the [`-C linker-plugin-lto`](https://doc.rust-lang.org/rustc/codegen-options/index.html#linker-plugin-lto) `rustc` flag for cross-language LTO.

enumValues: Performs "fat" LTO which attempts to perform optimizations across all crates within the dependency graph.

enumValues:
Performs ["thin" LTO](http://blog.llvm.org/2016/06/thinlto-scalable-and-incremental-lto.html). This is similar to "fat", but takes
substantially less time to run while still achieving performance gains
similar to "fat".

enumValues:
Performs "thin local LTO" which performs "thin" LTO on the local
crate only across its [codegen units](https://doc.rust-lang.org/cargo/reference/profiles.html#codegen-units). No LTO is performed
if codegen units is 1 or [opt-level](https://doc.rust-lang.org/cargo/reference/profiles.html#opt-level) is 0.


key: Resolver

description:
A different feature resolver algorithm can be used by specifying the resolver version in Cargo.toml like this:

[package]
name = "my-package"
version = "1.0.0"
resolver = "2"

The version "1" resolver is the original resolver that shipped with Cargo up to version 1.50. The default is "2" if the root package specifies edition = "2021" or a newer edition. Otherwise the default is "1".

The version "2" resolver introduces changes in feature unification. See the features chapter for more details.

The resolver is a global option that affects the entire workspace. The resolver version in dependencies is ignored, only the value in the top-level package will be used. If using a virtual workspace, the version should be specified in the [workspace] table, for example:

[workspace]
members = ["member1", "member2"]
resolver = "2"


key: OptLevel

description:
The `opt-level` setting controls the [`-C opt-level` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#opt-level) which controls the level
of optimization. Higher optimization levels may produce faster runtime code at
the expense of longer compiler times. Higher levels may also change and
rearrange the compiled code which may make it harder to use with a debugger.

It is recommended to experiment with different levels to find the right
balance for your project. There may be surprising results, such as level `3`
being slower than `2`, or the `"s"` and `"z"` levels not being necessarily
smaller. You may also want to reevaluate your settings over time as newer
versions of `rustc` changes optimization behavior.

See also [Profile Guided Optimization](https://doc.rust-lang.org/rustc/profile-guided-optimization.html) for more advanced optimization
techniques.

enumValues: No optimizations, also turns on [`cfg(debug_assertions)`](https://doc.rust-lang.org/cargo/reference/profiles.html#debug-assertions).

enumValues: Optimize for binary size, but also turn off loop vectorization.