Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CommandGroup ¶
type CommandGroup struct {
Kind CommandGroupKind `yaml:"kind,omitempty" json:"kind,omitempty"`
IsDefault bool `yaml:"isDefault,omitempty" json:"isDefault,omitempty"`
}
CommandGroup stores the group information for a command
type CommandGroupKind ¶
type CommandGroupKind string
CommandGroupKind describes the kind of command group
const ( BuildCommandGroupKind CommandGroupKind = "build" RunCommandGroupKind CommandGroupKind = "run" TestCommandGroupKind CommandGroupKind = "test" DebugCommandGroupKind CommandGroupKind = "debug" DeployCommandGroupKind CommandGroupKind = "deploy" )
type CommandType ¶
type CommandType struct {
Group CommandGroup `yaml:"group,omitempty" json:"group,omitempty"`
}
CommandType stores the group for a command
type Commands ¶
type Commands struct {
Id string `yaml:"id,omitempty" json:"id,omitempty"`
Exec CommandType `yaml:"exec,omitempty" json:"exec,omitempty"`
Apply CommandType `yaml:"apply,omitempty" json:"apply,omitempty"`
Composite CommandType `yaml:"composite,omitempty" json:"composite,omitempty"`
}
Commands stores the command information
type DeploymentScopeKind ¶
type DeploymentScopeKind string
DeploymentScopeKind describes the kind of deployment scope
const ( InnerloopKind DeploymentScopeKind = "innerloop" OuterloopKind DeploymentScopeKind = "outerloop" )
type Devfile ¶
type Devfile struct {
Meta Schema `yaml:"metadata,omitempty" json:"metadata,omitempty"`
StarterProjects []StarterProject `yaml:"starterProjects,omitempty" json:"starterProjects,omitempty"`
Commands []Commands `yaml:"commands,omitempty" json:"commands,omitempty"`
SchemaVersion string `yaml:"schemaVersion,omitempty" json:"schemaVersion,omitempty"`
}
Devfile is the devfile structure that is used by index component
type DevfileType ¶
type DevfileType string
DevfileType describes the type of devfile
const ( // SampleDevfileType represents a sample devfile SampleDevfileType DevfileType = "sample" // StackDevfileType represents a stack devfile StackDevfileType DevfileType = "stack" )
type ExtraDevfileEntries ¶
type ExtraDevfileEntries struct {
Samples []Schema `yaml:"samples,omitempty" json:"samples,omitempty"`
Stacks []Schema `yaml:"stacks,omitempty" json:"stacks,omitempty"`
}
ExtraDevfileEntries is the extraDevfileEntries structure that is used by index component
type Git ¶
type Git struct {
Remotes map[string]string `yaml:"remotes,omitempty" json:"remotes,omitempty"`
Url string `yaml:"url,omitempty" json:"url,omitempty"`
RemoteName string `yaml:"remoteName,omitempty" json:"remoteName,omitempty"`
SubDir string `yaml:"subDir,omitempty" json:"subDir,omitempty"`
Revision string `yaml:"revision,omitempty" json:"revision,omitempty"`
}
Git stores the information of remote repositories
type LastModifiedEntry ¶
type LastModifiedInfo ¶
type LastModifiedInfo struct {
Stacks []LastModifiedEntry `yaml:"stacks,omitempty" json:"stacks,omitempty"`
Samples []LastModifiedEntry `yaml:"samples,omitempty" json:"samples,omitempty"`
}
type Schema ¶
type Schema struct {
Name string `yaml:"name,omitempty" json:"name,omitempty"`
Version string `yaml:"version,omitempty" json:"version,omitempty"`
Attributes map[string]apiext.JSON `yaml:"attributes,omitempty" json:"attributes,omitempty"`
DisplayName string `yaml:"displayName,omitempty" json:"displayName,omitempty"`
Description string `yaml:"description,omitempty" json:"description,omitempty"`
Type DevfileType `yaml:"type,omitempty" json:"type,omitempty"`
Tags []string `yaml:"tags,omitempty" json:"tags,omitempty"`
Architectures []string `yaml:"architectures,omitempty" json:"architectures,omitempty"`
Icon string `yaml:"icon,omitempty" json:"icon,omitempty"`
GlobalMemoryLimit string `yaml:"globalMemoryLimit,omitempty" json:"globalMemoryLimit,omitempty"`
ProjectType string `yaml:"projectType,omitempty" json:"projectType,omitempty"`
Language string `yaml:"language,omitempty" json:"language,omitempty"`
Links map[string]string `yaml:"links,omitempty" json:"links,omitempty"`
CommandGroups map[CommandGroupKind]bool `yaml:"commandGroups,omitempty" json:"commandGroups,omitempty"`
DeploymentScopes map[DeploymentScopeKind]bool `yaml:"deploymentScopes,omitempty" json:"deploymentScopes,omitempty"`
Resources []string `yaml:"resources,omitempty" json:"resources,omitempty"`
StarterProjects []string `yaml:"starterProjects,omitempty" json:"starterProjects,omitempty"`
Git *Git `yaml:"git,omitempty" json:"git,omitempty"`
Provider string `yaml:"provider,omitempty" json:"provider,omitempty"`
SupportUrl string `yaml:"supportUrl,omitempty" json:"supportUrl,omitempty"`
Versions []Version `yaml:"versions,omitempty" json:"versions,omitempty"`
LastModified string `yaml:"lastModified,omitempty" json:"lastModified,omitempty"`
}
Schema is the index file schema
type StackInfo ¶
type StackInfo struct {
Name string `yaml:"name,omitempty" json:"name,omitempty"`
DisplayName string `yaml:"displayName,omitempty" json:"displayName,omitempty"`
Description string `yaml:"description,omitempty" json:"description,omitempty"`
Icon string `yaml:"icon,omitempty" json:"icon,omitempty"`
Versions []Version `yaml:"versions,omitempty" json:"versions,omitempty"`
}
StackInfo stores the top-level stack information defined within stack.yaml
type StarterProject ¶
type StarterProject struct {
Name string `yaml:"name,omitempty" json:"name,omitempty"`
}
StarterProject is the devfile starter project
type Version ¶
type Version struct {
Version string `yaml:"version,omitempty" json:"version,omitempty"`
SchemaVersion string `yaml:"schemaVersion,omitempty" json:"schemaVersion,omitempty"`
Default bool `yaml:"default,omitempty" json:"default,omitempty"`
Git *Git `yaml:"git,omitempty" json:"git,omitempty"`
Description string `yaml:"description,omitempty" json:"description,omitempty"`
Tags []string `yaml:"tags,omitempty" json:"tags,omitempty"`
Architectures []string `yaml:"architectures,omitempty" json:"architectures,omitempty"`
Icon string `yaml:"icon,omitempty" json:"icon,omitempty"`
Links map[string]string `yaml:"links,omitempty" json:"links,omitempty"`
CommandGroups map[CommandGroupKind]bool `yaml:"commandGroups,omitempty" json:"commandGroups,omitempty"`
DeploymentScopes map[DeploymentScopeKind]bool `yaml:"deploymentScopes,omitempty" json:"deploymentScopes,omitempty"`
Resources []string `yaml:"resources,omitempty" json:"resources,omitempty"`
StarterProjects []string `yaml:"starterProjects,omitempty" json:"starterProjects,omitempty"`
LastModified string `yaml:"lastModified,omitempty" json:"lastModified,omitempty"`
}
Version stores the information for each stack version