description: A link to external metadata badge.

description: Link the user navigates to when selecting the badge.

description: The absolute URL of the badge image to be displayed.

description: Description of the badge, to be displayed on hover.

title: badge

description: A content file that describes the extension to users.

description: The path to the file in the extension.

title: content

description: An individual contribution made by an extension

description: List of constraints (filters) that should be applied to the availability of this contribution

$ref: #/definitions/ContributionConstraint

description: Description of the contribution/type

description: Fully qualified identifier of the contribution/type

description: Includes is a set of contributions that should have this contribution included in their targets list.

description: Properties/attributes of this contribution

description: List of demanded claims in order for the user to see this contribution (like anonymous, public, member...).

description: The ids of the contribution(s) that this contribution targets. (parent contributions)

description: Id of the Contribution Type

description: VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too.  Examples: "ms" - Means only the "ms" publisher can reference this. "ms.vss-web" - Means only the "vss-web" extension from the "ms" publisher can reference this.

required: id targets type

title: contribution

description: Specifies a constraint that can be used to dynamically include/exclude a given contribution

description: An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).

description: Fully qualified identifier of a shared constraint

description: If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)

description: Name of the IContributionFilter plugin

description: Properties that are fed to the contribution filter class

description: Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.

description: Represents different ways of including contributions based on licensing

description: Description about a property of a contribution type

description: Description of the property

description: Name of the property

description: True if this property is required

$ref: #/definitions/ContributionPropertyType

description: The type of value used for this property

description: The type of value used for a property

description: A contribution type, given by a json schema

description: Description of the contribution/type

description: Controls whether or not contributions of this type have the type indexed for queries. This allows clients to find all extensions that have a contribution of this type.  NOTE: Only TrustedPartners are allowed to specify indexed contribution types.

description: Friendly name of the contribution/type

description: Describes the allowed properties for this contribution type

description: Base class for an event callback for an extension

description: The uri of the endpoint that is hit when an event occurs

description: Collection of event callbacks - endpoints called when particular extension events occur.

$ref: #/definitions/ExtensionEventCallback

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension disable has occurred.

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension enable has occurred.

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension install has completed.

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension uninstall has occurred.

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension update has occurred.

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension install is about to occur.  Response indicates whether to proceed or abort.

description: For multi-version extensions, defines an endpoint that gets called via an OPTIONS request to determine the particular version of the extension to be used

description: How an extension should handle including contributions based on licensing

description: A list of contributions which deviate from the default licensing behavior

$ref: #/definitions/LicensingOverride

description: Path to resource on disk, which can be relative to your root directory.

description: (optional) Set to true if you want your file to be URL-addressable. Defaults to false.

description: (optional) Path to the resource within the package. Defaults to the relative path on disk from your root directory.

description: (optional) MIME type of the file. Defaults to a best guess based on the file extension and OS settings.

description: (optional) Specify the value of the Type attribute of the asset entry in the VSIX manifest. Can also be an array of strings, in which case multiple asset entries get added for this file. Defaults to the packagePath.

description: (optional) Language of this asset. Localized files are served based on the Accept-Language header. Leave blank to signify this file is in the default (or fallback) language. Localized versions of the same file should have the same assetType.

title: file

description: Maps a contribution to a licensing behavior

description: How the inclusion of this contribution should change based on licensing

description: Fully qualified contribution id which we want to define licensing behavior for

description: The absolute URL of the link.

title: link

title: target

description: Base class for extension properties which are shared by the extension manifest and the extension model

description: Array of links to external metadata badges like TravisCI, Appveyor, and so on, from the approved badges sites.

$ref: #/definitions/Badge

description: Uri used as base for other relative uri's defined in extension

description: Dictionary of brand-related properties.

description: Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).

description: Complements the color; use dark for dark branding colors, or light for lighter branding colors.

enum: dark light

title: branding

description: Array of strings representing the categories your extension belongs to. At least one category must be provided and there's no limit to how many categories you may include. Valid values: Azure Repos, Azure Boards, Azure Pipelines, Azure Test Plans, and Azure Artifacts.

enum:
Azure Repos
Azure Boards
Azure Pipelines
Azure Test Plans
Azure Artifacts

description: List of shared constraints defined by this extension

description: Dictionary of content files that describe your extension to users.

$ref: #/definitions/Content

title: content

description: List of contribution types defined by this extension

$ref: #/definitions/ContributionType

description: List of contributions made by this extension

$ref: #/definitions/Contribution

description: List of explicit demands required by this extension

description: A few sentences describing the extensions. Limited to 200 characters.

description: Collection of endpoints that get called when particular extension events occur

description: Secondary location that can be used as base for other relative uri's defined in extension

description: The files section is where you reference any files you wish to include in your extension.

