Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( FlavorKubernetes string = "kubernetes" FlavorProw string = "prow" )
View Source
var ( // DefaultKubernetesFiles specifies accepted Kubernetes files DefaultKubernetesFiles []string = []string{"*.yaml", "*.yml"} )
Functions ¶
This section is empty.
Types ¶
type Kubernetes ¶
type Kubernetes struct {
// contains filtered or unexported fields
}
Kubernetes holds all information needed to generate Kubernetes manifests.
func New ¶
func New(spec interface{}, rootDir, scmID, actionID, flavor string) (Kubernetes, error)
New return a new valid Kubernetes object.
func (Kubernetes) DiscoverManifests ¶
func (k Kubernetes) DiscoverManifests() ([][]byte, error)
type MatchingRule ¶
type MatchingRule struct {
// Path specifies a Fleet bundle path pattern, the pattern requires to match all of name, not just a subpart of the path.
Path string
// Images specifies the list of container image to check
Images []string
}
MatchingRule allows to specifies rules to identify manifest
type MatchingRules ¶
type MatchingRules []MatchingRule
type Spec ¶
type Spec struct {
// Auths provides a map of registry credentials where the key is the registry URL without scheme
Auths map[string]docker.InlineKeyChain `yaml:",omitempty"`
/*
digest provides parameters to specify if the generated manifest should use a digest on top of the tag.
*/
Digest *bool `yaml:",omitempty"`
/* Files allows to specify a list of Files to analyze.
The pattern syntax is:
pattern:
{ term }
term:
'*' matches any sequence of non-Separator characters
'?' matches any single non-Separator character
'[' [ '^' ] { character-range } ']' character class (must be non-empty)
c matches character c (c != '*', '?', '\\', '[')
'\\' c matches character c
character-range:
c matches character c (c != '\\', '-', ']')
'\\' c matches character c
lo '-' hi matches character c for lo <= c <= hi
Match requires pattern to match all of name, not just a substring.
The only possible returned error is ErrBadPattern, when pattern
is malformed.
On Windows, escaping is disabled. Instead, '\\' is treated as
path separator.
*/
Files []string `yaml:",omitempty"`
// RootDir defines the root directory used to recursively search for Kubernetes files
RootDir string `yaml:",omitempty"`
// Ignore allows to specify rule to ignore autodiscovery a specific Kubernetes manifest based on a rule
Ignore MatchingRules `yaml:",omitempty"`
// Only allows to specify rule to only autodiscover manifest for a specific Kubernetes manifest based on a rule
Only MatchingRules `yaml:",omitempty"`
/*
versionfilter provides parameters to specify the version pattern used when generating manifest.
kind - semver
versionfilter of kind `semver` uses semantic versioning as version filtering
pattern accepts one of:
`patch` - patch only update patch version
`minor` - minor only update minor version
`major` - major only update major versions
`a version constraint` such as `>= 1.0.0`
kind - regex
versionfilter of kind `regex` uses regular expression as version filtering
pattern accepts a valid regular expression
example:
“`
versionfilter:
kind: semver
pattern: minor
“`
and its type like regex, semver, or just latest.
*/
VersionFilter version.Filter `yaml:",omitempty"`
}
Spec defines the parameters which can be provided to the Kubernetes builder.
Click to show internal directories.
Click to hide internal directories.