schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
strmprivacy.api.entities.v1.Stream.json
|
event_rate
|
filled in from customer profile
|
{"oneOf": [{"oneOf": [{"type": "string"}, {"type": "integer"}]}, {"type": "null"}], "default": 0}
|
strmprivacy.api.entities.v1.Stream.json
|
field_patterns
|
map of event-contract-ref vs field patterns
constraints:
data-contract-refs should be existing data contracts
field_patterns should be valid values (checked by events-core)
the field_patterns list should have no duplicates.
|
{"oneOf": [{"type": "object", "additionalProperties": {"oneOf": [{}, {"type": "null"}], "default": {}}}, {"type": "null"}], "default": {}}
|
strmprivacy.api.entities.v1.Stream.json
|
hash_type
|
Default Murmurhash3 if empty
|
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
|
strmprivacy.api.entities.v1.Stream.json
|
seed
|
hashing seed
|
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
|
strmprivacy.api.entities.v1.Stream.json
|
strmprivacy.api.entities.v1.Stream
|
Streams are source or derived streams depending on whether or not linked_stream is null.
Key streams are a separate entity in the api.
|
{"type": "object", "properties": {"enabled": {}, "maskedFields": {}, "kafkaTopic": {}, "limits": {}, "ref": {}, "tags": {}, "consentLevelType": {}, "linkedStream": {}, "policyId": {}, "credentials": {}, "consentLevels": {}}, "patternProperties": {"^consent_level_type$": {}, "^consent_levels$": {}, "^kafka_topic$": {}, "^linked_stream$": {}, "^masked_fields$": {}, "^policy_id$": {}}, "additionalProperties": {}, "definitions": {"enabled": {"oneOf": [{"type": "boolean"}, {"type": "null"}], "default": false}, "consent_levels": {"oneOf": [{"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "integer"}]}}, {"type": "null"}], "default": null}, "limits": {"oneOf": [{}, {"type": "null"}], "default": {}}, "ref": {"oneOf": [{}, {"type": "null"}], "default": {}}, "tags": {"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "null"}], "default": null}, "consent_level_type": {"oneOf": [{}, {"type": "null"}], "default": "CONSENT_LEVEL_TYPE_UNSPECIFIED"}, "linked_stream": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "policy_id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "credentials": {"oneOf": [{"type": "array", "items": {"default": {}}}, {"type": "null"}], "default": [{}]}, "kafka_topic": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": "", "deprecationMessage": "Field \"kafka_topic\" is marked as deprecated"}, "masked_fields": {"oneOf": [{}, {"type": "null"}], "default": {}}}}
|
strmprivacy.api.entities.v1.Stream.json
|
enabled
|
whether or not this stream is enabled.
|
{"oneOf": [{"type": "boolean"}, {"type": "null"}], "default": false}
|
strmprivacy.api.entities.v1.Stream.json
|
consent_levels
|
consent levels for derived streams
constraints:
if consent_level_type == CUMULATIVE then
size = 1
endif
|
{"oneOf": [{"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "integer"}]}}, {"type": "null"}], "default": null}
|
strmprivacy.api.entities.v1.Stream.json
|
description
|
Stream description
|
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
|
strmprivacy.api.entities.v1.Stream.json
|
limits
|
stream limits
|
{"oneOf": [{}, {"type": "null"}], "default": {}}
|
strmprivacy.api.entities.v1.Stream.json
|
tags
|
tags are meant for customers to tag their streams
|
{"oneOf": [{"type": "array", "items": {"type": "string"}}, {"type": "null"}], "default": null}
|
strmprivacy.api.entities.v1.Stream.json
|
consent_level_type
|
how event consent-levels are interpreted by decrypters.
|
{"oneOf": [{}, {"type": "null"}], "default": "CONSENT_LEVEL_TYPE_UNSPECIFIED"}
|
strmprivacy.api.entities.v1.Stream.json
|
linked_stream
|
null for source streams
|
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
|
strmprivacy.api.entities.v1.Stream.json
|
policy_id
|
The id of the policy that should be applied to this stream's data
|
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
|
strmprivacy.api.entities.v1.Stream.json
|
kafka_topic
|
Kafka topic of the stream. Deprecated in favor of topic in message ExtendedStream
|
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": "", "deprecationMessage": "Field \"kafka_topic\" is marked as deprecated"}
|
strmprivacy.api.entities.v1.Stream.json
|
masked_fields
|
field masking is defined per OUTPUT stream and event-contract ref. combination
The default empty map means no masking. Otherwise, the algorithm in the decrypter is as follows.
A source stream is (partially) decrypted, and events that don't have enough permissions are dropped.
the event contract ref string is used to find a MaskedFields instance.
if present, for all field patterns in the MaskedFields instance, the hash with the specified seed is applied.
|
{"oneOf": [{}, {"type": "null"}], "default": {}}
|
strmprivacy.api.entities.v1.Stream.json
|
strmprivacy.api.entities.v1.StreamRef
|
refers to a event stream.
|
{"type": "object", "properties": {"billingId": {}, "name": {}, "projectId": {}}, "patternProperties": {"^billing_id$": {}, "^project_id$": {}}, "additionalProperties": {}, "definitions": {"billing_id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": "", "deprecationMessage": "Field \"billing_id\" is marked as deprecated"}, "name": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}, "project_id": {"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}}}
|
strmprivacy.api.entities.v1.Stream.json
|
name
|
the name of the stream
constraints: generic name
|
{"oneOf": [{"type": "string"}, {"type": "null"}], "default": ""}
|
minecraft-configured-carver.json
|
A carver for a data pack for Minecraft
https://minecraft.fandom.com/wiki/Custom_world_generation#Carvers
|
{"$schema": "http://json-schema.org/draft-07/schema#", "properties": {"type": {"type": "string", "enum": ["minecraft:cave", "cave", "minecraft:nether_cave", "nether_cave", "minecraft:canyon", "canyon", "minecraft:underwater_canyon", "underwater_canyon", "minecraft:underwater_cave", "underwater_cave"]}, "config": {"type": "object", "properties": {"probability": {"type": "number", "minimum": 0, "maximum": 1}, "y": {"type": "object"}, "lava_level": {"type": "string", "enum": ["absolute", "above_bottom", "below_top"]}, "replaceable": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}]}, "debug_settings": {"type": "object", "properties": {"debug_mode": {"type": "boolean", "default": false}, "air_state": {"type": "object", "additionalProperties": true}, "water_state": {"type": "object", "additionalProperties": true}, "lava_state": {"type": "object", "additionalProperties": true}, "barrier_state": {"type": "object", "additionalProperties": true}}, "additionalProperties": false}, "yScale": {"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}, "horizontal_radius_multiplier": {"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}, "vertical_radius_multiplier": {"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}, "floor_level": {"oneOf": [{"type": "number", "minimum": -1, "maximum": 1}, {"type": "object", "additionalProperties": true}]}, "vertical_rotation": {"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}, "shape": {"type": "object", "additionalProperties": true}}, "additionalProperties": false}}, "type": "object"}
|
|
minecraft-configured-carver.json
|
type
|
A type for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "string", "enum": ["minecraft:cave", "cave", "minecraft:nether_cave", "nether_cave", "minecraft:canyon", "canyon", "minecraft:underwater_canyon", "underwater_canyon", "minecraft:underwater_cave", "underwater_cave"]}
|
minecraft-configured-carver.json
|
config
|
Options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "object", "properties": {"probability": {"type": "number", "minimum": 0, "maximum": 1}, "y": {"type": "object"}, "lava_level": {"type": "string", "enum": ["absolute", "above_bottom", "below_top"]}, "replaceable": {"oneOf": [{"type": "string", "minLength": 1}, {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}]}, "debug_settings": {"type": "object", "properties": {"debug_mode": {"type": "boolean", "default": false}, "air_state": {"type": "object", "additionalProperties": true}, "water_state": {"type": "object", "additionalProperties": true}, "lava_state": {"type": "object", "additionalProperties": true}, "barrier_state": {"type": "object", "additionalProperties": true}}, "additionalProperties": false}, "yScale": {"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}, "horizontal_radius_multiplier": {"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}, "vertical_radius_multiplier": {"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}, "floor_level": {"oneOf": [{"type": "number", "minimum": -1, "maximum": 1}, {"type": "object", "additionalProperties": true}]}, "vertical_rotation": {"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}, "shape": {"type": "object", "additionalProperties": true}}, "additionalProperties": false}
|
minecraft-configured-carver.json
|
probability
|
A probability that each chunk attempts to generate for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "number", "minimum": 0, "maximum": 1}
|
minecraft-configured-carver.json
|
y
|
A height at which to generate the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "object"}
|
minecraft-configured-carver.json
|
lava_level
|
A height at which to generate the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "string", "enum": ["absolute", "above_bottom", "below_top"]}
|
minecraft-configured-carver.json
|
replaceable
|
Blocks can be carved for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"oneOf": [{"type": "string", "minLength": 1}, {"type": "array", "uniqueItems": true, "items": {"type": "string", "minLength": 1}}]}
|
minecraft-configured-carver.json
|
items
|
A block can be carved for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "string", "minLength": 1}
|
minecraft-configured-carver.json
|
debug_settings
|
Replace blocks for debugging for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "object", "properties": {"debug_mode": {"type": "boolean", "default": false}, "air_state": {"type": "object", "additionalProperties": true}, "water_state": {"type": "object", "additionalProperties": true}, "lava_state": {"type": "object", "additionalProperties": true}, "barrier_state": {"type": "object", "additionalProperties": true}}, "additionalProperties": false}
|
minecraft-configured-carver.json
|
debug_mode
|
Whether to enable debug mode for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "boolean", "default": false}
|
minecraft-configured-carver.json
|
air_state
|
Air replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "object", "additionalProperties": true}
|
minecraft-configured-carver.json
|
water_state
|
Water replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "object", "additionalProperties": true}
|
minecraft-configured-carver.json
|
lava_state
|
Lava replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "object", "additionalProperties": true}
|
minecraft-configured-carver.json
|
barrier_state
|
Barrier replacement options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "object", "additionalProperties": true}
|
minecraft-configured-carver.json
|
yScale
|
Vertical scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}
|
minecraft-configured-carver.json
|
horizontal_radius_multiplier
|
Horizontal tunnel scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}
|
minecraft-configured-carver.json
|
vertical_radius_multiplier
|
Vertical tunnel scaling options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}
|
minecraft-configured-carver.json
|
floor_level
|
Floor level options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"oneOf": [{"type": "number", "minimum": -1, "maximum": 1}, {"type": "object", "additionalProperties": true}]}
|
minecraft-configured-carver.json
|
vertical_rotation
|
Vertical rotation options for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"oneOf": [{"type": "number"}, {"type": "object", "additionalProperties": true}]}
|
minecraft-configured-carver.json
|
shape
|
Ravine shape for the current carver
https://minecraft.fandom.com/wiki/Custom_carver#JSON_format
|
{"type": "object", "additionalProperties": true}
|
csslintrc.json
|
rule
|
CSS Lint rule
'false' means rule is off
'true' means it is a warning
'2' means the rule is an error
|
{"enum": [2, true, false]}
|
drone.json
|
tolerations
|
If specified, the pod's tolerations.
|
{"items": {}, "type": "array"}
|
drone.json
|
dns_config
|
Specifies the DNS parameters of a pod. Parameters specified here will be merged to the generated DNS configuration based on DNSPolicy.
|
{}
|
drone.json
|
host_aliases
|
HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts file if specified. This is only valid for non-hostNetwork pods.
|
{"items": {}, "type": "array"}
|
drone.json
|
node_selector
|
A list of node selector terms.
|
{"items": {}}
|
drone.json
|
service_account_name
|
The name of the service account to use when running the kubernetes pipeline
|
{"type": "string"}
|
execution-environment.json
|
See
V1: https://docs.ansible.com/automation-controller/latest/html/userguide/ee_reference.html
V3: https://ansible-builder.readthedocs.io/en/latest/definition/
|
{"$defs": {"TYPE_DictOrStringOrListOfStrings": {"anyOf": [{"type": "object"}, {"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "TYPE_StringOrListOfStrings": {"anyOf": [{"type": "string"}, {"items": {"type": "string"}, "type": "array"}]}, "v1": {"additionalProperties": false, "properties": {"additional_build_steps": {"properties": {"append": {"examples": ["RUN cat /etc/os-release"]}, "prepend": {"examples": ["RUN cat /etc/os-release"]}}, "type": "object"}, "ansible_config": {"examples": ["ansible.cfg"], "type": "string"}, "build_arg_defaults": {"additionalProperties": true, "properties": {"EE_BASE_IMAGE": {"type": "string"}}, "type": "object"}, "dependencies": {"properties": {"galaxy": {"examples": ["requirements.yml"], "type": "string"}, "python": {"examples": ["requirements.txt"], "type": "string"}, "system": {"examples": ["bindep.txt"], "type": "string"}}, "type": "object"}, "version": {"enum": [1], "type": "integer"}}, "required": ["version", "dependencies"], "type": "object"}, "v3": {"additionalProperties": false, "properties": {"additional_build_files": {"items": {"additionalProperties": false, "properties": {"dest": {"type": "string"}, "src": {"type": "string"}}, "required": ["src", "dest"], "type": "object"}, "type": "array"}, "additional_build_steps": {"properties": {"append_base": {"examples": ["RUN cat /etc/os-release"]}, "append_builder": {"examples": ["RUN cat /etc/os-release"]}, "append_final": {"examples": ["RUN cat /etc/os-release"]}, "append_galaxy": {"examples": ["RUN cat /etc/os-release"]}, "prepend_base": {"examples": ["RUN cat /etc/os-release"]}, "prepend_builder": {"examples": ["RUN cat /etc/os-release"]}, "prepend_final": {"examples": ["RUN cat /etc/os-release"]}, "prepend_galaxy": {"examples": ["RUN cat /etc/os-release"]}}, "type": "object"}, "build_arg_defaults": {"additionalProperties": false, "properties": {"ANSIBLE_GALAXY_CLI_COLLECTION_OPTS": {"type": "string"}, "ANSIBLE_GALAXY_CLI_ROLE_OPTS": {"type": "string"}, "PKGMGR_PRESERVE_CACHE": {"type": "string"}}, "type": "object"}, "dependencies": {"properties": {"ansible_core": {"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}, "ansible_runner": {"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}, "galaxy": {"examples": ["requirements.yml"]}, "python": {"examples": ["requirements.txt"]}, "python_interpreter": {"additionalProperties": false, "properties": {"package_system": {"type": "string"}, "python_path": {"type": "string"}}, "type": "object"}, "system": {"examples": ["bindep.txt"]}}, "type": "object"}, "images": {"additionalProperties": false, "properties": {"base_image": {"name": {"examples": ["registry.redhat.io/ansible-automation-platform-21/ee-minimal-rhel8:latest"], "type": "string"}, "type": "object"}}, "type": "object"}, "options": {"additionalProperties": false, "properties": {"container_init": {"additionalProperties": false, "properties": {"cmd": {"type": "string"}, "entrypoint": {"type": "string"}, "package_pip": {"type": "string"}}, "type": "object"}, "package_manager_path": {"type": "string"}, "relax_passwd_permissions": {"type": "boolean"}, "skip_ansible_check": {"type": "boolean"}, "user": {"type": "string"}, "workdir": {"type": ["string", "null"]}}, "type": "object"}, "version": {"enum": [3], "type": "integer"}}, "required": ["version", "dependencies"], "type": "object"}}, "$schema": "http://json-schema.org/draft-07/schema", "examples": ["execution-environment.yml"], "oneOf": [{}, {}]}
|
|
execution-environment.json
|
dependencies
|
Allows adding system, python or galaxy dependencies.
|
{"properties": {"galaxy": {"examples": ["requirements.yml"], "type": "string"}, "python": {"examples": ["requirements.txt"], "type": "string"}, "system": {"examples": ["bindep.txt"], "type": "string"}}, "type": "object"}
|
execution-environment.json
|
additional_build_files
|
Describes files to add to the build context
|
{"items": {"additionalProperties": false, "properties": {"dest": {"type": "string"}, "src": {"type": "string"}}, "required": ["src", "dest"], "type": "object"}, "type": "array"}
|
execution-environment.json
|
dest
|
Relative subdirectory under build context to place file
|
{"type": "string"}
|
execution-environment.json
|
src
|
File to add to build context
|
{"type": "string"}
|
execution-environment.json
|
dependencies
|
Allows adding system, python or galaxy dependencies.
|
{"properties": {"ansible_core": {"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}, "ansible_runner": {"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}, "galaxy": {"examples": ["requirements.yml"]}, "python": {"examples": ["requirements.txt"]}, "python_interpreter": {"additionalProperties": false, "properties": {"package_system": {"type": "string"}, "python_path": {"type": "string"}}, "type": "object"}, "system": {"examples": ["bindep.txt"]}}, "type": "object"}
|
execution-environment.json
|
ansible_core
|
Ansible package installation
|
{"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}
|
execution-environment.json
|
package_pip
|
Ansible package to install via pip
|
{"type": "string"}
|
execution-environment.json
|
ansible_runner
|
Ansible Runner package installation
|
{"additionalProperties": false, "oneOf": [{"required": ["package_pip"]}], "properties": {"package_pip": {"type": "string"}}, "type": "object"}
|
execution-environment.json
|
package_pip
|
Ansible Runner package to install via pip
|
{"type": "string"}
|
execution-environment.json
|
python_interpreter
|
Python package name and path
|
{"additionalProperties": false, "properties": {"package_system": {"type": "string"}, "python_path": {"type": "string"}}, "type": "object"}
|
execution-environment.json
|
package_system
|
The python package to install via system package manager
|
{"type": "string"}
|
execution-environment.json
|
python_path
|
Path to the python interpreter
|
{"type": "string"}
|
execution-environment.json
|
options
|
Options that effect runtime behavior
|
{"additionalProperties": false, "properties": {"container_init": {"additionalProperties": false, "properties": {"cmd": {"type": "string"}, "entrypoint": {"type": "string"}, "package_pip": {"type": "string"}}, "type": "object"}, "package_manager_path": {"type": "string"}, "relax_passwd_permissions": {"type": "boolean"}, "skip_ansible_check": {"type": "boolean"}, "user": {"type": "string"}, "workdir": {"type": ["string", "null"]}}, "type": "object"}
|
execution-environment.json
|
container_init
|
Customize container startup behavior
|
{"additionalProperties": false, "properties": {"cmd": {"type": "string"}, "entrypoint": {"type": "string"}, "package_pip": {"type": "string"}}, "type": "object"}
|
execution-environment.json
|
cmd
|
literal value for CMD Containerfile directive
|
{"type": "string"}
|
execution-environment.json
|
entrypoint
|
literal value for ENTRYPOINT Containerfile directive
|
{"type": "string"}
|
execution-environment.json
|
package_pip
|
package to install via pip for entrypoint support
|
{"type": "string"}
|
execution-environment.json
|
package_manager_path
|
Path to the system package manager to use
|
{"type": "string"}
|
execution-environment.json
|
relax_passwd_permissions
|
allows GID0 write access to /etc/passwd; currently necessary for many uses
|
{"type": "boolean"}
|
execution-environment.json
|
skip_ansible_check
|
Disables the check for Ansible/Runner in final image
|
{"type": "boolean"}
|
execution-environment.json
|
user
|
Sets the username or UID
|
{"type": "string"}
|
execution-environment.json
|
workdir
|
Default working directory, also often the homedir for ephemeral UIDs
|
{"type": ["string", "null"]}
|
devfile.json
|
Devfile describes the structure of a cloud-native devworkspace and development environment.
|
{"type": "object", "required": ["schemaVersion"], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "commands": {"type": "array", "items": {"type": "object", "required": ["id"], "oneOf": [{"required": ["exec"]}, {"required": ["apply"]}, {"required": ["composite"]}], "properties": {"apply": {"type": "object", "required": ["component"], "properties": {"component": {"type": "string"}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}}, "additionalProperties": false}, "attributes": {"type": "object", "additionalProperties": true}, "composite": {"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}, "parallel": {"type": "boolean"}}, "additionalProperties": false}, "exec": {"type": "object", "required": ["commandLine", "component"], "properties": {"commandLine": {"type": "string"}, "component": {"type": "string"}, "env": {"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "hotReloadCapable": {"type": "boolean"}, "label": {"type": "string"}, "workingDir": {"type": "string"}}, "additionalProperties": false}, "id": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}}, "additionalProperties": false}}, "components": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["container"]}, {"required": ["kubernetes"]}, {"required": ["openshift"]}, {"required": ["volume"]}, {"required": ["image"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "container": {"type": "object", "required": ["image"], "properties": {"annotation": {"type": "object", "properties": {"deployment": {"type": "object", "additionalProperties": {"type": "string"}}, "service": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "args": {"type": "array", "items": {"type": "string"}}, "command": {"type": "array", "items": {"type": "string"}}, "cpuLimit": {"type": "string"}, "cpuRequest": {"type": "string"}, "dedicatedPod": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "env": {"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "image": {"type": "string"}, "memoryLimit": {"type": "string"}, "memoryRequest": {"type": "string"}, "mountSources": {"type": "boolean"}, "sourceMapping": {"type": "string", "default": "/projects"}, "volumeMounts": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}}, "additionalProperties": false}}}, "additionalProperties": false}, "image": {"type": "object", "required": ["imageName"], "oneOf": [{"required": ["dockerfile"]}], "properties": {"autoBuild": {"type": "boolean"}, "dockerfile": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["devfileRegistry"]}, {"required": ["git"]}], "properties": {"args": {"type": "array", "items": {"type": "string"}}, "buildContext": {"type": "string"}, "devfileRegistry": {"type": "object", "required": ["id"], "properties": {"id": {"type": "string"}, "registryUrl": {"type": "string"}}, "additionalProperties": false}, "git": {"type": "object", "required": ["remotes"], "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "fileLocation": {"type": "string"}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "rootRequired": {"type": "boolean"}, "uri": {"type": "string"}}, "additionalProperties": false}, "imageName": {"type": "string"}}, "additionalProperties": false}, "kubernetes": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "openshift": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false}, "volume": {"type": "object", "properties": {"ephemeral": {"type": "boolean"}, "size": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "events": {"type": "object", "properties": {"postStart": {"type": "array", "items": {"type": "string"}}, "postStop": {"type": "array", "items": {"type": "string"}}, "preStart": {"type": "array", "items": {"type": "string"}}, "preStop": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "metadata": {"type": "object", "properties": {"architectures": {"type": "array", "uniqueItems": true, "items": {"type": "string", "enum": ["amd64", "arm64", "ppc64le", "s390x"]}}, "attributes": {"type": "object", "additionalProperties": true}, "displayName": {"type": "string"}, "globalMemoryLimit": {"type": "string"}, "icon": {"type": "string"}, "language": {"type": "string"}, "name": {"type": "string"}, "projectType": {"type": "string"}, "provider": {"type": "string"}, "supportUrl": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "version": {"type": "string", "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"}, "website": {"type": "string"}}, "additionalProperties": true}, "parent": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["id"]}, {"required": ["kubernetes"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "commands": {"type": "array", "items": {"type": "object", "required": ["id"], "oneOf": [{"required": ["exec"]}, {"required": ["apply"]}, {"required": ["composite"]}], "properties": {"apply": {"type": "object", "properties": {"component": {"type": "string"}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}}, "additionalProperties": false}, "attributes": {"type": "object", "additionalProperties": true}, "composite": {"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}, "parallel": {"type": "boolean"}}, "additionalProperties": false}, "exec": {"type": "object", "properties": {"commandLine": {"type": "string"}, "component": {"type": "string"}, "env": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "group": {"type": "object", "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "hotReloadCapable": {"type": "boolean"}, "label": {"type": "string"}, "workingDir": {"type": "string"}}, "additionalProperties": false}, "id": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}}, "additionalProperties": false}}, "components": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["container"]}, {"required": ["kubernetes"]}, {"required": ["openshift"]}, {"required": ["volume"]}, {"required": ["image"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "container": {"type": "object", "properties": {"annotation": {"type": "object", "properties": {"deployment": {"type": "object", "additionalProperties": {"type": "string"}}, "service": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "args": {"type": "array", "items": {"type": "string"}}, "command": {"type": "array", "items": {"type": "string"}}, "cpuLimit": {"type": "string"}, "cpuRequest": {"type": "string"}, "dedicatedPod": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "env": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "image": {"type": "string"}, "memoryLimit": {"type": "string"}, "memoryRequest": {"type": "string"}, "mountSources": {"type": "boolean"}, "sourceMapping": {"type": "string"}, "volumeMounts": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}}, "additionalProperties": false}}}, "additionalProperties": false}, "image": {"type": "object", "oneOf": [{"required": ["dockerfile"]}, {"required": ["autoBuild"]}], "properties": {"autoBuild": {"type": "boolean"}, "dockerfile": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["devfileRegistry"]}, {"required": ["git"]}], "properties": {"args": {"type": "array", "items": {"type": "string"}}, "buildContext": {"type": "string"}, "devfileRegistry": {"type": "object", "properties": {"id": {"type": "string"}, "registryUrl": {"type": "string"}}, "additionalProperties": false}, "git": {"type": "object", "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "fileLocation": {"type": "string"}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "rootRequired": {"type": "boolean"}, "uri": {"type": "string"}}, "additionalProperties": false}, "imageName": {"type": "string"}}, "additionalProperties": false}, "kubernetes": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "openshift": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false}, "volume": {"type": "object", "properties": {"ephemeral": {"type": "boolean"}, "size": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "id": {"type": "string"}, "kubernetes": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string"}, "namespace": {"type": "string"}}, "additionalProperties": false}, "projects": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["git"]}, {"required": ["zip"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "clonePath": {"type": "string"}, "git": {"type": "object", "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "zip": {"type": "object", "properties": {"location": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "registryUrl": {"type": "string"}, "starterProjects": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["git"]}, {"required": ["zip"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "git": {"type": "object", "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "subDir": {"type": "string"}, "zip": {"type": "object", "properties": {"location": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "uri": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {"type": "string"}}, "version": {"type": "string", "pattern": "^(latest)|(([1-9])\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?)$"}}, "additionalProperties": false}, "projects": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["git"]}, {"required": ["zip"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "clonePath": {"type": "string"}, "git": {"type": "object", "required": ["remotes"], "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "zip": {"type": "object", "properties": {"location": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "schemaVersion": {"type": "string", "pattern": "^([2-9])\\.([0-9]+)\\.([0-9]+)(\\-[0-9a-z-]+(\\.[0-9a-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"}, "starterProjects": {"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["git"]}, {"required": ["zip"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "git": {"type": "object", "required": ["remotes"], "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "subDir": {"type": "string"}, "zip": {"type": "object", "properties": {"location": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}, "variables": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}
|
|
devfile.json
|
attributes
|
Map of implementation-dependant free-form YAML attributes.
|
{"type": "object", "additionalProperties": true}
|
devfile.json
|
commands
|
Predefined, ready-to-use, devworkspace-related commands
|
{"type": "array", "items": {"type": "object", "required": ["id"], "oneOf": [{"required": ["exec"]}, {"required": ["apply"]}, {"required": ["composite"]}], "properties": {"apply": {"type": "object", "required": ["component"], "properties": {"component": {"type": "string"}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}}, "additionalProperties": false}, "attributes": {"type": "object", "additionalProperties": true}, "composite": {"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}, "parallel": {"type": "boolean"}}, "additionalProperties": false}, "exec": {"type": "object", "required": ["commandLine", "component"], "properties": {"commandLine": {"type": "string"}, "component": {"type": "string"}, "env": {"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "hotReloadCapable": {"type": "boolean"}, "label": {"type": "string"}, "workingDir": {"type": "string"}}, "additionalProperties": false}, "id": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}}, "additionalProperties": false}}
|
devfile.json
|
apply
|
Command that consists in applying a given component definition, typically bound to a devworkspace event.
For example, when an `apply` command is bound to a `preStart` event, and references a `container` component, it will start the container as a K8S initContainer in the devworkspace POD, unless the component has its `dedicatedPod` field set to `true`.
When no `apply` command exist for a given component, it is assumed the component will be applied at devworkspace start by default, unless `deployByDefault` for that component is set to false.
|
{"type": "object", "required": ["component"], "properties": {"component": {"type": "string"}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}}, "additionalProperties": false}
|
devfile.json
|
component
|
Describes component that will be applied
|
{"type": "string"}
|
devfile.json
|
group
|
Defines the group this command is part of
|
{"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}
|
devfile.json
|
isDefault
|
Identifies the default command for a given group kind
|
{"type": "boolean"}
|
devfile.json
|
kind
|
Kind of group the command is part of
|
{"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}
|
devfile.json
|
label
|
Optional label that provides a label for this command to be used in Editor UI menus for example
|
{"type": "string"}
|
devfile.json
|
attributes
|
Map of implementation-dependant free-form YAML attributes.
|
{"type": "object", "additionalProperties": true}
|
devfile.json
|
composite
|
Composite command that allows executing several sub-commands either sequentially or concurrently
|
{"type": "object", "properties": {"commands": {"type": "array", "items": {"type": "string"}}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "label": {"type": "string"}, "parallel": {"type": "boolean"}}, "additionalProperties": false}
|
devfile.json
|
commands
|
The commands that comprise this composite command
|
{"type": "array", "items": {"type": "string"}}
|
devfile.json
|
group
|
Defines the group this command is part of
|
{"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}
|
devfile.json
|
isDefault
|
Identifies the default command for a given group kind
|
{"type": "boolean"}
|
devfile.json
|
kind
|
Kind of group the command is part of
|
{"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}
|
devfile.json
|
label
|
Optional label that provides a label for this command to be used in Editor UI menus for example
|
{"type": "string"}
|
devfile.json
|
parallel
|
Indicates if the sub-commands should be executed concurrently
|
{"type": "boolean"}
|
devfile.json
|
exec
|
CLI Command executed in an existing component container
|
{"type": "object", "required": ["commandLine", "component"], "properties": {"commandLine": {"type": "string"}, "component": {"type": "string"}, "env": {"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "group": {"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}, "hotReloadCapable": {"type": "boolean"}, "label": {"type": "string"}, "workingDir": {"type": "string"}}, "additionalProperties": false}
|
devfile.json
|
commandLine
|
The actual command-line string
Special variables that can be used:
- `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.
- `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.
|
{"type": "string"}
|
devfile.json
|
component
|
Describes component to which given action relates
|
{"type": "string"}
|
devfile.json
|
env
|
Optional list of environment variables that have to be set before running the command
|
{"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}
|
devfile.json
|
group
|
Defines the group this command is part of
|
{"type": "object", "required": ["kind"], "properties": {"isDefault": {"type": "boolean"}, "kind": {"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}}, "additionalProperties": false}
|
devfile.json
|
isDefault
|
Identifies the default command for a given group kind
|
{"type": "boolean"}
|
devfile.json
|
kind
|
Kind of group the command is part of
|
{"type": "string", "enum": ["build", "run", "test", "debug", "deploy"]}
|
devfile.json
|
hotReloadCapable
|
Whether the command is capable to reload itself when source code changes. If set to `true` the command won't be restarted and it is expected to handle file changes on its own.
Default value is `false`
|
{"type": "boolean"}
|
devfile.json
|
label
|
Optional label that provides a label for this command to be used in Editor UI menus for example
|
{"type": "string"}
|
devfile.json
|
workingDir
|
Working directory where the command should be executed
Special variables that can be used:
- `$PROJECTS_ROOT`: A path where projects sources are mounted as defined by container component's sourceMapping.
- `$PROJECT_SOURCE`: A path to a project source ($PROJECTS_ROOT/<project-name>). If there are multiple projects, this will point to the directory of the first one.
|
{"type": "string"}
|
devfile.json
|
id
|
Mandatory identifier that allows referencing this command in composite commands, from a parent, or in events.
|
{"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}
|
devfile.json
|
components
|
List of the devworkspace components, such as editor and plugins, user-provided containers, or other types of components
|
{"type": "array", "items": {"type": "object", "required": ["name"], "oneOf": [{"required": ["container"]}, {"required": ["kubernetes"]}, {"required": ["openshift"]}, {"required": ["volume"]}, {"required": ["image"]}], "properties": {"attributes": {"type": "object", "additionalProperties": true}, "container": {"type": "object", "required": ["image"], "properties": {"annotation": {"type": "object", "properties": {"deployment": {"type": "object", "additionalProperties": {"type": "string"}}, "service": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "args": {"type": "array", "items": {"type": "string"}}, "command": {"type": "array", "items": {"type": "string"}}, "cpuLimit": {"type": "string"}, "cpuRequest": {"type": "string"}, "dedicatedPod": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "env": {"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "image": {"type": "string"}, "memoryLimit": {"type": "string"}, "memoryRequest": {"type": "string"}, "mountSources": {"type": "boolean"}, "sourceMapping": {"type": "string", "default": "/projects"}, "volumeMounts": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}}, "additionalProperties": false}}}, "additionalProperties": false}, "image": {"type": "object", "required": ["imageName"], "oneOf": [{"required": ["dockerfile"]}], "properties": {"autoBuild": {"type": "boolean"}, "dockerfile": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["devfileRegistry"]}, {"required": ["git"]}], "properties": {"args": {"type": "array", "items": {"type": "string"}}, "buildContext": {"type": "string"}, "devfileRegistry": {"type": "object", "required": ["id"], "properties": {"id": {"type": "string"}, "registryUrl": {"type": "string"}}, "additionalProperties": false}, "git": {"type": "object", "required": ["remotes"], "properties": {"checkoutFrom": {"type": "object", "properties": {"remote": {"type": "string"}, "revision": {"type": "string"}}, "additionalProperties": false}, "fileLocation": {"type": "string"}, "remotes": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "rootRequired": {"type": "boolean"}, "uri": {"type": "string"}}, "additionalProperties": false}, "imageName": {"type": "string"}}, "additionalProperties": false}, "kubernetes": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false}, "name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "openshift": {"type": "object", "oneOf": [{"required": ["uri"]}, {"required": ["inlined"]}], "properties": {"deployByDefault": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "inlined": {"type": "string"}, "uri": {"type": "string"}}, "additionalProperties": false}, "volume": {"type": "object", "properties": {"ephemeral": {"type": "boolean"}, "size": {"type": "string"}}, "additionalProperties": false}}, "additionalProperties": false}}
|
devfile.json
|
attributes
|
Map of implementation-dependant free-form YAML attributes.
|
{"type": "object", "additionalProperties": true}
|
devfile.json
|
container
|
Allows adding and configuring devworkspace-related containers
|
{"type": "object", "required": ["image"], "properties": {"annotation": {"type": "object", "properties": {"deployment": {"type": "object", "additionalProperties": {"type": "string"}}, "service": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}, "args": {"type": "array", "items": {"type": "string"}}, "command": {"type": "array", "items": {"type": "string"}}, "cpuLimit": {"type": "string"}, "cpuRequest": {"type": "string"}, "dedicatedPod": {"type": "boolean"}, "endpoints": {"type": "array", "items": {"type": "object", "required": ["name", "targetPort"], "properties": {"annotation": {"type": "object", "additionalProperties": {"type": "string"}}, "attributes": {"type": "object", "additionalProperties": true}, "exposure": {"type": "string", "default": "public", "enum": ["public", "internal", "none"]}, "name": {"type": "string", "maxLength": 15, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}, "protocol": {"type": "string", "default": "http", "enum": ["http", "https", "ws", "wss", "tcp", "udp"]}, "secure": {"type": "boolean"}, "targetPort": {"type": "integer"}}, "additionalProperties": false}}, "env": {"type": "array", "items": {"type": "object", "required": ["name", "value"], "properties": {"name": {"type": "string"}, "value": {"type": "string"}}, "additionalProperties": false}}, "image": {"type": "string"}, "memoryLimit": {"type": "string"}, "memoryRequest": {"type": "string"}, "mountSources": {"type": "boolean"}, "sourceMapping": {"type": "string", "default": "/projects"}, "volumeMounts": {"type": "array", "items": {"type": "object", "required": ["name"], "properties": {"name": {"type": "string", "maxLength": 63, "pattern": "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$"}, "path": {"type": "string"}}, "additionalProperties": false}}}, "additionalProperties": false}
|
devfile.json
|
annotation
|
Annotations that should be added to specific resources for this container
|
{"type": "object", "properties": {"deployment": {"type": "object", "additionalProperties": {"type": "string"}}, "service": {"type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}
|
devfile.json
|
deployment
|
Annotations to be added to deployment
|
{"type": "object", "additionalProperties": {"type": "string"}}
|
devfile.json
|
service
|
Annotations to be added to service
|
{"type": "object", "additionalProperties": {"type": "string"}}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.