$ref: #/definitions/File

description: Dictionary of icons representing the extension.

description: 128x128 pixels

description: The extension's identifier.

description: Language Culture Name set by the Gallery

$ref: #/definitions/ExtensionLicensing

description: How this extension behaves with respect to licensing

description: Version of the extension manifest format/content. Should be 1.

description: A short, human-readable name of the extension. Limited to 200 characters.

description: Dictionary of links that help users learn more about your extension, get support, and move.

description: The identifier of the publisher. This identifier must match the identifier the extension is published under.

description: Dictionary of properties describing the source code repository for the extension.

description: Type of repository. Example: git.

description: Absolute URL of the repository.

description: Default user claims applied to all contributions (except the ones which have been specified restrictedTo explicitly) to control the visibility of a contribution.

description: List of all oauth scopes required by this extension

description: Array of images that couldn't be included in your content.

description: The ServiceInstanceType(Guid) of the VSTS service that must be available to an account in order for the extension to be installed

description: Array of string tags to help users find your extension.

description: The products and services supported by your integration or extension.

description: A string specifying the version of an extension. Should be in the format major.minor.patch.


appsemblerc.schema.json

title: .appsemblerc.yaml

description: A .appsemblerc.yaml file may be used to configure either an app or a block.

type: object

description: The name of a block. By default the name in package.json is used.

type: string

description: A short description of the block. By default the description in package.json is used.

description: A semantic version of the block representation of the block version. By default the version in package.json is used.

description: The long description of the block. Markdown is supported. By default the content of README.md is used.

description: The type of layout to be used for the block.

default: static

description: Where to read build output from.

description: The path to the webpack configuration file relative to the block project directory. By default a file named webpack.config.js is used, with a fallback to the webpack configuration from @appsemble/webpack-config.

description: An object describing the names of the events the block can listen and emit to. By default this is extracted from the block’s TypeScript module augmentations.

description: The events the block listens on.

description: The events the block may emit.

description: An object which describes the actions a block can trigger. This will be used to validate app definitions. By default this is extracted from the block’s TypeScript module augmentations.

description: A JSON schema which describes the block parameters. By default this is extracted from the block’s TypeScript module augmentations.

description: The background color to use for maskable icons.

description: A context which can be specified using the --context command line parameter.

description: If remote is specified, this will override --remote passed by the command line.

format: uri

description: If organization is specified, this will override --organization passed by the command line when creating an app.

description: A path to the app icon to use

description: A path to the maskable app icon to use

description: If id is specified, this will override --id passed by the command line when updating an app.

type: integer

description:
Determine the app visibility of the app in the Appsemble app store.

This doesn’t affect whether or not the app can be accessed on its own domain.

- **public**: The app is publicly listed in the Appsemble app store.,
- **unlisted**: The app store page can be accessed, but the app isn’t listed publicly in the Appsemble app store.
- **private**: The app is only visible to people who are part of the organization.

default: unlisted

enum: public unlisted private

description: Whether or not people who have access to the app may see the app definition.

type: boolean

description: If template is specified, this will override --template passed on the command line.

description: A custom Sentry DSN to use for the app.

description: A custom Sentry environment to use for the app.


bower.json

description: Any property starting with _ is valid.

description: The name of your package.

description: Help users identify and search for your package with a brief description.

description: A semantic version number.

description: The primary acting files necessary to use your package.

type: string array

description: SPDX license identifier or path/url to a license.

description: A list of files for Bower to ignore when installing your package.

description: Used for search by keyword. Helps make your package easier to discover without people needing to know its name.

type: array

description: A list of people that authored the contents of the package.

type: string object

description: URL to learn more about the package. Falls back to GitHub project if not specified and it's a GitHub endpoint.

description: The repository in which the source code can be found.

description: Dependencies are specified with a simple hash of package name to a semver compatible identifier or URL.

description: Dependencies that are only needed for development of the package, e.g., test framework or building documentation.

description: Dependency versions to automatically resolve with if conflicts occur between packages.

description: If you set it to  true  it will refuse to publish it. This is a way to prevent accidental publication of private repositories.

description: Used by grunt-bower-task to specify custom install locations.

description: The types of modules this package exposes

type: array string

enum: amd es6 globals node yui

title: JSON schema for Bower configuration files


importmap.json

description: The Imports field

description: The Scopes field

title: JSON schema for Import Maps files


function.json

enum: in out inout

enum: string binary stream

description: The data type hint for the binding parameter (string, binary, or stream).

required: name type direction

enum: serviceBusTrigger serviceBus blobTrigger blob manualTrigger eventHubTrigger eventHub timerTrigger queueTrigger queue httpTrigger http mobileTable documentDB table notificationHub twilioSms sendGrid sql sqlTrigger kusto

