description: See Issue #33128

description: overrides autodetection. v1 or v2. Defaults to auto

key: BlockStorageOpenstackOpts


type: object

type: boolean

type: string

type: integer

key: GCEPersistentDiskVolumeSource


description: required

key: RouteOpenstackOpts


required: key path

key: KeyToPath


type: number

key: LinearAutoscalerParams


key: ServiceAccountTokenProjection


type: array

key: AciNetworkProvider


required: key operator

key: LabelSelectorRequirement


description: Services to rotate their certs

description: Rotate CA Certificates

key: RotateCertificates


description: Ingress Controller image

description: KubeDNS side car image

description: Weave Node image

description: mcast daemon container image for Cisco ACI

description: Canal Controllers Image needed for Calico/Canal v3.14.0+

description: host container image for Cisco ACI

description: Canal CNI image

description: Calicoctl image

description: Ingress Webhook image

description: KubeDNS autoscaler image

description: Alpine image

description: OpenvSwitch container image for Cisco ACI

description: Canal Node Image

description: Ingress Controller Backend image

description: etcd image

description: Calico Controllers image

description: rke-cert-deployer image

description: KubeDNS image

description: Pod infra container image for Windows

description: Nodelocal image

description: Kubernetes image

description: GBP Server container image for Cisco ACI

description: Flannel CNI image

description: Opflex Server container image for Cisco ACI

description: opflex agent container image for Cisco ACI

description: Cni deployer container image for Cisco ACI

description: CoreDNS image

description: Metrics Server image

description: CalicoFlexVol image

description: Flannel image

description: CoreDNS autoscaler image

description: Pod infra container image

description: Calico CNI image

description: rke-nginx-proxy image

description: Controller container image for Cisco ACI

description: DNSMasq image

description: CanalFlannel image

description: Calico Node image

description: Weave CNI image

description: rke-service-sidekick image

description: CanalFlexVol image

key: RKESystemImages


key: WorkspaceVsphereOpts


required: cloud tenantId subscriptionId resourceGroup location vnetName vnetResourceGroup subnetName securityGroupName routeTableName primaryAvailabilitySetName vmType primaryScaleSetName aadClientId aadClientSecret aadClientCertPath aadClientCertPassword cloudProviderBackoff cloudProviderBackoffRetries cloudProviderBackoffExponent cloudProviderBackoffDuration cloudProviderBackoffJitter cloudProviderRateLimit cloudProviderRateLimitQPS cloudProviderRateLimitBucket useInstanceMetadata useManagedIdentityExtension maximumLoadBalancerRuleCount

description: The name of the security group attached to the cluster's subnet

description:
Use managed service identity for the virtual machine to access Azure ARM APIs
This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview
For user-assigned managed identity, need to set the below UserAssignedIdentityID

description: Backoff retry limit

description: The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13

description:
The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs
This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md

description:
The Client ID of the user assigned MSI which is assigned to the underlying VMs
This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview

description:
Excludes master nodes (labeled with `node-role.kubernetes.io/master`) from the backend pool of Azure standard loadbalancer, default(nil) to `true`
If want adding the master nodes to ALB, this should be set to `false` and remove the `node-role.kubernetes.io/master` label from master nodes

description: Backoff duration

description: The name of the resource group that the cluster is deployed in

description:
The type of azure nodes. Candidate valudes are: vmss and standard.
If not set, it will be default to standard.

description: Use instance metadata service where possible

description: The location of the resource group that the cluster is deployed in

description: Sku of Load Balancer and Public IP: `basic` or `standard`, default(blank) to `basic`

description: Backoff jitter

description: The ID of the Azure Subscription that the cluster is deployed in

