Documentation
¶
Index ¶
- Constants
- Variables
- type Chart
- func (c Chart) Changelog() string
- func (c *Chart) Condition(source string) (bool, error)
- func (c *Chart) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)
- func (c *Chart) DependencyUpdate(out *bytes.Buffer, chartPath string) error
- func (c *Chart) GetRepoIndexFile() (repo.IndexFile, error)
- func (c *Chart) MetadataUpdate(chartPath string, dryRun bool) error
- func (c *Chart) RequirementsUpdate(chartPath string) error
- func (c *Chart) Source(workingDir string) (string, error)
- func (c *Chart) Target(source string, dryRun bool) (changed bool, err error)
- func (c *Chart) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (changed bool, files []string, message string, err error)
- func (c *Chart) ValidateTarget() error
- type Spec
Constants ¶
const ( // CHANGELOGTEMPLATE contains helm chart changelog information CHANGELOGTEMPLATE string = `` /* 618-byte string literal not displayed */ // MINORVERSION defines minor version identifier MINORVERSION = "minor" // MAJORVERSION defines major version identifier MAJORVERSION = "major" // PATCHVERSION defines patch version identifier PATCHVERSION = "patch" )
Variables ¶
var ( // ErrWrongConfig is returned in case of a wrong configuration ErrWrongConfig = errors.New("wrong helm configuration") )
Functions ¶
This section is empty.
Types ¶
type Chart ¶
type Chart struct {
// contains filtered or unexported fields
}
Chart defines a resource of kind "helmchart"
func New ¶
New returns a reference to a newly initialized Chart object from a Spec or an error if the provided YamlSpec triggers a validation error.
func (*Chart) ConditionFromSCM ¶
ConditionFromSCM returns an error because it's not supported
func (*Chart) DependencyUpdate ¶ added in v0.25.0
DependencyUpdate ensures that Chart.lock is updated if needed
func (*Chart) GetRepoIndexFile ¶ added in v0.25.0
GetRepoIndexFile loads an index file and does minimal validity checking. This will fail if API Version is not set (ErrNoAPIVersion) or if the unmarshal fails.
func (*Chart) MetadataUpdate ¶ added in v0.25.0
MetadataUpdate updates a metadata if necessary and it bump the ChartVersion
func (*Chart) RequirementsUpdate ¶ added in v0.25.0
RequirementsUpdate test if we are updating the file requirements.yaml if it's the case then we also have to delete and recreate the file requirements.lock
func (*Chart) Target ¶
Target updates helm chart, it receives the default source value and a dryrun flag then return if it changed something or failed
func (*Chart) TargetFromSCM ¶
func (c *Chart) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) ( changed bool, files []string, message string, err error)
TargetFromSCM updates helm chart then push changed to a scm, it receives the default source value and dryrun flag then return if it changed something or failed
func (*Chart) ValidateTarget ¶
ValidateTarget ensure that target required parameter are set
type Spec ¶
type Spec struct {
File string // [target] Define file to update
Key string // [target] Define Key to update
Name string // [source][condition][target] Define Chart name path like "stable/chart"
URL string // [source][condition] Define the chart location
Value string // [target] Define value to set
Version string // [source][condition]
VersionIncrement string // [target] Define the rule to incremental the Chart version, accept a list of rules
AppVersion bool // [target] Boolean that define we must update the App Version
}
Spec defines a specification for an "helmchart" resource parsed from an updatecli manifest file
Source Files