description: The service bus queue to monitor (if using a queue)

description: The service bus topic to monitor (if using a queue)

description: The topic subscription name

description: An app setting (or environment variable) with the service bus connection string to be used by this binding.

description: The permission level of the service bus connection string used by this binding.

enum: manage listen send

description: The path to the blob container

description: An app setting (or environment variable) with the storage connection string to be used by this binding.

description: The event hub path.

description: The event hub connection string setting.

description: The event hub consumer group.

enum: one many

description: The cardinality hint for the input binding parameter (single message or array of messages).

description: A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule.

description: When true, your timer function will be invoked immediately after a runtime restart and on-schedule thereafter.

description: When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute.

description: The queue name.

description: The function HTTP route template.

description: The type of WebHook handled by the trigger (if handling a pre-defined WebHook).

default: function

enum: anonymous function admin

description: The function HTTP authorization level.

enum: get post delete head patch put options trace

description: This is the name of the table within your Mobile App to which data will be written.

description: This is the app setting name that specifies the URL of your Mobile App.

description: This is app setting name that specifies the API Key for your Mobile App.

description: This is the id for the record to retrieve.

description: This is the connection string for your DocumentDB account.

description: This is the name of the database within your DocumentDB account to which data will be written.

description: This is the name of the collection within your database to which data will be written.

description: This is the query to run against the collection.

description: When true, your database and collection will be created automatically.

description: The name of the storage table.

description: The partition key.

description: The table row key.

description: The number or records to retrieve.

description: A filter expression to be applied when retrieving rows.

description: The tag to send the notification to.

description: The name of the notification hub.

description: The name of the app setting which contains the notification hub connection string.

description: The notification platform to target. Sends template notification if platform is omitted.

enum: apns adm gcm wns mpns

description: The name of the app setting which contains your Twilio Account Sid.

description: The name of the app setting which contains your Twilio authentication token.

description: The phone number the SMS text is sent to.

description: The phone number the SMS text is sent from.

description: Optional body of SMS text message.

description: The name of the app setting which contains your SendGrid api key.

description: The email address to send to.

description: The email address to send from.

description: The subject of the email.

description: The text of the email.

description: The name of the app setting that contains the SQL connection string used to connect to the database.

description: The name of the table to be monitored for changes.

description: Either a query string or the name of a stored procedure to execute.

enum: text storedProcedure

description: Whether the commandText is a query (text) or a stored procedure (storedProcedure).

description: The parameters to the query or stored procedure.

const: sql

const: out

description: The name of the table into which rows will be upserted.

description: Name of the app setting that contains the kusto connection string used to connect to kusto.

description: Name of the database within your kusto account to which data will be read/written.

description: A managed service identity that has to be attached to use the bindings.

description: The Kusto command to execute.Can be a KQL query or a KQL function with optional parameters.

description: The parameters to the query or function. Named parameters are of the form @paramName=paramValue.

description: The table to ingest the data into.

description: An ingestion mapping ref that points to the mapping created in kusto and referenced in ingestion (optional).

description: Dataformat to use in ingestion.The default dataformat is `multijson/json`. This has been tested for text formats

description: If set to true, marks the function as disabled (it cannot be triggered).

description: If set to true, the function will not be loaded, compiled, or triggered.

description: Optional path to function script file.

description: Optional named entry point.

enum: attributes config

description: For C# precompiled functions only. If set to 'attributes', use WebJobs attributes to specify bindings. Otherwise, use the 'bindings' property of this function.json.

description: Retry policy of function execution failures.

description: Retry strategy to use for retrying function executions

enum: exponentialBackoff fixedDelay

default: exponentialBackoff

description: The maximum number of retries allowed per function execution. -1 means to retry indefinitely.

description: Value indicating the delayInterval for function execution retries when using FixedDelay strategy.

description: Value indicating the minimumInterval for function execution retries when using ExponentialBackoff strategy.

description: Value indicating the maximumInterval for function execution retries when using ExponentialBackoff strategy.

description: A list of function bindings.

$ref: #/definitions/dynamicBinding

$ref: #/definitions/serviceBusBinding

$ref: #/definitions/blobBinding

$ref: #/definitions/manualTriggerBinding

$ref: #/definitions/eventHubBinding

$ref: #/definitions/timerTriggerBinding

$ref: #/definitions/queueBinding

$ref: #/definitions/httpBinding

$ref: #/definitions/mobileBinding

title: JSON schema for Azure Functions function.json files


cluster.json

$ref: #/definitions/Key

$ref: #/definitions/GlobalAwsOpts

$ref: #/definitions/ServiceOverride

type: number

required: TypeMeta plugins

$ref: #/definitions/TypeMeta

required: name path configuration

