Documentation
¶
Index ¶
- type AngularCliJson
- type AngularHostPort
- type AngularJson
- type AngularProjectBody
- type ApplicationFileInfo
- type Component
- type DetectionSettings
- type DevfileFilter
- type DevfileScore
- type DevfileType
- type EnvVar
- type Language
- type MicronautApplicationProps
- type OpenLibertyServerXml
- type PortDetectionAlgorithm
- type PortMatchRule
- type PortMatchRules
- type PortMatchSubRule
- type QuarkusApplicationYaml
- type QuarkusHttp
- type QuarkusHttpPort
- type SpringApplicationProsServer
- type Version
- type VertexServerConfig
- type VertxConf
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AngularCliJson ¶ added in v1.2.0
type AngularCliJson struct {
Defaults struct {
Serve AngularHostPort `json:"serve"`
} `json:"defaults"`
}
AngularCliJson represents the angular-cli.json file
type AngularHostPort ¶ added in v1.2.0
AngularHostPort represents the value of AngularCliJson.Defaults.Serve
type AngularJson ¶ added in v1.2.0
type AngularJson struct {
Projects map[string]AngularProjectBody `json:"projects"`
}
AngularJson represents angular.json
type AngularProjectBody ¶ added in v1.2.0
type AngularProjectBody struct {
Architect struct {
Serve struct {
Options AngularHostPort `json:"options"`
} `json:"serve"`
} `json:"architect"`
}
AngularProjectBody represents the value of each key of the map for AngularJson.Projects
type ApplicationFileInfo ¶
type ApplicationFileInfo struct {
// Context is the given context
Context *context.Context
// Root is the root path of the component
Root string
// Dir is the directory of the application file
Dir string
// File is the filename of the application file
File string
}
ApplicationFileInfo is the main struct used to select potential application files for detectors
type Component ¶
type Component struct {
// Name is the name of the component
Name string
// Path is the root path of the component
Path string
// Languages is the slice of languages detected inside the component
Languages []Language
// Ports is the slice of integers (port values) detected
Ports []int
}
Component represents every component detected from analysis process
type DetectionSettings ¶
type DetectionSettings struct {
// BasePath is the root path we need to apply detection process
BasePath string
// PortDetectionStrategy is the list of areas that we will apply port detection
// Accepted values can be found at PortDetectionAlgorithm
PortDetectionStrategy []PortDetectionAlgorithm
}
DetectionSettings represents the required settings for component detection
type DevfileFilter ¶ added in v1.0.1
type DevfileFilter struct {
// MinSchemaVersion is the minimum schemaVersion of the fetched devfiles
MinSchemaVersion string
// MaxSchemaVersion is the maximum schemaVersion of the fetched devfiles
MaxSchemaVersion string
}
DevfileFilter represents all filters passed to registry api upon requests
type DevfileScore ¶ added in v1.1.2
type DevfileScore struct {
// DevfileIndex is the index of the fetched registry stacks slice
DevfileIndex int
// Score is the score that a devfile has. The biggest score gets matched with a given source code
Score int
}
DevfileScore represents the score that each devfile gets upon devfile matching process
type DevfileType ¶ added in v1.1.2
type DevfileType struct {
// Name is the name of a devfile
Name string
// Language is the language of a devfile
Language string
// ProjectType is the projectType of a devfile
ProjectType string
// Tags is a slice of tags of a devfile
Tags []string
// Versions is a slice of versions of a devfile
Versions []Version
}
DevfileType represents a devfile.y(a)ml file
type EnvVar ¶ added in v1.1.5
type EnvVar struct {
// Name is the name of the environment variable.
Name string
// Value is the value associated with the environment variable.
Value string
}
EnvVar represents an environment variable with a name and a corresponding value.
type Language ¶
type Language struct {
// Name is the name of the language
Name string
// Aliases is the slice of aliases for this language
Aliases []string
// Weight is the float value which shows the importance of this language inside a given source code
Weight float64
// Frameworks is the slice of frameworks detected for this language
Frameworks []string
// Tools is the slice of tools detected for this language
Tools []string
// CanBeComponent is the bool value shows if this language can be detected as component
CanBeComponent bool
// CanBeContainerComponent is the bool value shows if this language can be detected as container component
CanBeContainerComponent bool
}
Language represents every language detected from language analysis process
type MicronautApplicationProps ¶ added in v1.2.0
type MicronautApplicationProps struct {
Micronaut struct {
Server struct {
Port int `yaml:"port,omitempty"`
SSL struct {
Enabled bool `yaml:"enabled,omitempty"`
Port int `yaml:"port,omitempty"`
} `yaml:"ssl,omitempty"`
} `yaml:"server,omitempty"`
} `yaml:"micronaut,omitempty"`
}
MicronautApplicationProps represents the application.properties file of micronaut applications
type OpenLibertyServerXml ¶ added in v1.2.0
type OpenLibertyServerXml struct {
HttpEndpoint struct {
HttpPort string `xml:"httpPort,attr"`
HttpsPort string `xml:"httpsPort,attr"`
} `xml:"httpEndpoint"`
Variables []struct {
Name string `xml:"name,attr"`
DefaultValue string `xml:"defaultValue,attr"`
} `xml:"variable"`
}
OpenLibertyServerXml represents the server.xml file inside an open liberty application
type PortDetectionAlgorithm ¶
type PortDetectionAlgorithm int
PortDetectionAlgorithm represents one of port detection algorithm values
const ( DockerFile PortDetectionAlgorithm = 0 Compose PortDetectionAlgorithm = 1 Source PortDetectionAlgorithm = 2 )
type PortMatchRule ¶
type PortMatchRule struct {
// Regex is the regexp.Regexp value which will be used to match ports
Regex *regexp.Regexp
// ToReplace is the string value which will be replaced once the Regex is matched
ToReplace string
}
PortMatchRule represents a rule for port matching with a given regex and a string to replace
type PortMatchRules ¶
type PortMatchRules struct {
// MatchIndexRegexes is a slice of PortMatchRule
MatchIndexRegexes []PortMatchRule
// MatchRegexes is a slice of PortMatchSubRule
MatchRegexes []PortMatchSubRule
}
PortMatchRules represents a struct of rules and subrules for port matching
type PortMatchSubRule ¶
type PortMatchSubRule struct {
// Regex is the primary regexp.Regexp value for the sub rule
Regex *regexp.Regexp
// Regex is the secondary regexp.Regexp value for the sub rule
SubRegex *regexp.Regexp
}
PortMatchSubRule represents a sub rule for port matching
type QuarkusApplicationYaml ¶ added in v1.2.0
type QuarkusApplicationYaml struct {
Quarkus QuarkusHttp `yaml:"quarkus,omitempty"`
}
QuarkusApplicationYaml represents the application.yaml used for quarkus applications
type QuarkusHttp ¶ added in v1.2.0
type QuarkusHttp struct {
Http QuarkusHttpPort `yaml:"http,omitempty"`
}
QuarkusHttp represents the port field from application.yaml of quarkus applications
type QuarkusHttpPort ¶ added in v1.2.0
type QuarkusHttpPort struct {
Port int `yaml:"port,omitempty"`
InsecureRequests string `yaml:"insecure-requests,omitempty"`
SSLPort int `yaml:"ssl-port,omitempty"`
}
QuarkusHttpPort represents the port value from application.yaml of quarkus applications
type SpringApplicationProsServer ¶ added in v1.2.0
type SpringApplicationProsServer struct {
Server struct {
Port int `yaml:"port,omitempty"`
Http struct {
Port int `yaml:"port,omitempty"`
} `yaml:"http,omitempty"`
} `yaml:"server,omitempty"`
}
SpringApplicationProsServer represents the application.properties file used for spring applications
type Version ¶ added in v1.0.1
type Version struct {
// SchemaVersion is the schemaVersion value of a devfile version
SchemaVersion string
// Default is the default value of a devfile version
Default bool
// Version is the version tag of a devfile version
Version string
}
Version represents a version of a devfile
type VertexServerConfig ¶ added in v1.2.0
type VertexServerConfig struct {
Port int `json:"http.server.port,omitempty"`
}
VertexServerConfig represents the server config file for vertx applications
type VertxConf ¶ added in v1.2.0
type VertxConf struct {
Port int `json:"http.port,omitempty"`
ServerConfig VertexServerConfig `json:"http.server,omitempty"`
}
VertxConf represents the config file for vertx applications