ToolMatter
Your Apps in Action
Risersoft
Buy
Try
Explore
Documentation
Public
Use this form to visualize JSON schema for Eclipse Che Devfiles.
{{repoTitle.MainEntity}}
.metadata
_
metadata.name - Devfile Name
metadata.generateName - Devfile Generate Name
projects The Projects List
#
name
source.type
source.location
source.branch
source.startPoint
source.tag
source.commitId
source.sparseCheckoutDir
clonePath
Actions
{{$index+1}}.
{{row.name}}
{{row.source.type}}
{{row.source.location}}
{{row.source.branch}}
{{row.source.startPoint}}
{{row.source.tag}}
{{row.source.commitId}}
{{row.source.sparseCheckoutDir}}
{{row.clonePath}}
components The Components List
#
alias
type
mountSources
automountWorkspaceSecrets
Actions
{{$index+1}}.
{{row.alias}}
{{row.type}}
{{row.mountSourcesSelected.DisplayText}}
{{row.automountWorkspaceSecretsSelected.DisplayText}}
commands The Commands List
#
name
previewUrl.port
previewUrl.path
Actions
{{$index+1}}.
{{row.name}}
{{row.previewUrl.port}}
{{row.previewUrl.path}}
.attributes
_
{{repoTitle.MainEntity}}
×
name - The Project Name
source.type - Project's source type.
source.location - Project's source location address. Should be URL for git and github located projects, or file:// for zip.
source.branch - The name of the of the branch to check out after obtaining the source from the location. The branch has to already exist in the source otherwise the default branch is used. In case of git, this is also the name of the remote branch to push to.
source.startPoint - The tag or commit id to reset the checked out branch to.
source.tag - The name of the tag to reset the checked out branch to. Note that this is equivalent to 'startPoint' and provided for convenience.
source.commitId - The id of the commit to reset the checked out branch to. Note that this is equivalent to 'startPoint' and provided for convenience.
source.sparseCheckoutDir - Part of project to populate in the working directory.
clonePath - The path relative to the root of the projects to which this project should be cloned into. This is a unix-style relative path (i.e. uses forward slashes). The path is invalid if it is absolute or tries to escape the project root through the usage of '..'. If not specified, defaults to the project name.
{{repoTitle.MainEntity}}
alias - The name using which other places of this devfile (like commands) can refer to this component. This attribute is optional but must be unique in the devfile if specified.
type - Describes type of the component, e.g. whether it is an plugin or editor or other type
mountSources - Describes whether projects sources should be mount to the component. `CHE_PROJECTS_ROOT` environment variable should contains a path where projects sources are mount
automountWorkspaceSecrets - Describes whether namespace secrets should be mount to the component.
volumes Describes volumes which should be mount to component
#
name
containerPath
Actions
{{$index+1}}.
env The environment variables list that should be set to docker container
#
name
value
Actions
{{$index+1}}.
endpoints Describes dockerimage component endpoints
#
Actions
{{$index+1}}.
{{repoTitle.MainEntity}}
{{repoTitle.MainEntity}}
{{repoTitle.MainEntity}}
name - Describes the name of the command. Should be unique per commands set.
.attributes
_commands
actions The Command Actions List
#
type
component
command
workdir
reference
referenceContent
Actions
{{$index+1}}.
{{row.type}}
{{row.component}}
{{row.command}}
{{row.workdir}}
{{row.reference}}
{{row.referenceContent}}
.previewUrl
_commands
previewUrl.port
previewUrl.path
{{repoTitle.MainEntity}}
×
type - Describes action type
component - Describes component to which given action relates
command - The actual action command-line string
workdir - Working directory where the command should be executed
reference - the path relative to the location of the devfile to the configuration file defining one or more actions in the editor-specific format
referenceContent - The content of the referenced configuration file that defines one or more actions in the editor-specific format
Download Json
{{message}}
ToolMatter