$ref: #/definitions/Unknown

$ref: #/definitions/AuditLogConfig

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

description: CacheTimeout controls how long to cache authentication decisions

description: Authentication strategy that will be used in kubernetes cluster

description: List of additional hostnames and IPs to include in the api server PKI cert

description: Webhook configuration options

description: Authorization mode used by kubernetes

description: Authorization mode options

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 cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13

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

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

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

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

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

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

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

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

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

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 type of azure nodes. Candidate valudes are: vmss and standard.
If not set, it will be default to standard.

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 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:
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 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:
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: Backoff retry limit

description: Backoff exponent

description: Backoff duration

description: Backoff jitter

description: Enable rate limiting

description: Rate limit QPS

description: Rate limit Bucket Size

description: Use instance metadata service where possible

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:
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: Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148

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

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: Address of Bastion Host

description: SSH Port of Bastion Host

description: ssh User to Bastion Host

description: SSH Agent Auth enable

description: SSH Private Key

description: SSH Private Key Path

description: SSH Certificate

description: SSH Certificate Path

description: Ignore proxy environment variables

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

description: See Issue #33128

description: Cloud provider type used with calico

description: Name of the Cloud Provider

description: AWSCloudProvider

description: AzureCloudProvider

description: OpenstackCloudProvider

description: VsphereCloudProvider

description: CustomCloudProvider is a multiline string that represent a custom cloud config file

description: DNS provider

description: DNS config options

description: Upstream nameservers

description: ReverseCIDRs

description: Stubdomains

description: NodeSelector key pair

description: Nodelocal DNS

description: Update strategy

description: Autoscaler fields to determine number of dns replicas

description: Tolerations for Deployments

description: List of etcd urls

description: External CA certificate

description: External Client certificate

description: External Client key

description: External etcd prefix

description: UID to run etcd container as

description: GID to run etcd container as

description: Etcd Recurring snapshot Service, used by rke only

description: Etcd snapshot Retention period

description: Etcd snapshot Creation period

description: Backup backend for etcd snapshots

description: Alternate cloud interface for flannel

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:
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:
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: SubnetID enables using a specific subnet to use for ELB's

description: RouteTableID enables using a specific RouteTable

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

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

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

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:
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.

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.

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

description: Ingress controller type used by kubernetes

description:
These options are NOT for configuring Ingress's addon template.
They are used for its ConfigMap options specifically.

description: NodeSelector key pair

description: Ingress controller extra arguments

description: DNS Policy

description: Extra Env vars

description: Extra volumes

description: Extra volume mounts

description: nginx daemonset upgrade strategy

description: Http port for ingress controller daemonset

description: Https port for ingress controller daemonset

description: NetworkMode selector for ingress controller pods. Default is HostNetwork

description: Tolerations for Deployments

description: Enable or disable nginx default-http-backend

description: Priority class name for Nginx-Ingress's "default-http-backend" deployment

description: Priority class name for Nginx-Ingress's "nginx-ingress-controller" daemonset

description: Virtual IP range that will be used by Kubernetes services

description: Port range for services defined with NodePort type

description: Enabled/Disable PodSecurityPolicy

description: Enable/Disable AlwaysPullImages admissions plugin

description: Secrets encryption provider config

description: Audit Log Configuration

description: AdmissionConfiguration

description: Event Rate Limit configuration

description: CIDR Range for Pods in cluster

description: Domain of the cluster (default: "cluster.local")

description: The image whose network/ipc namespaces containers in each pod will use

description: Cluster DNS service ip

description: Fail if swap is enabled

description: Generate per node kubelet serving certificates created using kube-ca

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. Only support v2.

description: uses Octavia V2 service catalog endpoint

description: overrides autodetection.

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

description: default to ROUND_ROBIN.

description: Monitoring server provider

description:
These options are NOT for configuring the Metrics-Server's addon template.
They are used to pass command args to the metric-server's deployment containers specifically.

description: NodeSelector key pair

description: Update strategy

description: Number of monitoring addon pods

description: Tolerations for Deployments

description: Priority class name for Metrics-Server's "metrics-server" deployment

description: Network Plugin That will be used in kubernetes cluster

description: Plugin options to configure network properties

description: Set MTU for CNI provider

description: CalicoNetworkProvider

description: CanalNetworkProvider

description: FlannelNetworkProvider

description: WeaveNetworkProvider

description: AciNetworkProvider

description: NodeSelector key pair

description: Network plugin daemonset upgrade strategy

description: Tolerations for Deployments

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: Continue even if there are pods using emptyDir

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: Time to wait (in seconds) before giving up for one try

description: MaxUnavailableWorker input can be a number of nodes or a percentage of nodes (example, max_unavailable_worker: 2 OR max_unavailable_worker: 20%)