description: (Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in

description: The name of the resource group that the Vnet is deployed in

description: The name of the VNet that the cluster is deployed in

description:
The ClientID for an AAD application with RBAC access to talk to Azure RM APIs
This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md

description: Rate limit Bucket Size

description: Backoff exponent

description: Rate limit QPS

description:
The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs
This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service

description: Enable exponential backoff to manage resource request retries

description:
(Optional) The name of the availability set that should be used as the load balancer backend
If this is set, the Azure cloudprovider will only add nodes from that availability set to the load
balancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then
the cloudprovider will try to add all nodes to a single backend pool which is forbidden.
In other words, if you use multiple agent pools (availability sets), you MUST set this field.

description:
The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs
This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service

description: Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148

description: Enable rate limiting

description: The AAD Tenant ID for the Subscription that the cluster is deployed in

description:
The name of the scale set that should be used as the load balancer backend.
If this is set, the Azure cloudprovider will only add nodes from that scale set to the load
balancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then
the cloudprovider will try to add all nodes to a single backend pool which is forbidden.
In other words, if you use multiple agent pools (scale sets), you MUST set this field.

description: The name of the subnet that the cluster is deployed in

key: AzureCloudProvider


required: search-order request-timeout

key: MetadataOpenstackOpts


description: SSH Private Key

description: Address of Bastion Host

description: SSH Certificate Path

description: SSH Certificate

description: ssh User to Bastion Host

description: SSH Agent Auth enable

description: Ignore proxy environment variables

description: SSH Private Key Path

description: SSH Port of Bastion Host

key: BastionHost


required: secretName shareName

key: AzureFileVolumeSource


description: ConfigFile is a multiline string that represent a custom webhook config file

description: CacheTimeout controls how long to cache authentication decisions

key: AuthWebhookConfig


description:
Period of time in seconds given to each pod to terminate gracefully.
If negative, the default value specified in the pod will be used

description: Continue even if there are pods using emptyDir

description:
Drain node even if there are pods not managed by a ReplicationController, Job, or DaemonSet
Drain will not proceed without Force set to true if there are such pods

description:
If there are DaemonSet-managed pods, drain will not proceed without IgnoreDaemonSets set to true
(even when set to true, kubectl won't delete pods - so setting default to true)

description: Time to wait (in seconds) before giving up for one try

key: NodeDrainInput


required: auth-url username user-id password tenant-id tenant-name trust-id domain-id domain-name region ca-file

key: GlobalOpenstackOpts


key: PortworxVolumeSource


required: zone vpc subnet-id routetable-id role-arn kubernetes-cluster-tag kubernetes-cluster-id disable-security-group-ingress elb-security-group disable-strict-zone-check

description: KubernetesClusterTag is the legacy cluster id we'll use to identify our cluster resources

description: RoleARN is the IAM role to assume when interaction with AWS APIs.

description:
TODO: Is there any use for this?  We can get it from the instance metadata service
Maybe if we're not running on AWS, e.g. bootstrap; for now it is not very useful

description:
During the instantiation of an new AWS cloud provider, the detected region
is validated against a known set of regions.

In a non-standard, AWS like environment (e.g. Eucalyptus), this check may
be undesirable.  Setting this to true will disable the check and provide
a warning that the check was skipped.  Please note that this is an
experimental feature and work-in-progress for the moment.  If you find
yourself in an non-AWS cloud and open an issue, please indicate that in the
issue body.

description: RouteTableID enables using a specific RouteTable

description:
The aws provider creates an inbound rule per load balancer on the node security
group. However, this can run into the AWS security group rule limit of 50 if
many LoadBalancers are created.

This flag disables the automatic ingress creation. It requires that the user
has setup a rule that allows inbound traffic on kubelet ports from the
local VPC subnet (so load balancers can access it). E.g. 10.82.0.0/16 30000-32000.

description: SubnetID enables using a specific subnet to use for ELB's

description:
The AWS VPC flag enables the possibility to run the master components
on a different aws account, on a different cloud provider or on-premises.
If the flag is set also the KubernetesClusterTag must be provided

description: KubernetesClusterID is the cluster id we'll use to identify our cluster resources

description:
AWS has a hard limit of 500 security groups. For large clusters creating a security group for each ELB
can cause the max number of security groups to be reached. If this is set instead of creating a new
Security group for each ELB this security group will be used instead.

key: GlobalAwsOpts


required: lb-version use-octavia subnet-id floating-network-id lb-method lb-provider create-monitor monitor-delay monitor-timeout monitor-max-retries manage-security-groups

description: overrides autodetection.

description: overrides autodetection. Only support v2.

description: If specified, will create floating ip for loadbalancer, or do not create floating ip.

description: default to ROUND_ROBIN.

description: uses Octavia V2 service catalog endpoint

key: LoadBalancerOpenstackOpts


required: apiVersion kind name uid

key: OwnerReference


key: FCVolumeSource


description: Alternate cloud interface for flannel

key: FlannelNetworkProvider


key: KubeproxyService


required: name mountPath

key: ExtraVolumeMount


key: ECRCredentialPlugin


description: A single JSON key name

description: Standard character sets.

enum: GET POST

description: Supported HTTP methods.

description: A JSON Path selecting one or more nodes of the parsed JSON document.

enum: NANOS MICROS MILLIS SECONDS MINUTES HOURS HALF_DAYS DAYS WEEKS MONTHS YEARS DECADES CENTURIES MILLENNIA ERAS FOREVER

description: The chrono unit we want to use.

description: HTTP header map.

description: Some of the reusable base types

key: commonTypes


title: Url

title: Name

required: name url

description: Detection base class

title: Detection

key: Detection


title: Code

enum:
Reconnaissance
Resource Development
Initial Access
Execution
Persistence
Privilege Escalation
Defense Evasion
Credential Access
Discovery
Lateral Movement
Collection
Exfiltration
Command and Control
Impact

title: Tactics

title: Name

title: Tags

title: Description

required: name description

description: Use case base class

title: ExampleUseCase

key: ExampleUseCase


title: Url

title: Name

description: External reference base class

title: Resource

key: Resource


key: AutoUpdateConfig


key: VaultAWSConfig


key: TLSConfig


key: VaultAzureConfig


required: series values

description: This follows the usual series notation '<metric name>{<label name>=<label value>, ...}'.

description: This uses expanded notation to project time series. There are also the special `_` and `stale` values to indicate missing or stale samples

key: series


required: labels value

description: Labels of the sample in the usual series notation '<metric name>{<label name>=<label value>, ...}'

description: Expected value of the PromQL expression.

key: sample


key: externalBuildConfigure


type: number string boolean object array null

description: Specify the type of the action. If omitted or left empty, it is assumed that the type is 'liquibase'.

description: Conditional control of whether the stage is executed or skipped

key: action


title: The order relative to other assets

title: Load asset conditionally based on browser

title: Whether the asset is already minified

title: Whether the assets should be aggregated

title: Optional attributes

title: The source of the asset

key: file


enum: adobe-illustrator alpm apinotes asar asciidoc ash asm aspectj audio avif awk babelrc bash batch bats bazel bazelrc bib binary bitmap bowerrc browserslistrc bzip2 c c# c++ c2hs cbsd clojure clojurescript cmake codespellrc coffee coveragerc crystal csh cson csproj css csslintrc csv cuda cython dart dash def diff directory dockerfile dockerignore dotenv dtd editorconfig edn ejs eot eps erb executable expect file fish flake8 gdscript geojson gherkin gif gitattributes gitconfig gitignore gitlint gitmodules go go-mod go-sum gotmpl gpx graphql groovy gyb gyp gzip handlebars haskell hcl header hgrc html icalendar icns icon idl idris image inc ini inl ino inx jade jar java java-properties javascript jenkins jinja jpeg jshintrc json json5 jsonnet jsx jupyter kml kotlin ksh lean lektor lektorproject less liquid literate-haskell lua mailmap makefile manifest map markdown mdx mention-bot mib modulemap musescore myst ngdoc nim nimble nix non-executable npmignore nunjucks objective-c objective-c++ ocaml otf p12 pdbrc pdf pem perl php pkgbuild plain-text plantuml plist png pofile powershell prettierignore prisma proto puppet purescript pyi pylintrc pypirc pyproj python python2 python3 pyz qml r relax-ng rst ruby rust salt sass sbt scala scheme scss sh shell sln socket solidity spec sql stylus svelte svg swf swift swiftdeps symlink system-verilog tar tcsh terraform tex text thrift tiff toml ts tsv tsx ttf twig twisted txsprofile urdf vb vbproj vcxproj vdx verilog vhdl vim vtl vue wav webp wheel wkt woff woff2 wsgi xhtml xml xquery xsd xsl yaml yamllint yang yin zcml zig zip zpt zsh


enum: conda coursier dart docker docker_image dotnet fail golang lua node perl python python_venv r ruby rust swift pygrep script system

key: language


enum: commit merge-commit push prepare-commit-msg commit-msg post-checkout post-commit post-merge post-rewrite pre-commit pre-merge-commit pre-push pre-rebase manual

key: stage


enum: none information warning error

key: diagnostic


description: A rule

description: Level: 0 disables the rule. For 1 it will be considered a warning, for 2 an error

enum: always never

description: Applicable: always|never: never inverts the rule

description: Value: the value for this rule

key: rule


description: domain names (optionally including subdomains) added to the account, or a string for a suffixed URL using .now.sh or a Custom Deployment Suffix

key: alias


description: environment keys and values

key: env


type: string boolean array integer

description:
Labels is a list of label: values that provide context to an
overflow. The labels are (currently) not stored in the database,
nor they are sent to the API.  Special labels : The remediation
label, if set to true indicate the the originating IP should be
banned.

key: labels


description: destination to store the downloaded file to

pattern: ^(string|regexp)$

description:
The type is mandatory if you want to evaluate the data in
the file, and should be regex for valid (re2) regular
expression per line or string for string per line. The
regexps will be compiled, the strings will be loaded into
a list and both will be kept in memory. Without specifying
a type, the file will be downloaded and stored as file and
not in memory.

description: url to download file from

description:
data allows user to specify an external source of data. This
section is only relevant when cscli is used to install parser
from hub, as it will download the source_url and store it to
dest_file. When the parser is not installed from the hub,
CrowdSec won't download the URL, but the file must exist for the
parser to be loaded correctly.

key: data


contentMediaType: application/json

type: object string

key: createOptions


description: The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.

key: packageExportsEntryPath


x-intellij-language-injection: Shell Script

description: Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.

key: scriptsRestart


description: Run by the 'npm start' command.

key: scriptsStart


description: Run BEFORE the package is uninstalled.

key: scriptsUninstallBefore


description: Run AFTER the package is installed.

key: scriptsInstallAfter


description: Run by the 'npm test' command.

key: scriptsTest


description: A person who has been involved in creating or maintaining this package.

format: uri

format: email

key: person


description: Run AFTER the package is published.

key: scriptsPublishAfter


description: Run by the 'npm stop' command.

key: scriptsStop


description: URL to a website with details about how to fund the package.

key: fundingUrl


description: Run BEFORE bump the package version.

key: scriptsVersionBefore


description: Dependencies are specified with a simple hash of package name to version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.

key: dependency


description:
This is a set of characters that can include `-` or `|`
- `-` - indicates a range of characters: `a-c` => `abc`
- `|` - is a group separator, indicating that the characters on either side    are not related.

key: CharacterSet


description: This matches the name in a pattern definition.

key: PatternId


description:
Selected Hunspell AFF content. The content must be UTF-8

Sections:
- TRY
- MAP
- REP
- KEY
- ICONV
- OCONV

Example: ```hunspell # Comment TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` MAP aàâäAÀÂÄ MAP eéèêëEÉÈÊË MAP iîïyIÎÏY MAP oôöOÔÖ MAP (IJ)(Ĳ) ```

description: The costs to apply when using the hunspell settings

description: The cost of inserting / deleting / or swapping any `tryChars` Defaults to `baseCosts`

description:
mapSet replacement cost is the cost to substitute one character with another from the same set.

Map characters are considered very similar to each other and are often the cause of simple mistakes.

description: The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.

description: The cost to substitute pairs found in the replace settings.

description: This is the base cost for making an edit.

description: This is the cost for characters not in the alphabet.

description: The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.

description:
The cost to convert between convert pairs.

The value should be slightly higher than the mapCost.

description:
The cost of replacing or swapping any adjacent keyboard characters.

This should be slightly cheaper than `tryCharCost`.

description: The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.

key: HunspellInformation


description: A File System Path to a dictionary file.

key: DictionaryPath


description: The module or path to the the reporter to load.

key: ReporterModuleName


deprecationMessage: Use `0.2` instead.

description: Legacy Configuration File Versions.

key: VersionLegacy


required: id regexp penalty

description: The amount of penalty to apply.

description: RegExp pattern to match

description: Id of the Adjustment, i.e. `short-compound`

key: PatternAdjustment


description: This can be '*', 'typescript', 'cpp', 'json', etc.

key: LanguageIdSingle


required: insDel map

description:
The set of substrings to map, these are generally single character strings.

Multiple sets can be defined by using a `|` to separate them.

Example: `"eéê|aåá"` contains two different sets.

To add a multi-character substring use `()`.

Example: `"f(ph)(gh)"` results in the following set: `f`, `ph`, `gh`.

- To match the beginning of a word, use `^`: `"(^I)""`.
- To match the end of a word, use `$`: `"(e$)(ing$)"`.

description: A description to describe the purpose of the map.

description: The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.

description:
Add a penalty to the final cost. This is used to discourage certain suggestions.

Example: ```yaml # Match adding/removing `-` to the end of a word. map: "$(-$)" replace: 50 penalty: 100 ```

This makes adding a `-` to the end of a word more expensive.

Think of it as taking the toll way for speed but getting the bill later.

description: The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.

description: The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.

key: CostMapDefInsDel


enum: Base64 Base64MultiLine Base64SingleLine CStyleComment CStyleHexValue CSSHexValue CommitHash CommitHashLink Email EscapeCharacters HexValues href PhpHereDoc PublicKey RsaCert SshRsa SHA HashStrings SpellCheckerDisable SpellCheckerDisableBlock SpellCheckerDisableLine SpellCheckerDisableNext SpellCheckerIgnoreInDocSetting string UnicodeRef Urls UUID Everything

key: PredefinedPatterns


description: Configuration File Version.

key: VersionLatest


description: This can be 'typescript,cpp,json,literal haskell', etc.

key: LanguageIdMultiple


enum: user workspace folder

description: Specifies the scope of a dictionary.

key: CustomDictionaryScope


required: map replace

key: CostMapDefReplace


description: Simple Glob string, the root will be globRoot.

key: SimpleGlob


description:
This a negative reference to a named dictionary.

It is used to exclude or include a dictionary by name.

The reference starts with 1 or more `!`.
- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.
- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.    Overrides `!<dictionary_name>`.
- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.    Overrides `!!<dictionary_name>`.

key: DictionaryNegRef


description:
This is the name of a dictionary.

Name Format:
- Must contain at least 1 number or letter.
- Spaces are allowed.
- Leading and trailing space will be removed.
- Names ARE case-sensitive.
- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.

key: DictionaryId


description: A File System Path. Relative paths are relative to the configuration file.

key: FsDictionaryPath


required: map swap

key: CostMapDefSwap


enum: metadata content

description:
The Strategy to use to detect if a file has changed.
- `metadata` - uses the file system timestamp and size to detect changes (fastest).
- `content` - uses a hash of the file content to check file changes (slower - more accurate).

key: CacheStrategy


key: FsPath


description: This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.

key: LocaleId


description: This is the base cost for making an edit.

description: This is the cost for characters not in the alphabet.

description: The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.

description: The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.

description: The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.

key: EditCosts


key: LanguageIdMultipleNeg


enum: inject-variables clean checkout artifact-download

key: predefinedTask


description: Variables can be used to make values available when building plans in Bamboo.

key: keyValue


description: A plan defines everything about your continuous integration build process in Bamboo.

key: plan


description: A deployment project in Bamboo is a container for holding the software project you are deploying: releases that have been built and tested, and the environments to which releases are deployed

title: Deployment projects

key: deployment


description: Builds and deployments are normally run on the Bamboo agent's native operating system

title: Docker

key: docker


enum: junit mstest nunit mocha testng

key: testParser


enum: plan-failed plan-completed plan-status-changed plan-comment-added plan-responsibility-changed job-completed job-status-changed job-failed job-error job-first-failed job-hung job-queue-timeout job-queued-without-capable-agents

key: events


key: releaseNaming


description: Will await for execution by user

description: Will be executed regardless of other stages state (pass or fail)

description: Stages group jobs to individual steps within a plan's build process.

title: Stage

key: stage


required: name alias view

description: The friendly name of the grid editor, shown in the backoffice.

description: This is front end Razor view for your grid editor. Accepts full path to a custom view, e.g. `~/App_Plugins/FolderName/editor.cshtml`.

description: This must be a unique alias to your grid editor.

description: A CSS class for the icon to be used in the 'Select Editor' dialog, e.g. `icon-autofill`.

description: Configuration for the grid editor. Can be used with textstring and media views or for custom configuration properties.

description: If used with the textstring view, this accepts inline CSS to style the textstring box, e.g. `font-size: 30px; line-height: 40px; font-weight: bold;`.

description: If used with the textstring view, this allows wrapping the value in custom markup, e.g. `<h2>#value#</h2>`.

description: If used with the media view, this accepts hight and width key/value pairs for cropping.

description: Width of image in pixels.

description: Height of image in pixels.

description: This is backoffice HTML view for your grid editor. Either refers to one of the built-in view (textstring, rte, embed, macro, media) or the full path to a custom view, e.g. `~/App_Plugins/FolderName/editor.html`.

key: gridEditor


required: name alias

description: A section/application to extend the backoffice.

description: The alias of the section/application which can be queried via the Section Service API.

description: The friendly name of the section/application, shown in the backoffice.

key: section


required: name alias icon view

description: The friendly name of the content app that appears under the icon.

description: The weight (sort order) of the content app. Default is 0, use values between -99 and +99 to appear between the existing Content (-100) and Info (100) apps.

description: See documentation for examples of rules: https://our.umbraco.com/Documentation/Extending/Content-Apps/#limiting-according-to-type.

description: A list of rules to show or hide the content app based on content, media and member types.

description: A unique alias of the content app.

description: A CSS class for the icon to be used for the content app, e.g. `icon-calculator`.

description: This is the full path to the HTML view for your content app.

key: contentApp


required: alias view sections

description: A dashboard to display contextual information when in a section/application.

description: A list of what user groups aliases are granted or denied permission to see the dashboard. All users will have access if not specified.

description: A user group alias who is denied access.

description: A user group alias who is granted access.

description: The alias of the dashboard which can be queried via the Dashboard Service API.

description: A list of section/application aliases that the dashboard should be visible in.

description: The weight (sort order) of the dashboard. Defaults to 100 if not specified.

description: This is the full path to the HTML view for your dashboard.

key: dashboard


description: The type of editor to use for this prevalue field.

description: A more detailed description for the user.

description: A unique key for the prevalue field.

description: The user friendly label for the prevalue.

description: This is the collection of prevalue fields.

key: fields


description: This describes details about the editor.

description: If set to true, this hides the label for the property editor when used on a document type.

description: If set to true, this will disable the default read-only overlay and requires the editor to implement support for this instead.

description: If set to true, this makes the property editor read-only.

enum: STRING JSON DATETIME TEXT INT

description: This is the type of data you want your property editor to save to the database.

description: Object describing required validators on the editor.

description: This is the full path to the HTML view for your property editor.

key: editor


description: List of scope strings.

description: Scope string.

description: Space and comma-separated strings

description: Specify token scope to limit an application's access to a user's account.

key: scopes


description: Retry block. Optional, if using a default retry policy.

description: Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.

description: Maximum number of times a step will be retried, not counting the initial step execution attempt.

description: Block that controls how retries occur.

description: Delay in seconds between the initial failure and the first retry.

description: Multiplier applied to the previous delay to calculate the delay for the subsequent retry.

description: Maximum delay in seconds between retries.

description: Default retry policy. Optional, if using retry block. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}.

description: Define a retry policy to retry steps that return a specific error code.

key: retry


description: Stop a workflow's execution and return a value, variable, or expression.

key: return


description: Error message string.

description: Error message map.

description: Error message string.

description: Error code.

description: Raise an exception.

key: raise


description: The step name.

const: end

description: Stop a workflow's execution without returning a value.

const: continue

description: Terminate the current iteration of a for loop and continue with the next iteration.

const: break

description: Terminate iteration of a for loop.

description: Define what step Workflows should execute next.

key: next


description: Standard library module for HTTP/S request support.

description: Standard library module for common system interface.

description: Standard library module for event support.

description: A subworkflow.

description: A Google Cloud API connector.

description: Run a function and return a result.

key: call


description: Assign the result from a call to this variable.

key: result


description: A single variable assignment.

description: A list of variable assignment maps.

key: assign


description: A string which is template-expanded before usage.


title: Term

description: Common lists of terms shared between policy files can be placed in an include file. Create an item in the list with a single property, 'include', that references the path to the include file. The path will be resolved relative to the --base_directory given to aclgen, which is './policies/' by default.

title: Include Term List

key: term


description: If in script mode what Type to place on script tag

default: Raw

enum: Raw Script

description: The way the template is injected into the HTML page.

description: If in script mode what Id to place on the script tag.

key: templateOptions


description: The options to configure the chosen browser engine for Chutzpah to use.

description: The path to the chrome/chromium executable on the machine

key: engineOptions


description: Server settings let you enable to configure Chutzpah web server mode.

description: The default port to use. If this port is taken Chutzpah will try incrementing until it finds an available one.

description: Determines if the web server mode is enabled.

description: The root path of the server. All file paths are relative to this and should be in a directory below or equal to this. Defaults to drive root.

key: serverSettings


description: The file for the transform to save its output to.

description: The name of the transform to execute

key: transformConfig


description: The source file/directory

description: The file/directory that source file/directory is mapped to. Specifying a file OutputPath and a directory for SourcePath indicated the files are being concatenated into one large file

default: Folder

enum: File Folder

description: The type (file or folder) that the output path refers to. If not specified Chutzpah will try to take a best guess by assuming it is a file if it has a .js extension

key: compilePathMap


description: This is an optional array of exclude glob patterns.  Only files not matching the Exclude patterns will be added.

description: The path to either a file or a folder. If given a folder, it will be scanned recursively. This path can be relative to the location of the chutzpah.json file.

description: This is an optional array of include glob patterns. Only files matching the Include pattern will be added.

key: testSettings


description: Command to be run to generate output files.

description: Output dir to where static files end up.

description: Additional environment variables available during build.

title: Build static app

key: StaticBuild


title: Needs

key: Needs


description: Command to be run to for dev mode.

description: Port override, by default just assigns next port starting from listen-port.

description: Additional environment variables available local run.

description: Run plugin override. Defaults to first supported plugin available.

title: Run config

key: Run


description: Output dir to where built files end up.

title: Build function app

key: FunctionBuild


description: Package patterns to exclude (or force include if starts with '!').

title: Function package config

key: FunctionPackage


description: Basic auth realm name, defaults to 'restricted'.

description: Basic auth users in form of `user: password` where password is either in plain text or in a form of apr1 hash (used by htpasswd).

title: Static app basic auth config

key: StaticBasicAuth


title: CDN

key: CDN


description: Maximum scale of container deployment (used if deployment uses a container).

description: File/dir patterns to exclude (or force include if starts with '!').

description: Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.

description: Minimum scale of container deployment (used if deployment uses a container).

description: Deploy plugin override. Defaults to first supported plugin available.

title: Static deploy config

key: StaticDeploy


description: Docker build-args.

description: Docker image to use. If specified, will try to pull this image if skip-build is enabled.

description: Skip this image build phase. If enabled, requires image to be either present on docker host or custom image to be possible to pull.

description: Skip this image dependencies pull phase. As a result, doesn't check for newer versions of tagged dependencies. Useful if dependencies do not exist outside of local docker.

description: Docker context directory, relative to application dir.

description: Dockerfile to use, relative to context path. Defaults to 'Dockerfile'.

title: Service app build definition

key: ServiceBuild


description: Scheduler cron, e.g. */30 * * * * runs every 30 minutes.

description: Path to call in current app url.

description: Additional headers to use for this call.

description: Name of cron (just for information purpose).

enum: GET POST HEAD PUT DELETE PATCH OPTIONS

description: HTTP method to use. Defaults to 'GET'.

title: Scheduler config

key: Scheduler


description: Memory limit in MiB of function deployment.

description: Additional environment variables.

title: Function deploy config

key: FunctionDeploy


description: Docker entrypoint (ENTRYPOINT) to override.

description: Docker command (CMD) to override.

description: Docker container port to use.

title: Service app container definition

key: ServiceContainer


description: containerlab config engine parameters

markdownDescription: config variables passed to config engine

key: config-config


required: cert key

description: Certificate Authority

description: Path to the CA certificate file. If set, it is expected that the CA certificate already exists by that path

description: CA certificate validity duration. Can only be set if the external CA certificate is not provided

description: Key size. Can only be set if the external CA certificate is not provided

description: Path to the CA key file. If set, it is expected that the CA certificate already exists by that path

key: certificate-authority-config


markdownDescription: Node's [Certificate configuration options](https://containerlab.dev/manual/nodes/#certificate)

description: Node's Certificate configuration option

markdownDescription: Set to `true` to [generate a TLS certificate for the node](https://containerlab.dev/manual/nodes/#certificate)

description: Set to `true` to generate a TLS certificate for the node

key: certificate-config


markdownDescription: link configuration container

description: link configuration container

description: endpoints list

markdownDescription: link-scoped variables used by config engine

key: link-config


markdownDescription: Node's [DNS configuration options](https://containerlab.dev/manual/nodes/#dns)

description: Node's DNS configuration option

description: DNS search domains

description: DNS options

description: DNS server addresses

key: dns-config


description: node's extra configurations

description: list of SR Linux agent's config files to be copied to the NOS filesystem

markdownDescription: list of [SR Linux agent's config files](https://containerlab.dev/manual/kinds/srl/#user-defined-custom-agents-for-sr-linux-nodes) to be copied to the NOS filesystem

description: http/s proxy to be used by mysocketctl

key: extras-config


default: singleLine

enum: multipleLines singleLine none

description: SingleLine minifies everything to a single line. MultipleLines breaks the minified code into multiple lines for easier reading.

description: For the multi-line output feature, how many spaces to use when indenting a block (see outputMode).

key: ajaxminBaseSettings


description: HTML only. Preserve case of tag and attribute names.

description: HTML only. Indicating whether the parsing is occurring on an HTML fragment, to avoid creating missing tags (like html, body, head).

description: HTML only. Minify CSS code in style attributes.

description: HTML only. Remove optional end tags.

description: HTML only. Minify CSS code in style tags.

description: HTML only. Indicating whether to remove quoted attributes when possible.

description: HTML only. Indicating whether to collapse whitespaces.

description: HTML only. Minify JS code in script tags.

description: HTML only. Indicating whether to keep one space when collapsing.

description: HTML only. Remove values from boolean attributes.

description: HTML only. Remove all HTML comments except conditional, noindex, Knockout.js containerless comments and Angular.js comment directives.

key: htmlBundle


description: Optional, but recommended to contain notes for what the user is supposed to do now that this property is deprecated. Supports GFM.

description: JSON Object that indicates that this object is deprecated.

title: json object

key: deprecation


description: specifies the license under which this service is released

title: license

description: URL of the license itself

description: Name of the license - e.g. MIT

key: license


required: name value

description: the name and identifier of the attribute.

description: a JSON object that is usually utilized by a downstream Generator.

title: json object

title: attribute

key: attribute


description: URL pointing to the contact information

description: Identifying name of the contact person/organization

description: Email address of the contact person/organization

description: Specifies contact information for this service

title: contact information

key: contact


description: The complete URI to the service specification that we are importing. Within API Builder, you can find the URL to the service specification by clicking on the "service.json" link for a service.

title: import

key: import


description: Specifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec.

title: API documentation

key: apidoc


description: Key/value pairs that provide additional information about the object.

description: A set of distinct strings that provide additional information.

key: propertyBag


required: _kind type val

key: xstr


required: _kind lat lng

key: coord


enum: INF -INF NaN

key: numberSpecial


markdownDescription:
**templates** (array<string>) _recommended_

The template files scope to test in this suite. The full chart will be rendered, however only the listed templates are filtered for validation.

 Template files that are put in a templates sub-folder can be addressed with a linux path separator. Also the `templates/` can be omitted.

Partial templates (which are prefixed with and _) are added automatically even if it is in a templates sub-folder, you don't need to add them again.

description: The template files scope to test in this suite. The full chart will be rendered, however only the listed templates are filtered for validation. Template files that are put in a templates sub-folder can be addressed with a linux path separator. Also the templates/ can be omitted. Partial templates (which are prefixed with and _) are added automatically even if it is in a templates sub-folder, you don't need to add them again.

key: templates


markdownDescription:
**documentIndex** (integer) _optional_

The index of rendered documents (divided by ---) to be tested, default to -1, which results in asserting all documents (see Assertion).

Generally you can ignored this field if the template file render only one document.

key: documentIndex


markdownDescription:
**templates** (array<string>) _optional_
. List of specs for length comparison.

description: The set of paths to assert.Map keys in path containing periods (.) are supported with the use of a jq-like syntax.

markdownDescription:
**path** (string) _required_

The `set` path to assert.

Map keys in path containing periods (.) are supported with the use of a jq-like syntax.

description: The set path to assert. Map keys in path containing periods (.) are supported with the use of a jq-like syntax.

key: assertion


markdownDescription:
**capabilities** (object) _optional_

Define the `{{ .Capabilities }}` object.

description: Define the {{ .Capabilities }} object.

markdownDescription:
**majorVersion** (string) _optional_

The kubernetes major version, default to the major version which is set by helm.

markdownDescription:
**apiVersions** (array<string>) _optional_

A set of versions, default to the versionset used by the defined kubernetes version.

markdownDescription:
**minorVersion** (string) _optional_

The kubernetes minor version, default to the minor version which is set by helm.

key: capabilities


markdownDescription:
**chart** (object) _optional_

Define the `{{ .Chart }}` object.

description: Define the {{ .Chart }} object.

markdownDescription:
**version** (string) _optional_

The semantic version of the chart, default to the version set in the Chart.

markdownDescription:
**appVersion** (string) _optional_

The app-version of the chart, default to the app-version set in the Chart.

key: chart


markdownDescription:
**values** (array<string>) _recommended_

.The test values to apply for rendering of this chart.

key: values


markdownDescription:
**release** (object) _optional_

Define the `{{ .Release }}` object.

description: Define the {{ .Release }} object.

markdownDescription:
**upgrade** (boolean) _optional_

Whether the build is an upgrade, default to `false`.

description: Whether the build is an upgrade, default to false.

markdownDescription:
**namespace** (string) _optional_

The namespace which release be installed to, default to `"NAMESPACE"`.

description: The namespace which release be installed to, default to "NAMESPACE".

markdownDescription:
**name** (string) _optional_

The release name, default to `"RELEASE-NAME"`.

description: The release name, default to "RELEASE-NAME".

markdownDescription:
**revision** (string) _optional_

The revision of current build, default to `0`.

description: The revision of current build, default to 0.

key: release


enum: BATCH_JOB_STATE_TYPE_UNSPECIFIED 0 PENDING 1 STARTED 2 ERROR_STARTING 3 RUNNING 4 FINISHED 5 ERROR 6


enum: CONSENT_LEVEL_TYPE_UNSPECIFIED 0 CUMULATIVE 1 GRANULAR 2

description:
Consent level is meant to interpret the consent-levels of an event for decryption purposes only.

Cumulative means that the highest consent-level in an event must be greater than or equal to the single requested level
for the decrypted stream.

Granular means that the set of consent-levels in an event must enclose the set of requested event levels for the
decrypted stream.

markdownEnumDescriptions:
(or 0)
(or "CONSENT_LEVEL_TYPE_UNSPECIFIED")
(or 1)
(or "CUMULATIVE")
(or 2)
(or "GRANULAR")


enum: null boolean int long float double bytes string

description: Basic type primitives.

title: Primitive Type

key: primitiveType


description: The `BUILD_ID` to use for this task.

key: buildId


description: The `GENERATE_ID` to use for this task.

key: generateId


description: Determines if this task is disabled.

key: disable


enum: linux windows darwin freebsd netbsd openbsd dragonfly solaris

key: platform


enum: concurrency rps

key: ScaleOptions


title: secret

title: configmap

key: Volume


key: ResourcesLimitsOptions


key: ResourcesRequestsOptions


required: type id src

key: invokeObject


description:
Cargo bakes in the concept of [Semantic Versioning](https://semver.org/), so make sure you follow some basic rules:

* Before you reach 1.0.0, anything goes, but if you make breaking changes,
    increment the minor version. In Rust, breaking changes include adding fields to
    structs or variants to enums.
* After 1.0.0, only make breaking changes when you increment the major version.
    Don't break the build.
* After 1.0.0, don't add any new public API (no new `pub` anything) in patch-level
    versions. Always increment the minor version if you add any new `pub` structs,
    traits, fields, types, functions, methods or anything else.
* Use version numbers with three numeric parts such as 1.0.0 rather than 1.0.

format: semver

title: Semantic Version

key: SemVer


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

description: A boolean indicating whether the package can be published.

description: An array of registry names.

description:
The `publish` field can be used to prevent a package from being published to a package registry (like *crates.io*) by mistake, for instance to keep a package
private in a company.

```toml
[package]
# ...
publish = false
```

The value may also be an array of strings which are registry names that are
allowed to be published to.

```toml
[package]
# ...
publish = ["some-registry-name"]
```

title: Publish

key: Publish


description: Path to the build file.

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

enumValues: Disable automatic detection of the build file.

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.

title: Build

key: Build


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

description:
The `readme` field should be the path to a file in the package root (relative
to this `Cargo.toml`) that contains general information about the package.
This file will be transferred to the registry when you publish. [crates.io](https://crates.io)
will interpret it as Markdown and render it on the crate's page.

```toml
[package]
# ...
readme = "README.md"
```

If no value is specified for this field, and a file named `README.md`,
`README.txt` or `README` exists in the package root, then the name of that
file will be used. You can suppress this behavior by setting this field to
`false`. If the field is set to `true`, a default value of `README.md` will
be assumed.

title: Readme

key: Readme


description:
You can explicitly specify that a set of file patterns should be ignored or
included for the purposes of packaging. The patterns specified in the
`exclude` field identify a set of files that are not included, and the
patterns in `include` specify files that are explicitly included.

The patterns should be [gitignore](https://git-scm.com/docs/gitignore)-style patterns. Briefly:

- `foo` matches any file or directory with the name `foo` anywhere in the
  package. This is equivalent to the pattern `**/foo`.
- `/foo` matches any file or directory with the name `foo` only in the root of
  the package.
- `foo/` matches any *directory* with the name `foo` anywhere in the package.
- Common glob patterns like `*`, `?`, and `[]` are supported:
  - `*` matches zero or more characters except `/`.  For example, `*.html`
    matches any file or directory with the `.html` extension anywhere in the
    package.
  - `?` matches any character except `/`. For example, `foo?` matches `food`,
    but not `foo`.
  - `[]` allows for matching a range of characters. For example, `[ab]`
    matches either `a` or `b`. `[a-z]` matches letters a through z.
- `**/` prefix matches in any directory. For example, `**/foo/bar` matches the
  file or directory `bar` anywhere that is directly under directory `foo`.
- `/**` suffix matches everything inside. For example, `foo/**` matches all
  files inside directory `foo`, including all files in subdirectories below
  `foo`.
- `/**/` matches zero or more directories. For example, `a/**/b` matches
  `a/b`, `a/x/b`, `a/x/y/b`, and so on.
- `!` prefix negates a pattern. For example, a pattern of `src/**.rs` and
  `!foo.rs` would match all files with the `.rs` extension inside the `src`
  directory, except for any file named `foo.rs`.

If git is being used for a package, the `exclude` field will be seeded with
the `gitignore` settings from the repository.

```toml
[package]
# ...
exclude = ["build/**/*.o", "doc/**/*.html"]
```

```toml
[package]
# ...
include = ["src/**/*", "Cargo.toml"]
```

The options are mutually exclusive: setting `include` will override an
`exclude`. Note that `include` must be an exhaustive list of files as otherwise
necessary source files may not be included. The package's `Cargo.toml` is
automatically included.

The include/exclude list is also used for change tracking in some situations.
For targets built with `rustdoc`, it is used to determine the list of files to
track to determine if the target should be rebuilt. If the package has a
[build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) that does not emit any `rerun-if-*` directives, then the
include/exclude list is used for tracking if the build script should be re-run
if any of those files change.

key: Include


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

enum: unwind abort

description:
The `panic` setting controls the [`-C panic` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#panic) which controls which panic
strategy to use.

When set to `"unwind"`, the actual value depends on the default of the target
platform. For example, the NVPTX platform does not support unwinding, so it
always uses `"abort"`.

Tests, benchmarks, build scripts, and proc macros ignore the `panic` setting.
The `rustc` test harness currently requires `unwind` behavior. See the
[`panic-abort-tests`](https://doc.rust-lang.org/cargo/reference/unstable.html#panic-abort-tests) unstable flag which enables `abort` behavior.

Additionally, when using the `abort` strategy and building a test, all of the
dependencies will also be forced to built with the `unwind` strategy.

title: Panic

key: Panic


description:
The `rust-version` field is an optional key that tells cargo what version of the
Rust language and compiler your package can be compiled with. If the currently
selected version of the Rust compiler is older than the stated version, cargo
will exit with an error, telling the user what version is required.

The first version of Cargo that supports this field was released with Rust 1.56.0.
In older releases, the field will be ignored, and Cargo will display a warning.

```toml
[package]
# ...
rust-version = "1.56"
```

The Rust version must be a bare version number with two or three components; it
cannot include semver operators or pre-release identifiers. Compiler pre-release
identifiers such as -nightly will be ignored while checking the Rust version.
The `rust-version` must be equal to or newer than the version that first
introduced the configured `edition`.

The `rust-version` may be ignored using the `--ignore-rust-version` option.

Setting the `rust-version` key in `[package]` will affect all targets/crates in
the package, including test suites, benchmarks, binaries, examples, etc.

title: RustVersion

key: RustVersion


description: The `workspace` field allow keys to be inherited by defining them in the member package with `{key}.workspace = true`

title: Workspace

key: WorkspaceInheritance


description:
The description is a short blurb about the package. [crates.io](https://crates.io) will display
this with your package. This should be plain text (not Markdown).

```toml
[package]
# ...
description = "A short description of my package"
```

> **Note**: [crates.io](https://crates.io) requires the `description` to be set.

title: Description

key: Description


description:
The `repository` field should be a URL to the source repository for your
package.

```toml
[package]
# ...
repository = "https://github.com/rust-lang/cargo/"
```

title: Repository

key: Repository


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.

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.

title: Lto

key: Lto


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.

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.

title: Optimization Level

key: OptLevel


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"

title: Resolver

key: Resolver


description:
The `authors` field lists people or organizations that are considered the
"authors" of the package. The exact meaning is open to interpretation — it may
list the original or primary authors, current maintainers, or owners of the
package. These names will be listed on the crate's page on
[crates.io](https://crates.io). An optional email address may be included within angled
brackets at the end of each author.

> **Note**: [crates.io](https://crates.io) requires at least one author to be listed.

title: Authors

key: Authors


description:
The `categories` field is an array of strings of the categories this package
belongs to.

```toml
categories = ["command-line-utilities", "development-tools::cargo-plugins"]
```

> **Note**: [crates.io](https://crates.io) has a maximum of 5 categories. Each category should
> match one of the strings available at https://crates.io/category_slugs, and
> must match exactly.

title: Categories

key: Categories


description:
The `license` field contains the name of the software license that the package
is released under.

[crates.io](https://crates.io/) interprets the `license` field as an [SPDX 2.1 license
expression](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60). The name must be a known license
from the [SPDX license list 3.6](https://github.com/spdx/license-list-data/tree/v3.6). Parentheses are not
currently supported. See the [SPDX site](https://spdx.org/license-list) for more information.

SPDX license expressions support AND and OR operators to combine multiple
licenses.

```toml
[package]
# ...
license = "MIT OR Apache-2.0"
```

Using `OR` indicates the user may choose either license. Using `AND` indicates
the user must comply with both licenses simultaneously. The `WITH` operator
indicates a license with a special exception. Some examples:

* `MIT OR Apache-2.0`
* `LGPL-2.1 AND MIT AND BSD-2-Clause`
* `GPL-2.0+ WITH Bison-exception-2.2`

If a package is using a nonstandard license, then the `license-file` field may
be specified in lieu of the `license` field.

title: License

key: License


description:
The `homepage` field should be a URL to a site that is the home page for your
package.

```toml
[package]
# ...
homepage = "https://serde.rs/"
```

title: Homepage

key: Homepage


description:
The `documentation` field specifies a URL to a website hosting the crate's
documentation. If no URL is specified in the manifest file, [crates.io](https://crates.io) will
automatically link your crate to the corresponding [docs.rs](https://docs.rs) page.

```toml
[package]
# ...
documentation = "https://docs.rs/bitflags"
```

title: Documentation

key: Documentation


description: The [version requirement](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html) of the target dependency.

format: semver-requirement

title: Semantic Version Requirement

schemas: version

key: SemVerRequirement


title: Meta Build

key: MetaBuild


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.

title: Edition

key: Edition


description:
The `license-file` field contains the path to a file
containing the text of the license (relative to this `Cargo.toml`).

```toml
[package]
# ...
license-file = "LICENSE.txt"
```

> **Note**: [crates.io](https://crates.io) requires either `license` or `license-file` to be set.

title: LicenseFile

key: LicenseFile


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.

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.

title: Debug Level

key: DebugLevel


description:
The `keywords` field is an array of strings that describe this package. This
can help when searching for the package on a registry, and you may choose any
words that would help someone find this crate.

```toml
[package]
# ...
keywords = ["gamedev", "graphics"]
```

> **Note**: [crates.io](https://crates.io) has a maximum of 5 keywords. Each keyword must be
> ASCII text, start with a letter, and only contain letters, numbers, `_` or
> `-`, and have at most 20 characters.

title: Keywords

key: Keywords


description:
You can explicitly specify that a set of file patterns should be ignored or
included for the purposes of packaging. The patterns specified in the
`exclude` field identify a set of files that are not included, and the
patterns in `include` specify files that are explicitly included.

The patterns should be [gitignore](https://git-scm.com/docs/gitignore)-style patterns. Briefly:

- `foo` matches any file or directory with the name `foo` anywhere in the
  package. This is equivalent to the pattern `**/foo`.
- `/foo` matches any file or directory with the name `foo` only in the root of
  the package.
- `foo/` matches any *directory* with the name `foo` anywhere in the package.
- Common glob patterns like `*`, `?`, and `[]` are supported:
  - `*` matches zero or more characters except `/`.  For example, `*.html`
    matches any file or directory with the `.html` extension anywhere in the
    package.
  - `?` matches any character except `/`. For example, `foo?` matches `food`,
    but not `foo`.
  - `[]` allows for matching a range of characters. For example, `[ab]`
    matches either `a` or `b`. `[a-z]` matches letters a through z.
- `**/` prefix matches in any directory. For example, `**/foo/bar` matches the
  file or directory `bar` anywhere that is directly under directory `foo`.
- `/**` suffix matches everything inside. For example, `foo/**` matches all
  files inside directory `foo`, including all files in subdirectories below
  `foo`.
- `/**/` matches zero or more directories. For example, `a/**/b` matches
  `a/b`, `a/x/b`, `a/x/y/b`, and so on.
- `!` prefix negates a pattern. For example, a pattern of `src/**.rs` and
  `!foo.rs` would match all files with the `.rs` extension inside the `src`
  directory, except for any file named `foo.rs`.

If git is being used for a package, the `exclude` field will be seeded with
the `gitignore` settings from the repository.

```toml
[package]
# ...
exclude = ["build/**/*.o", "doc/**/*.html"]
```

```toml
[package]
# ...
include = ["src/**/*", "Cargo.toml"]
```

The options are mutually exclusive: setting `include` will override an
`exclude`. Note that `include` must be an exhaustive list of files as otherwise
necessary source files may not be included. The package's `Cargo.toml` is
automatically included.

The include/exclude list is also used for change tracking in some situations.
For targets built with `rustdoc`, it is used to determine the list of files to
track to determine if the target should be rebuilt. If the package has a
[build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) that does not emit any `rerun-if-*` directives, then the
include/exclude list is used for tracking if the build script should be re-run
if any of those files change.

title: Exclude

key: Exclude


description: The unique identifier of the provider to use as default.

key: defaultProvider


description: The file names of the individual files to copy to the project.

description: The relative folder path from this config file to the location where the files should be copied to.

description: The unique identifier of the library.

description: The unique identifier of the provider

key: libraryEntry


description: The default destination to place library files.

key: defaultDestination


description: Set the options for grunt-contrib-copy

description: Will log messages of what would happen if the task was ran but doesn't actually delete the files.

description: This overrides this task from blocking deletion of folders outside current working dir (CWD). Use with caution.

key: options


required: type npm

required: name version

title: Npm

key: Npm


required: type cargo

title: Cargo

key: Cargo


required: type git

required: commitHash repositoryUrl

title: Git

key: Git


required: type rubygems

title: RubyGems

key: RubyGems


required: type nuget

title: NuGet

key: NuGet


required: type linux

required: name version distribution release

title: Linux

key: Linux


required: type maven

required: groupId artifactId version

title: Maven

key: Maven


required: type pip

title: Pip

key: Pip


required: type vcpkg

required: spdxId name

title: VCPKG

key: VCPKG


required: type go

title: Go

key: Go


required: type pod

title: Pod

key: Pod


required: type other

required: name version downloadUrl hash

title: Other

title: Other

key: Other


type: string array

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

key: script


type: string object

default: default

enum: default build

key: dependencies


key: compilationOptions


description: Hook definition

description: hook type

description: hook configuration

key: HookData


description: Set the options for cssmin

default: min

enum: min gzip

description: Either report only minification result or report minification and gzip results. This is useful to see exactly how well clean-css is performing but using  'gzip'  will make the task take 5-10x longer to complete.

type: number string

description: To keep or remove special comments, exposing the underlying option from 'clean-css'.

description: Prefix the compressed source with the given banner, with a linebreak in between.

key: options


description: Kontinuous Chart for this component. see https://github.com/SocialGouv/kontinuous/tree/master/plugins/contrib/charts

examples: app maildev hasura metabase

description: Job or deployment dependencies

key: chart


description: Log format to use for access logs. Ref:- https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.html

description: Enables HTTP access logs (default: true)

description: Enable execution logging (default: true)

description: Log full requests/responses for execution logging (default: true)

enum: INFO ERROR

key: AwsWebsocketLogs


$comment: You can use the AWS::Include transform anywhere within the AWS CloudFormation template except in the template parameters section or the template version field. For example, you can use AWS::Include in the mappings section.

$comment: The location is an Amazon S3 URI, with a specific file name in an S3 bucket. For example, s3://MyBucketName/MyFile.yaml.

$comment: Use a transform to simplify template authoring for serverless applications.

key: Transform


description: Use `${service}-${stage}` naming for API Gateway. Will be `true` by default in v3.

description: Disable the default 'execute-api' HTTP endpoint (default: false)

description: Optional binary media types the API might return

description: Can be used to disable the API key without removing it (default: true)

enum: HEADER AUTHORIZER

key: AwsApiGateway


key: AwsIot


enum: Allow Deny

key: AwsResourcePolicy


type: string number

key: AwsThrottle


key: AwsIdRefHttpApiEventAuthorizer


description: **@deprecated and doesn't work in serverless framework v3**

title: ServerlessServiceConfiguration

key: ServerlessServiceConfiguration


key: AwsWebsocketAuthorizer


key: AwsQuota


title: AwsRestApiLogs

key: AwsRestApiLogs


description: AWS_IAM based authorizer, https://www.serverless.com/framework/docs/providers/aws/events/apigateway#http-endpoints-with-aws_iam-authorizers

title: AwsHttpIamAuthorizerShort

title: AwsHttpIamAuthorizer

required: type arn

description: The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name

description: The arn of the cognito user pool

title: AwsHttpCognitoAuthorizer

description: The identity source for which authorization is requested. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is `method.request.header.Auth, method.request.querystring.Name`

default: token

enum: request token REQUEST TOKEN

title: AwsHttpLambdaAuthorizer

description: Use an existing Api Gateway Authorizer created outside or in the same stack

title: AwsHttpExistingAuthorizer

required: type authorizerId

description: The Id of the existing authorizer

key: AwsHttpAuthorizer


key: AwsNamedHttpApiEventAuthorizer


key: AwsHttpRequestParametersValidation


key: AwsCognitoUserPool


description: Miscellaneous test unit information can be defined. After the execution they are available in the test report.

title: Test Unit Information

caption: This is a caption

Software Under Test

CustomerName: My customer

description: This is a description

description: Caption of the test unit.

description: Version of the test unit.

description: Additional key-value pairs. One key 'name' is required, the other keys can be freely selected.

SUT

customerName: Customer A

description: Description of the test unit.

description: Information on the test developer(s). A sequence of key-value pairs that can be freely selected.

department: Department A

prename: Max

surname: S.

department: Department B

prename: Linda


description: Json schema version for the test unit configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.

title: Version


type: boolean object array

enum: default error warning warn off none

description: Severity level. Level "error" will cause exit code 2.

key: rule


description: Whether the dependency is optional or mandatory

description: The first compatible version

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

description: The latest compatible version

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

key: Dependency


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

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

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

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

key: Contact


required: name until

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

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

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

format: date

key: Contractor


description: Whether to suppress `ANN401` for dynamically typed `*args` and `**kwargs` arguments.

description: Whether to suppress `ANN000`-level violations for arguments matching the "dummy" variable regex (like `_`).

description: Whether to suppress `ANN*` rules for any declaration that hasn't been typed at all. This makes it easier to gradually add types to a codebase.

description:
Whether to suppress `ANN200`-level violations for functions that meet either of the following criteria:

- Contain no `return` statement. - Explicit `return` statement(s) all return `None` (explicitly or implicitly).

description: Whether to allow the omission of a return type hint for `__init__` if at least one argument is annotated.


description:
Whether to avoid PEP 585 (`List[int]` -> `list[int]`) and PEP 604 (`Union[str, int]` -> `str | int`) rewrites even if a file imports `from __future__ import annotations`.

This setting is only applicable when the target Python version is below 3.9 and 3.10 respectively, and is most commonly used when working with libraries like Pydantic and FastAPI, which rely on the ability to parse type annotations at runtime. The use of `from __future__ import annotations` causes Python to treat the type annotations as strings, which typically allows for the use of language features that appear in later Python versions but are not yet supported by the current version (e.g., `str | int`). However, libraries that rely on runtime type annotations will break if the annotations are incompatible with the current Python version.

For example, while the following is valid Python 3.8 code due to the presence of `from __future__ import annotations`, the use of `str| int` prior to Python 3.10 will cause Pydantic to raise a `TypeError` at runtime:

```python from __future__ import annotations

import pydantic

class Foo(pydantic.BaseModel): bar: str | int ```

key: PyUpgradeOptions


enum: text json json-lines junit grouped github gitlab pylint azure

key: SerializationFormat


description: Use Google-style docstrings.

description: Use NumPy-style docstrings.

description: Use PEP257-style docstrings.

key: Convention


description: Ban imports that extend into the parent module or beyond.

description: Ban all relative imports.

key: Strictness


description: Use double quotes.

description: Use single quotes.

key: Quote


description:
The regular expression used to match the copyright notice, compiled with the [`regex`](https://docs.rs/regex/latest/regex/) crate.

Defaults to `(?i)Copyright\s+(\(C\)\s+)?\d{4}(-\d{4})*`, which matches the following: - `Copyright 2023` - `Copyright (C) 2023` - `Copyright 2021-2023` - `Copyright (C) 2021-2023`

description: A minimum file size (in bytes) required for a copyright notice to be enforced. By default, all files are validated.

format: uint

description: Author to enforce within the copyright notice. If provided, the author must be present immediately following the copyright notice.


description: The message to display when the API is used.

key: ApiBan


description: Allow `dict` calls that make use of keyword arguments (e.g., `dict(a=1, b=2)`).


description: Additional functions or classes to consider generic, such that any subscripts should be treated as type annotation (e.g., `ForeignKey` in `django.db.models.ForeignKey["User"]`.

key: PyflakesOptions


description: Place "closer" imports (fewer `.` characters, most local) before "further" imports (more `.` characters, least local).

description: Place "further" imports (more `.` characters, least local) imports before "closer" imports (fewer `.` characters, most local).

key: RelativeImportsOrder


enum: tuple list

key: ParametrizeValuesRowType


description: The length of a line of text that is considered too long.

key: LineLength


description: The function names to consider as internationalization calls.

description: Additional function names to consider as internationalization calls, in addition to those included in `function-names`.


description: Maximum string length for string literals in exception messages.


description: Exempt classes that list any of the enumerated classes as a base class from needing to be moved into type-checking blocks.

description: Exempt certain modules from needing to be moved into type-checking blocks.

description: Enforce TC001, TC002, and TC003 rules even when valid runtime imports are present for the same module. See flake8-type-checking's [strict](https://github.com/snok/flake8-type-checking#strict) option.

description: Exempt classes decorated with any of the enumerated decorators from needing to be moved into type-checking blocks.


description: A list of directories to consider temporary.

description: Whether to disallow `try`-`except`-`pass` (`S110`) for specific exception types. By default, `try`-`except`-`pass` is only disallowed for `Exception` and `BaseException`.

description: A list of directories to consider temporary, in addition to those specified by `hardcoded-tmp-directory`.


description: A list of names to ignore when considering `flake8-self` violations.


description: Whether to allow unused variadic arguments, like `*args` and `**kwargs`.


description: The maximum McCabe complexity to allow before triggering `C901` errors.

key: McCabeOptions


enum: bytes complex float int str tuple

key: ConstantType


description: Additional callable functions to consider "immutable" when evaluating, e.g., the `no-mutable-default-argument` rule (`B006`) or `no-function-call-in-dataclass-defaults` rule (`RUF009`).


enum: future standard-library third-party first-party local-folder

key: ImportType


description: Ignore list of builtins.


description: The size of a tab.

key: TabSize


description: A list of names (or patterns) to ignore when considering `pep8-naming` violations.

description:
A list of decorators that, when applied to a method, indicate that the method should be treated as a static method (in addition to the builtin `@staticmethod`).

For example, Ruff will expect that any method decorated by a decorator in this list has no `self` or `cls` argument.

description:
A list of decorators that, when applied to a method, indicate that the method should be treated as a class method (in addition to the builtin `@classmethod`).

For example, Ruff will expect that any method decorated by a decorator in this list takes a `cls` argument as its first argument.


description: A mapping from module to conventional import alias. These aliases will be added to the `aliases` mapping.

description: A mapping from module to its banned import aliases.

description: A list of modules that are allowed to be imported from

description: The conventional aliases for imports. These aliases can be extended by the `extend_aliases` option.


description:
Whether to allow implicit string concatenations for multiline strings. By default, implicit concatenations of multiline strings are allowed (but continuation lines, delimited with a backslash, are prohibited).

Note that setting `allow-multiline = false` should typically be coupled with disabling `explicit-string-concatenation` (`ISC003`). Otherwise, both explicit and implicit multiline string concatenations will be seen as violations.


default: reports/mutation/events

description: The base dir to write the events to

title: EventRecorderOptions

key: eventRecorderOptions


enum: off fatal error warn info debug trace

tsEnumNames: Off Fatal Error Warning Information Debug Trace

title: LogLevel

key: logLevel


description: The relative filename for the json report.

title: JsonReporterOptions

key: jsonReporterOptions


description: Override the default babel plugins Stryker uses to parse your JavaScript files. The default list of plugins is extensive and normally doesn't need overriding. Stryker also loads your babel plugins by default (if you have them). If Stryker's default babel plugins conflicts with your plugins, try to override this list with an empty array.

key: mutatorDescriptor


description: The `fileName` of the html report.

title: HtmlReporterOptions

key: htmlReporterOptions


enum: full mutationScore

tsEnumNames: Full MutationScore

title: ReportType

key: reportType


description: Enable emojis in your clear text report (experimental).

description: Indicates the maximum amount of test to log when `logTests` is enabled

description: Indicates whether or not to use color coding in output.

description: Indicates whether or not to log which tests were executed for a given mutant.

title: ClearTextReporterOptions

key: clearTextReporterOptions


description: decide whether or not to log warnings when additional stryker options are configured

description: decide whether or not to log warnings when Stryker detects a slow part of mutation that can be sped up by changing some configuration. For example using `--ignoreStatic`.

description: decide whether or not to log warnings when a preprocessor error occurs. For example, when the disabling of type errors fails.

description: decide whether or not to log warnings when a configuration options are unserializable. For example, using a `/regex/` or `function` in your configuration options.

title: WarningOptions

key: warningOptions


enum: off all perTest

title: CoverageAnalysis

key: coverageAnalysis


default: npm test

description: The command to test each mutant. For example "npm run mocha". Defaults to "npm test".

title: CommandRunnerOptions

key: commandRunnerOptions


description: change the mtu of the device


description: local IPv4 address of the tunnel


type: integer string

description: specifies a master device name or index


description: specifies a device group name or index


description: ip address with prefix length

description: list of ip address prefixes to be ignored

key: ignore-ipaddr


description: link mac address (xx:xx:xx:xx:xx:xx)


default: boot

default: main

description: filter routes by options

key: ignore-routes


default: auto

enum: auto xdp xdpgeneric xdpoffload

description: force attach mode of the XDP program (`auto`: let the kernel choose, `xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)

enum: xdp xdpgeneric xdpoffload

description: allowed attach modes of the XDP program (`xdp`: run inside driver, `xdpgeneric`: driver-independent before SKB allocation, `xdpoffload`: offload to SmartNIC co-processor)


description: select the source prefix to match

default: unspec

description: routing protocol number (`/etc/iproute2/rt_protos`)

description: select the outgoing device to match

description: the priority of this rule

description: select the destination prefix to match

description: select the incoming device to match

enum: to_tbl blackhole unreachable prohibit

description: the type of this rule

description: select the ip protocol to match

description: select the *fwmark* value to match

description: filter rules by options

key: ignore-rules


description: configures [per interface sysctl settings](https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt)

description: settings in `/proc/sys/net/ipv4/*/conf/`

description: settings in `/proc/sys/net/ipv6/*/conf/`

key: iface-sysctl


enum: up down

description: set device state


description: protocol selector

type: string integer


description: symbolic name for easy reference


description: remote IPv4 address of the tunnel


description: specifies a parent device name or index


description: priority


description: regex to match interface name

examples: ^br-[\da-f]{12} ^docker\d+ ^lo$ ^ppp\d+$ ^veth ^virbr\d+ ^vrrp\d*\.\d+$

description: interface names matching this list of regex will be ignored

key: ignore-ifname


description: the transmit queue length of the device


description: qdisc id


type: object string array null

description: Used to define the short-hand names that are used throughout a JSON-LD document.

key: context


type: object

description: Enable warming up of JetBrains backend in prebuilds.

enum: stable latest both

description: Whether only stable, latest or both versions should be warmed up. Default is stable only.

description: Configure JVM options, for instance '-Xmx=4096m'.

description: List of plugins which should be installed for users of this workspace. From the JetBrains Marketplace page, find a page of the required plugin, select 'Versions' tab, click any version to copy pluginId (short name such as org.rust.lang) of the plugin you want to install.

key: jetbrainsProduct


enum: all insert delete select update truncate references trigger usage execute create

type: boolean

key: onePriv


description: This object represents a file format

type: string

description: Name of block file

description: Path to file template

key: fileFormat


description: The executable to run. Can be a plain basename, an absolute path or a relative path on Windows.

key: executable


title: Skip the test if true

title: Reason for skipping the test

key: skip


key: foldStackFrameOptions


description: Indicates that tests should never time out.

title: No timeout

description: Exact timeout duration for a test.

title: Exact timeout

description: Timeout is applied as a multiple of the default value (30 seconds)

title: Multiplicative timeout

key: timeout


description: Json schema version for the vtesttree.yaml file. Acceptance criteria: equal major version, less/equal minor and patch version.

title: Version


title: Numeric Value

title: String Value

description: Parameter value for a CAPL test case or CAPL test sequence.

title: CAPL parameter


title: DynamoDB table

key: table


description: A regular expression for identifying paths to resources.

description: Relative path to resource.

description: Determines if data is allowed at this path.

enum: navigation image stylesheet script xhr other

key: rule


description: Whether this command should work while Chrome does not have focus. Keyboard shortcut suggestions for global commands are limited to Ctrl+Shift+[0..9]

$comment: Global shortcuts change the acceptable pattern for the suggested_key.

key: command


default: script-src 'self'; object-src 'self'

description: This introduces some fairly strict policies that will make extensions more secure by default, and provides you with the ability to create and enforce rules governing the types of content that can be loaded and executed by your extensions and applications.

format: content-security-policy


default: sql

title: cases to test

key: cases


title: api url info

key: api


title: template for all request

key: template


key: ruleProperties


required: type enabled

description: Sets whether this cache type is enabled

default: maven

enum: maven npm local

description: Cache type

description: Location of the cache directory inside the Docker container

default: .ci-cache/<type>

description: Location of the cache in the Jenkins workspace

key: cacheItem


description: Regular expression for validating branch names

key: branchPattern


description: Release channel name

key: releaseChannel


description: Value of the ARG

description: Environment variable whose value will be used to set the ARG

description: ARG name

key: outputDockerBuildArgs


description: Dockerfile path

key: dockerfile


description: Jenkins credentials ID

key: credentials


description: Value to update the given property

description: Environment variable whose value will be used to update the property

description: Yaml property (full path) to be updated

key: outputHelmUpdatesProperties


description: Forces parallel stages to all be aborted when one of them fails

title: Fail Fast

key: failFast


description: List of steps to run

title: Steps

key: steps


type: integer

description: Timeout in seconds

key: timeout


required: url style content

description: The URL to be referenced. For resources that require authentication, the URL must be HTTPS.

description: This member specifies how to extract content from the web response.

default: Simple

pattern: ^([sS]imple|[fF]eed)$

description: Specifies the kind of web resource being accessed. Permitted values are 'Simple' and 'Feed'.

key: resource


description: The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.

key: color


description: The numeric id of the icon layout element based on the predefined layout selected.

key: elementId


required: condition title

description: The text to use for the notification body. If longer than 20 characters, it will be truncated.

description: The condition to be evaluated to determine whether to trigger the notification. The conditional expression has the syntax '<Operand1> <Operator> <Operand2>' or 'true'.

description: The text to use for the notification title. If longer than 20 characters, it will be truncated.

key: notification


description: If set, then must be set to 'true' for this release

key: condition


description:
ESLint rule

0 - turns the rule off
1 - turn the rule on as a warning (doesn't affect exit code)
2 - turn the rule on as an error (exit code is 1 when triggered)

enum: off warn error

description:
ESLint rule

"off" - turns the rule off
"warn" - turn the rule on as a warning (doesn't affect exit code)
"error" - turn the rule on as an error (exit code is 1 when triggered)

key: rule


description: Path to the file to expose as a secret

key: fileSecret


description: Paths to keys or SSH agent sockets to expose to image build process

description: ID used to refer to agent from Dockerfile

key: buildSSHAgentList


description: The number of times to perform the health check before considering the container unhealthy

description: The interval between runs of the health check. Accepts values such as `2s` (two seconds) or `1m` (one minute).

description: The time to wait before failing health checks count against the retry count. The health check is still run during this period, and if the check succeeds, the container is immediately considered healthy. Accepts values such as `2s` (two seconds) or `1m` (one minute).

description: The command to run to check the health of the container. If this command exits with code 0, the container is considered healthy.

description: The time to wait before timing out a single health check command invocation. Accepts values such as `2s` (two seconds) or `1m` (one minute).

key: healthCheckOptions


description: Path (relative to this file) to the file to include

required: type path

description: Path (relative to this file) of the file to include

description: The type of include

required: type repo ref

description: Git repository containing the file to include

description: Git reference (commit, tag or branch) containing the file to include

description: The type of include

description: Path (relative to the root of the repository) of the file to include (defaults to batect-bundle.yml if not set)

key: include


description: Set to `true` to enable 'run as current user' mode

description: Directory to use as home directory for user inside container

key: runAsCurrentUserOptions


required: local container

description: Port inside the container to map

description: Port on the host machine to map

description: Protocol to use (eg. TCP or UDP)

description: Ports inside the container to map

description: Ports on the host machine to map

description: Protocol to use (eg. TCP or UDP)

key: portMappingList


description: Working directory to start the command in (defaults to container working directory if not set)

description: Command to execute

key: setupCommandsList


description: Path on the host machine to mount

description: Path inside the container to mount the host path at

description: Type of volume mount

enum: cached delegated consistent default ro

description: Docker volume mount options to use when creating mount

required: type name container

description: Path inside the container to mount the cache at

description: Type of volume mount

description: Name of the cache

required: type container

description: Path inside the container to mount the tmpfs filesystem at

description: Type of volume mount

description: Docker tmpfs mount options to use when creating mount

key: volumeMountList


key: environmentVariableList


description: Definition of a single config variable

description: Default value of the variable if one is not provided elsewhere

description: Human-readable description of the purpose of the variable

key: configVariable


description: Name of the environment variable to expose as a secret

key: environmentSecret