mirror of https://github.com/helm/helm
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
87 lines
3.2 KiB
87 lines
3.2 KiB
/*
|
|
Copyright The Helm Authors.
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package chart
|
|
|
|
import "errors"
|
|
|
|
// Maintainer describes a Chart maintainer.
|
|
type Maintainer struct {
|
|
// Name is a user name or organization name
|
|
Name string `json:"name,omitempty"`
|
|
// Email is an optional email address to contact the named maintainer
|
|
Email string `json:"email,omitempty"`
|
|
// URL is an optional URL to an address for the named maintainer
|
|
URL string `json:"url,omitempty"`
|
|
}
|
|
|
|
// Metadata for a Chart file. This models the structure of a Chart.yaml file.
|
|
//
|
|
// Spec: https://helm.sh/helm/blob/master/docs/design/chart_format.md#the-chart-file
|
|
type Metadata struct {
|
|
// The name of the chart
|
|
Name string `json:"name,omitempty"`
|
|
// The URL to a relevant project page, git repo, or contact person
|
|
Home string `json:"home,omitempty"`
|
|
// Source is the URL to the source code of this chart
|
|
Sources []string `json:"sources,omitempty"`
|
|
// A SemVer 2 conformant version string of the chart
|
|
Version string `json:"version,omitempty"`
|
|
// A one-sentence description of the chart
|
|
Description string `json:"description,omitempty"`
|
|
// A list of string keywords
|
|
Keywords []string `json:"keywords,omitempty"`
|
|
// A list of name and URL/email address combinations for the maintainer(s)
|
|
Maintainers []*Maintainer `json:"maintainers,omitempty"`
|
|
// The URL to an icon file.
|
|
Icon string `json:"icon,omitempty"`
|
|
// The API Version of this chart.
|
|
APIVersion string `json:"apiVersion,omitempty"`
|
|
// The condition to check to enable chart
|
|
Condition string `json:"condition,omitempty"`
|
|
// The tags to check to enable chart
|
|
Tags string `json:"tags,omitempty"`
|
|
// The version of the application enclosed inside of this chart.
|
|
AppVersion string `json:"appVersion,omitempty"`
|
|
// Whether or not this chart is deprecated
|
|
Deprecated bool `json:"deprecated,omitempty"`
|
|
// Annotations are additional mappings uninterpreted by Helm,
|
|
// made available for inspection by other applications.
|
|
Annotations map[string]string `json:"annotations,omitempty"`
|
|
// KubeVersion is a SemVer constraint specifying the version of Kubernetes required.
|
|
KubeVersion string `json:"kubeVersion,omitempty"`
|
|
// Dependencies are a list of dependencies for a chart.
|
|
Dependencies []*Dependency `json:"dependencies,omitempty"`
|
|
// Specifies the chart type: application or library
|
|
Type string `json:"type,omitempty"`
|
|
}
|
|
|
|
func (md *Metadata) Validate() error {
|
|
if md == nil {
|
|
return errors.New("metadata is required")
|
|
}
|
|
if md.APIVersion == "" {
|
|
return errors.New("metadata apiVersion is required")
|
|
}
|
|
if md.Name == "" {
|
|
return errors.New("metadata name is required")
|
|
}
|
|
if md.Version == "" {
|
|
return errors.New("metadata version is required")
|
|
}
|
|
// TODO validate valid semver here?
|
|
return nil
|
|
}
|