description: MaxUnavailableControlplane input can be a number of nodes or a percentage of nodes

description: link-local IP for nodelocal DNS

description: Nodelocal DNS daemonset upgrade strategy

description: NodeSelector key pair

description: Priority class name for NodeLocal's "node-local-dns" daemonset

required: global loadBalancer blockStorage route metadata

description: URL for the registry

description: User name for registry acces

description: Password for registry access

description: Default registry

description: ECRCredentialPlugin

description: Name of the host provisioned via docker machine

description: IP or FQDN that is fully resolvable and used for SSH communication

description: Port used for SSH communication

description: Optional - Internal address that will be used for components communication

description: Node role in kubernetes cluster (controlplane, worker, or etcd)

description: Optional - Hostname of the node

description: SSH usesr that will be used by RKE

description: Optional - Docker socket on the node that will be used in tunneling

description: SSH Agent Auth enable

description: SSH Private Key

description: SSH Private Key Path

description: SSH Certificate

description: SSH Certificate Path

description: Node Labels

description: Node Taints

description: Etcd Service

description: KubeAPI Service

description: KubeController Service

description: Scheduler Service

description: Kubelet Service

description: KubeProxy Service

description: etcd image

description: Alpine image

description: rke-nginx-proxy image

description: rke-cert-deployer image

description: rke-service-sidekick image

description: KubeDNS image

description: DNSMasq image

description: KubeDNS side car image

description: KubeDNS autoscaler image

description: CoreDNS image

description: CoreDNS autoscaler image

description: Nodelocal image

description: Kubernetes image

description: Flannel image

description: Flannel CNI image

description: Calico Node image

description: Calico CNI image

description: Calico Controllers image

description: Calicoctl image

description: CalicoFlexVol image

description: Canal Node Image

description: Canal CNI image

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

description: CanalFlannel image

description: CanalFlexVol image

description: Weave Node image

description: Weave CNI image

description: Pod infra container image

description: Ingress Controller image

description: Ingress Controller Backend image

description: Ingress Webhook image

description: Metrics Server image

description: Pod infra container image for Windows

description: Cni deployer container image for Cisco ACI

description: host container image for Cisco ACI

description: opflex agent container image for Cisco ACI

description: mcast daemon container image for Cisco ACI

description: OpenvSwitch container image for Cisco ACI

description: Controller container image for Cisco ACI

description: GBP Server container image for Cisco ACI

description: Opflex Server container image for Cisco ACI

description: Kubernetes nodes

description: Kubernetes components

description: Network configuration used in the kubernetes cluster (flannel, calico)

description: Authentication configuration used in the cluster (default: x509)

description: YAML manifest for user provided addons to be deployed on the cluster

description: List of urls or paths for addons

description: List of images used internally for proxy, cert download and kubedns

description: SSH Private Key Path

description: SSH Certificate Path

description: SSH Agent Auth enable

description: Authorization mode configuration used in the cluster

description: Enable/disable strict docker version checking

description: Enable/disable using cri-dockerd

description: Kubernetes version to use (if kubernetes image is specified, image version takes precedence)

description: List of private registries and their credentials

description: Ingress controller used in the cluster

description: Cluster Name used in the kube config

description: Cloud Provider options

description: kubernetes directory path

description: kubernetes directory path for windows

description: Timeout in seconds for status check on addon deployment jobs

description: Bastion/Jump Host configuration

description: Monitoring Config

description: RestoreCluster flag

description: Rotating Certificates Option

description: Rotate Encryption Key Option

description: DNS Config

description: Upgrade Strategy for the cluster

description: Rotate CA Certificates

description: Services to rotate their certs

description: required

description: Enable/disable secrets encryption provider config

description: Custom Encryption Provider configuration object

required: service region url signing-region signing-method signing-name

required: TypeMeta Raw ContentEncoding ContentType


shopware-project-schema.json

title: shopware-cli

description: shopware cli project configuration definition file

$ref: #/definitions/Config

title: .shopware-project.yml

description: URL to Shopware instance

$ref: #/definitions/AdminApi

$ref: #/definitions/Dump

$ref: #/definitions/Sync

$ref: #/definitions/Build

title: Project Build Settings

description: When enabled, the assets will not be copied to the public folder

description: When enabled, the assets of extensions will be removed from the extension public folder. (Requires Shopware 6.5.2.0)

description: Paths to delete for the final build

title: Admin API credentials

description: Client ID of integration

description: Client Secret of integration

description: Username of admin user

description: Password of admin user

description: Disable SSL check for API requests

title: MySQL dump configuration

title: Sync Settings

$ref: #/definitions/SyncConfigItem

$ref: #/definitions/ThemeConfigItem

$ref: #/definitions/MailTemplateItem

$ref: #/definitions/EntitySyncItem

title: System Config Sync

title: Sales Channel to apply

title: Theme Config Sync

title: Mail Template Sync

title: Mail Template Single Translation

title: Entity Sync

$ref: #/definitions/EntitySyncFilter

description: API payload

required: entity payload

title: Entity Sync Filter

enum: equals multi contains prefix suffix not range until equalsAll equalsAny

description: filter type

description: field

type: string integer array boolean null

description: value

enum: AND OR XOR

$ref: #/definitions/EntitySyncFilterInner

required: type field

const: multi

required: type queries

title: Entity Sync Filter

description: filter type

description: field

description: value


version.schema.json

title: All Versions of the ORY Hydra Configuration


jsbeautifyrc-nested.json

title: JSON schema for beautifyrc


openrewrite.json

title: OpenRewrite Resource

description: Contains OpenRewrite resource descriptors like recipes and styles

description: Identifies the resource type

$ref: #/$defs/tags

format: duration

$ref: #/$defs/recipeList

$ref: #/$defs/style

$ref: #/$defs/recipe


configuration.json

title: DstackConfiguration

propertyName: type

task: #/definitions/TaskConfiguration

service: #/definitions/ServiceConfiguration

$ref: #/definitions/TaskConfiguration

$ref: #/definitions/ServiceConfiguration

title: RegistryAuth

title: Username

description: Username

title: Password

description: Password or access token

title: PythonVersion

description: An enumeration.

title: PortMapping

title: Local Port

title: Container Port

title: DevEnvironmentConfiguration

title: Type

default: dev-environment

title: Image

description: The name of the Docker image to run

title: Entrypoint

description: The Docker entrypoint

title: Home Dir

description: The absolute path to the home directory inside the container

default: /root

title: Registry Auth

description: Credentials for pulling a private container

$ref: #/definitions/RegistryAuth

description:
The major version of Python
Mutually exclusive with the image

$ref: #/definitions/PythonVersion

title: Env

description: The mapping or the list of environment variables

title: Build

description: The bash commands to run during build stage

title: Setup

description: The bash commands to run on the boot

title: Cache

description: The directories to be cached between configuration runs

title: Ports

description: Port numbers/mapping to expose

$ref: #/definitions/PortMapping

title: Ide

description: The IDE to run

title: Init

description: The bash commands to run

title: Artifact

title: Path

description: The path to the folder that must be stored as an output artifact

title: Mount

description: Must be set to `true` if the artifact files must be saved in real-time

title: TaskConfiguration

title: Type

default: task

title: Image

description: The name of the Docker image to run

title: Entrypoint

description: The Docker entrypoint

title: Home Dir

title: Registry Auth

title: Env

title: Build

title: Setup

description: The bash commands to run on the boot

title: Cache

title: Ports

description: Port numbers/mapping to expose

title: Commands

description: The bash commands to run

title: Artifacts

description: The list of output artifacts

$ref: #/definitions/Artifact

title: ServiceConfiguration

title: Type

default: service

title: Image

description: The name of the Docker image to run

title: Entrypoint

description: The Docker entrypoint

title: Home Dir

title: Registry Auth

title: Env

title: Build

title: Setup

description: The bash commands to run on the boot

title: Cache

title: Commands

description: The bash commands to run

title: Port

description: The port, that application listens to or the mapping

title: Gateway

description: The gateway IP address or domain to publish the service

required: commands port gateway


gherking.schema.json

title: GherKing configuration

description: The explicit schema set. It is optional, as GherKing is supported by schemastore.org, thus most IDE.

description: The source folder or glob pattern of the input feature files.

description: The base folder of the input feature files.

description: The destination folder to put the output feature files.

description: Whether the destination directory should be clean in advance.

description: Whether some information should be displayed on the screen.

description: Whether the missing precompilers (gpc-* packages) should be installed and save to the package.json. Packages will be installed in the current folder, and package.json created if it is not there yet.

description: The precompilers to use and their configuration.

$ref: #/definitions/gpcCustom

$ref: #/definitions/gpcFilter

$ref: #/definitions/gpcForLoop

$ref: #/definitions/gpcLicense

$ref: #/definitions/gpcMacro

$ref: #/definitions/gpcRemoveComments

$ref: #/definitions/gpcRemoveDuplicates

$ref: #/definitions/gpcReplacer

$ref: #/definitions/gpcScenarioNumbering

$ref: #/definitions/gpcStepGroups

$ref: #/definitions/gpcTestData

$ref: #/definitions/formatOptions

title: custom precompiler

description: A custom precompiler configuration, implemented either as an object or a PreCompiler class.

description: Either the NPM package name to use, or the path to a JS file containing a PreCompiler.

description: The configuration object, if necessary, to be passed to the custom precompiler class.

title: gpc-replacer

description: This GherKing Precompiler is responsible to replace keys in feature files with given values.

const: gpc-replacer

description: The key-value pairs to replace in the feature files.

type: string integer boolean number

required: path configuration

title: gpc-filter

description: The Filter precompiler is responsible for including or excluding the elements of a feature file in the result, which match a cucumber-tag-expression (e.g., has a given tag, does not have a given tag).

const: gpc-filter

description: Cucumber-tag-expression the filtering is based on

default: not @wip

$comment: The pattern must contain at least one cucumber tag.

title: gpc-for-loop

description: A precompiler of GherKing to loop scenarios and scenario outlines to repeat them.

const: gpc-for-loop

description: Maximum value of iteration.

description: Tag used to mark scenarios or outlines to be repeated.

default: loop

description: Format of the scenario or outline name after repeating. These tokens must be used: ${name}, ${i}.

description: Whether higher iteration values than the max should be limited to the max or error should be thrown (false).

title: gpc-macro

description: This precompiler is responsible for defining macros in feature files and then executing them.

const: gpc-macro

title: gpc-remove-comments

description: This precompiler removes all or particular type of semantic comments from the feature file.

const: gpc-remove-comments

description: To set which comment types should be kept, not removed.

enum: NONE BEFORE_TAGS PRECEDING DESCRIPTION TAG ROW DOC_STRING STEP START END ALL

title: gpc-remove-duplicates

description: The RemoveDuplicates precompiler is responsible for having only a reasonable amount of tags and/or rows in each feature file.

const: gpc-remove-duplicates

description: Should tags on the same level and from parent be de-duplicated.

description: Should table rows be de-duplicated.

title: gpc-scenario-numbering

description: The ScenarioNumbering precompiler is responsible for adding an index to all scenarios and scenario outlines.

const: gpc-scenario-numbering

description: The format, how index should be added to the name of the scenario/scenairo outline. Possible tokens: ${name} the original name, ${i} the index

title: gpc-scenario-outline-expander

description: This precompiler is responsible for converting Scenario Outlines to single Scenarios as Cucumber would do and adds the first column as a tag.

const: gpc-scenario-outline-expander

description: Tag used to mark scenarios to be ignored during expanding Scenario Outlines.

title: gpc-scenario-outline-numbering

description: This precompiler can add numbering column to Examples tables, and apply formatting to the name of the Scenario Outline.

const: gpc-scenario-outline-numbering

description: Should the example parameters be added to the name of the Scenario Outline.

description: The delimiter to use when adding the parameters to the name of the Scenario Outline.

description: The format how the output Scenario Outline name should look with the parameters. Tokens to use: ${name}, ${parameters}

default: ${name} - ${parameters}

description: Should an index be added to the name of the Scenario Outline.

description: The format how the output Scenario Outline name should look with the index. Tokens to use: ${name}, ${i}

description: Should the existing numbering field (num) block execution (true) or be used for numbering (false).

title: gpc-step-groups

description: The StepGroups precompiler is responsible for correcting the gherkin keywords of steps to make the tests more readable.

const: gpc-step-groups

title: gpc-test-data

description: This precompiler can load external data (JSON, CSV, or XLS/XLSX) into exmaples table.

const: gpc-test-data

description: Whether the load-tags should be kept or removed.

type: string number

description: The default value to be added to the table if a column/value is not found.

description: Whether the loaded data should be appended to the existing rows of the examples table or overwritten.

description: Whether the casing of the example columns and data columns should be ignored.

title: gpc-license

description: This precompiler can be used to inject License statement into the feature files.

const: gpc-license

description: The file's path where the license is stored.

description: The exact license text. It can contain the ${LICENSE} token to set the content of the license file.

description: The place to inject the license text, either in start or end comment.

enum: start end

$comment: Either licenseFile or licenseText must be set!

description: Options to pass to gherkin-formatter, on how to format the output feature files.

description: Should the tags be rendered separately, one by line?

description: Should step groups (when-then) be separated?

description: Should empty lines be skipped, removed from the result?

description: The line break character(s).

description: The indentation character(s).


prettierrc.json

description: Include parentheses around a sole arrow function parameter.

default: always

description: Always include parens. Example: `(x) => x`

description: Omit parens when possible. Example: `x => x`

description: Put > of opening tags on the last line instead of on a new line.

description: Print spaces between brackets.

description:
Print (to stderr) where a cursor at the given position would move to after formatting.
This option cannot be used with --range-start and --range-end.

description: Whether parse the .editorconfig file in your project and convert its properties to the corresponding Prettier configuration. This configuration will be overridden by .prettierrc, etc.

description: Control how Prettier formats quoted code embedded in the file.

default: auto

description: Format embedded code if Prettier can automatically identify it.

description: Never automatically format embedded code.

description: Which end of line characters to apply.

default: lf

description: Line Feed only (\n), common on Linux and macOS as well as inside git repos

description: Carriage Return + Line Feed characters (\r\n), common on Windows

description: Carriage Return character only (\r), used very rarely

description:
Maintain existing
(mixed values within one file are normalised by looking at what's used after the first line)

description: Specify the input filepath. This will be used to do parser inference.

description: How to handle whitespaces in HTML.

default: css

description: Respect the default value of CSS display property.

description: Whitespaces are considered sensitive.

description: Whitespaces are considered insensitive.

description: Insert @format pragma into file's first docblock comment.

description: Use single quotes in JSX.

description: Which parser to use.

description: Flow

description: JavaScript

description: Flow

description: TypeScript

description: TypeScript

description: JavaScript

description: JavaScript

description: JavaScript

description: CSS

description: Less

description: SCSS

description: JSON

description: JSON.stringify

description: GraphQL

description: Markdown

description: MDX

description: Vue

description: YAML

description: Ember / Handlebars

description: HTML

description: Angular

description: Lightning Web Components

description: Custom parser

description:
Custom directory that contains prettier plugins in node_modules subdirectory.
Overrides default behavior when plugins are searched relatively to the location of Prettier.
Multiple values are accepted.

description: Disable plugin autoloading.

description: Add a plugin. Multiple plugins can be passed as separate `--plugin`s.

description: The line length where Prettier will try wrap.

description: How to wrap prose.

default: preserve

description: Wrap prose if it exceeds the print width.

description: Do not wrap prose.

description: Wrap prose as-is.

description: Change when properties in objects are quoted.

default: as-needed

description: Only add quotes around object properties where required.

description: If at least one property in an object requires quotes, quote all properties.

description: Respect the input use of quotes in object properties.

description:
Format code ending at a given character offset (exclusive).
The range will extend forwards to the end of the selected statement.
This option cannot be used with --cursor-offset.

description:
Format code starting at a given character offset.
The range will extend backwards to the start of the first line containing the selected statement.
This option cannot be used with --cursor-offset.

description:
Require either '@prettier' or '@format' to be present in the file's first docblock comment
in order for it to be formatted.

description: Print semicolons.

description: Enforce single attribute per line in HTML, Vue and JSX.

description: Use single quotes instead of double quotes.

description: Number of spaces per indentation level.

description: Print trailing commas wherever possible when multi-line.

description: Trailing commas where valid in ES5 (objects, arrays, etc.)

description: No trailing commas.

description: Trailing commas wherever possible (including function arguments).

description: Indent with tabs instead of spaces.

description: Indent script and style tags in Vue files.

description: Provide a list of patterns to override prettier configuration.

description: Include these files in this override.

description: Exclude these files from this override.

description: The options to apply for this override.

$ref: #/definitions/optionsDefinition

$ref: #/definitions/overridesDefinition

title: Schema for .prettierrc


lotus.yaml.json

$ref: #/$defs/LotusManifest

$ref: #/$defs/AutoscalingMetrics

required: name query average_value

required: name type application

$ref: #/$defs/Probe

description:
Periodic probe of container liveness.
Container will be restarted if the probe fails.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

description:
Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

description: Unique name for the component. It must be DNS-friendly

enum: http worker predeploy grpc-sso-proxy cron

description: The type of component.

description:
The service name is only useful for grpc-sso-proxy components. If present,
a health service will be spun up for the service name, and it can be
possible to perform auto updates of binaries.

description: Command describes how to run the workload

$ref: #/$defs/RollingUpdateDeployment

$ref: #/$defs/SSOProxy

description: SSO Proxy settings for http components (grpc-sso-proxy has it enabled by default)

$ref: #/$defs/Autoscaling

description: Autoscaling settings for components of type http, grpc-sso-proxy or worker

required: name type command

$ref: #/$defs/ClientOf

description: datastores that connect to otherones need to pass in the reference claim here

required: name type

required: port service

$ref: #/$defs/IntOrString

$ref: #/$defs/HTTPHeader

required: name value

required: Type IntVal StrVal

title: application name

description: The application name should match the repository's

$ref: #/$defs/Component

description: Workloads to run

description: Tokens minted to securely interact with other applications

description: Named egress rules

$ref: #/$defs/Datastore

description: List of datastores to provision

required: name components

$ref: #/$defs/ExecAction

$ref: #/$defs/HTTPGetAction

$ref: #/$defs/TCPSocketAction

$ref: #/$defs/GRPCAction

description: pass OIDC IDToken to upstream via Authorization Bearer header

description: skip requests that have verified JWT bearer tokens

description: bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods