func main() {
app := cli.NewApp()
app.Name = "helm"
app.Usage = `The Kubernetes package manager
To begin working with Helm, run the 'helm update' command:
$ helm update
This will download all of the necessary data. Common actions from this point
include:
- helm help COMMAND: see help for a specific command
- helm search: search for charts
- helm fetch: make a local working copy of a chart
- helm install: upload the chart to Kubernetes
For more information on Helm, go to http://helm.sh.
ENVIRONMENT:
$HELM_HOME: Set an alternative location for Helm files. By default, these
are stored in ~/.helm
`
app.Version = version
app.EnableBashCompletion = true
app.Flags = []cli.Flag{
cli.StringFlag{
Name: "home",
Value: "$HOME/.helm",
Usage: "The location of your Helm files",
EnvVar: "HELM_HOME",
},
cli.BoolFlag{
Name: "debug",
Usage: "Enable verbose debugging output",
},
}
app.CommandNotFound = func(c *cli.Context, command string) {
if action.HasPlugin(command) {
action.Plugin(home(c), command, c.Args())
return
}
log.Err("No matching command '%s'", command)
cli.ShowAppHelp(c)
log.Die("")
}
app.Commands = []cli.Command{
{
Name: "update",
Aliases: []string{"up"},
Usage: "Get the latest version of all Charts from GitHub.",
Description: `This will synchronize the local repository with the upstream GitHub project.
The local cached copy is stored in '~/.helm/cache' or (if specified)
'$HELM_HOME/cache'.
The first time 'helm update' is run, the necessary directory structures are
created and then the Git repository is pulled in full.
Subsequent calls to 'helm update' will simply synchronize the local cache
with the remote.`,
ArgsUsage: "",
Action: func(c *cli.Context) {
if !c.Bool("no-version-check") {
action.CheckLatest(version)
}
action.Update(home(c))
},
Flags: []cli.Flag{
cli.BoolFlag{
Name: "no-version-check",
Usage: "Disable Helm's automatic check for newer versions of itself.",
},
},
},
{
Name: "fetch",
Usage: "Fetch a Chart to your working directory.",
Description: `Copy a chart from the Chart repository to a local workspace.
From this point, the copied chart may be safely modified to your needs.
If an optional 'chart-name' is specified, the chart will be copied to a directory
of that name. For example, 'helm fetch nginx www' will copy the the contents of
the 'nginx' chart into a directory named 'www' in your workspace.
`,
ArgsUsage: "[chart] [chart-name]",
Action: fetch,
Flags: []cli.Flag{
cli.StringFlag{
Name: "namespace, n",
Value: "default",
Usage: "The Kubernetes destination namespace.",
},
},
},
{
Name: "remove",
Aliases: []string{"rm"},
Usage: "Remove one or more Charts from your working directory.",
ArgsUsage: "[chart-name] [...]",
Action: remove,
Flags: []cli.Flag{
cli.BoolFlag{
Name: "force",
Usage: "Remove Chart from working directory and leave packages installed.",
},
},
},
{
Name: "install",
Usage: "Install a named package into Kubernetes.",
Description: `If the given 'chart-name' is present in your workspace, it
will be uploaded into Kubernetes. If no chart named 'chart-name' is found in
your workspace, Helm will look for a chart with that name, install it into the
workspace, and then immediately upload it to Kubernetes.
When multiple charts are specified, Helm will attempt to install all of them,
following the resolution process described above.
As a special case, if the flag --chart-path is specified, Helm will look for a
Chart.yaml file and manifests/ directory at that path, and will install that
chart if found. In this case, you may not specify multiple charts at once.
`,
ArgsUsage: "[chart-name...]",
Action: install,
Flags: []cli.Flag{
cli.StringFlag{
Name: "namespace, n",
Value: "",
Usage: "The Kubernetes destination namespace.",
},
cli.BoolFlag{
Name: "force, aye-aye",
Usage: "Perform install even if dependencies are unsatisfied.",
},
cli.BoolFlag{
Name: "dry-run",
Usage: "Fetch the chart, but only display the underlying kubectl commands.",
},
},
},
{
Name: "uninstall",
Usage: "Uninstall a named package from Kubernetes.",
Description: `For each supplied 'chart-name', this will connect to Kubernetes
and remove all of the manifests specified.
This will not alter the charts in your workspace.
`,
ArgsUsage: "[chart-name...]",
Action: func(c *cli.Context) {
minArgs(c, 1, "uninstall")
for _, chart := range c.Args() {
action.Uninstall(chart, home(c), c.String("namespace"), c.Bool("force"))
}
},
Flags: []cli.Flag{
cli.StringFlag{
Name: "namespace, n",
Value: "",
Usage: "The Kubernetes destination namespace.",
},
cli.BoolFlag{
Name: "force, aye-aye, y",
Usage: "Do not ask for confirmation.",
},
},
},
{
Name: "create",
Usage: "Create a chart in the local workspace.",
Description: `This will scaffold a new chart named 'chart-name' in your
local workdir. To edit the resulting chart, you may edit the files directly or
use the 'helm edit' command.
`,
ArgsUsage: "[chart-name]",
Action: func(c *cli.Context) {
minArgs(c, 1, "create")
action.Create(c.Args()[0], home(c))
},
},
{
Name: "edit",
Usage: "Edit a named chart in the local workspace.",
Description: `Existing charts in the workspace can be edited using this command.
'helm edit' will open all of the chart files in a single editor (as specified
by the $EDITOR environment variable).
`,
ArgsUsage: "[chart-name]",
Action: func(c *cli.Context) {
minArgs(c, 1, "edit")
action.Edit(c.Args()[0], home(c))
},
},
{
Name: "publish",
Usage: "Publish a named chart to the git checkout.",
Description: `This copies a chart from the workdir into the cache. Doing so
is the first stage of contributing a chart upstream.
`,
ArgsUsage: "[chart-name]",
Action: func(c *cli.Context) {
minArgs(c, 1, "publish")
action.Publish(c.Args()[0], home(c), c.Bool("force"))
},
Flags: []cli.Flag{
cli.BoolFlag{
Name: "force, f",
Usage: "Force publish over an existing chart.",
},
},
},
{
Name: "list",
Usage: "List all fetched packages.",
Description: `This prints all of the packages that are currently installed in
the workspace. Packages are printed by the local name.
`,
ArgsUsage: "",
Action: func(c *cli.Context) {
action.List(home(c))
},
},
{
Name: "search",
Usage: "Search for a package.",
Description: `This provides a simple interface for searching the chart cache
for charts matching a given pattern.
If no string is provided, or if the special string '*' is provided, this will
list all available charts.
`,
ArgsUsage: "[string]",
Action: search,
},
{
Name: "info",
Usage: "Print information about a Chart.",
ArgsUsage: "[string]",
Flags: []cli.Flag{
cli.StringFlag{
Name: "format",
Usage: "Print using a Go template",
},
},
Action: func(c *cli.Context) {
minArgs(c, 1, "info")
action.Info(c.Args()[0], home(c), c.String("format"))
},
},
{
Name: "target",
Usage: "Displays information about cluster.",
ArgsUsage: "",
Action: func(c *cli.Context) {
action.Target()
},
},
{
Name: "home",
Usage: "Displays the location of the Helm home.",
ArgsUsage: "",
Action: func(c *cli.Context) {
log.Msg(home(c))
},
},
{
Name: "repo",
Aliases: []string{"repository"},
Usage: "Work with other Chart repositories.",
Subcommands: []cli.Command{
{
Name: "add",
Usage: "Add a remote chart repository.",
ArgsUsage: "[name] [git url]",
Action: func(c *cli.Context) {
minArgs(c, 2, "add")
a := c.Args()
action.AddRepo(home(c), a[0], a[1])
},
},
{
Name: "list",
Usage: "List all remote chart repositories.",
Action: func(c *cli.Context) {
action.ListRepos(home(c))
},
},
{
Name: "remove",
Aliases: []string{"rm"},
Usage: "Remove a remote chart repository.",
ArgsUsage: "[name] [git url]",
Action: func(c *cli.Context) {
minArgs(c, 1, "remove")
action.DeleteRepo(home(c), c.Args()[0])
},
},
},
},
}
app.Before = func(c *cli.Context) error {
log.IsDebugging = c.Bool("debug")
return nil
}
app.Run(os.Args)
}
// Search looks for packages with 'term' in their name.
func Search(term, homedir string) {
charts, err := searchAll(term, homedir)
if err != nil {
log.Die(err.Error())
}
if len(charts) > 0 {
for _, name := range sortedIndex(charts) {
chart := charts[name]
log.Msg("\t%s (%s %s) - %s", name, chart.Name, chart.Version, chart.Description)
}
} else {
log.Msg("No chart found for \"%s\".", term)
}
}
// Fetch gets a chart from the source repo and copies to the workdir.
//
// - chartName is the source
// - lname is the local name for that chart (chart-name); if blank, it is set to the chart.
// - homedir is the home directory for the user
func Fetch(chartName, lname, homedir string) {
r := mustConfig(homedir).Repos
repository, chartName := r.RepoChart(chartName)
if lname == "" {
lname = chartName
}
fetch(chartName, lname, homedir, repository)
chartFilePath := helm.WorkspaceChartDirectory(homedir, lname, Chartfile)
cfile, err := chart.LoadChartfile(chartFilePath)
if err != nil {
log.Die("Source is not a valid chart. Missing Chart.yaml: %s", err)
}
deps, err := dependency.Resolve(cfile, helm.WorkspaceChartDirectory(homedir))
if err != nil {
log.Warn("Could not check dependencies: %s", err)
return
}
if len(deps) > 0 {
log.Warn("Unsatisfied dependencies:")
for _, d := range deps {
log.Msg("\t%s %s", d.Name, d.Version)
}
}
log.Info("Fetched chart into workspace %s", helm.WorkspaceChartDirectory(homedir, lname))
log.Info("Done")
}
// Target displays information about the cluster
func Target(client kubectl.Runner) {
out, err := client.ClusterInfo()
if err != nil {
log.Err(err.Error())
}
log.Msg(string(out))
}
// AltInstall allows loading a chart from the current directory.
//
// It does not directly support chart tables (repos).
func AltInstall(chartName, cachedir, home, namespace string, force bool, dryRun bool) {
// Make sure there is a chart in the cachedir.
if _, err := os.Stat(filepath.Join(cachedir, "Chart.yaml")); err != nil {
log.Die("Expected a Chart.yaml in %s: %s", cachedir, err)
}
// Make sure there is a manifests dir.
if fi, err := os.Stat(filepath.Join(cachedir, "manifests")); err != nil {
log.Die("Expected 'manifests/' in %s: %s", cachedir, err)
} else if !fi.IsDir() {
log.Die("Expected 'manifests/' to be a directory in %s: %s", cachedir, err)
}
dest := filepath.Join(home, WorkspaceChartPath, chartName)
if ok, err := isSamePath(dest, cachedir); err != nil || ok {
log.Die("Cannot read from and write to the same place: %s. %v", cachedir, err)
}
// Copy the source chart to the workspace. We ruthlessly overwrite in
// this case.
if err := copyDir(cachedir, dest); err != nil {
log.Die("Failed to copy %s to %s: %s", cachedir, dest, err)
}
// Load the chart.
c, err := chart.Load(dest)
if err != nil {
log.Die("Failed to load chart: %s", err)
}
// Give user the option to bale if dependencies are not satisfied.
nope, err := dependency.Resolve(c.Chartfile, filepath.Join(home, WorkspaceChartPath))
if err != nil {
log.Warn("Failed to check dependencies: %s", err)
if !force {
log.Die("Re-run with --force to install anyway.")
}
} else if len(nope) > 0 {
log.Warn("Unsatisfied dependencies:")
for _, d := range nope {
log.Msg("\t%s %s", d.Name, d.Version)
}
if !force {
log.Die("Stopping install. Re-run with --force to install anyway.")
}
}
msg := "Running `kubectl create -f` ..."
if dryRun {
msg = "Performing a dry run of `kubectl create -f` ..."
}
log.Info(msg)
if err := uploadManifests(c, namespace, dryRun); err != nil {
log.Die("Failed to upload manifests: %s", err)
}
}
// ListRepos lists the repositories.
func ListRepos(homedir string) {
rf := mustConfig(homedir).Repos
for _, t := range rf.Tables {
n := t.Name
if t.Name == rf.Default {
n += "*"
}
log.Msg("\t%s\t%s", n, t.Repo)
}
}
// PrintREADME prints the README file (if it exists) to the console.
func PrintREADME(chart, home string) {
p := filepath.Join(home, WorkspaceChartPath, chart, "README.*")
files, err := filepath.Glob(p)
if err != nil || len(files) == 0 {
// No README. Skip.
log.Debug("No readme in %s", p)
return
}
f, err := os.Open(files[0])
if err != nil {
log.Warn("Could not read README: %s", err)
return
}
log.Msg(strings.Repeat("=", 40))
io.Copy(log.Stdout, f)
log.Msg(strings.Repeat("=", 40))
f.Close()
}
// uploadManifests sends manifests to Kubectl in a particular order.
func uploadManifests(c *chart.Chart, namespace string, client kubectl.Runner) error {
// Install known kinds in a predictable order.
for _, k := range InstallOrder {
for _, m := range c.Kind[k] {
o := m.VersionedObject
o.AddAnnotations(map[string]string{
chart.AnnFile: m.Source,
chart.AnnChartVersion: c.Chartfile.Version,
chart.AnnChartDesc: c.Chartfile.Description,
chart.AnnChartName: c.Chartfile.Name,
})
var data []byte
var err error
if data, err = o.JSON(); err != nil {
return err
}
log.Debug("File: %s", string(data))
out, err := client.Create(data, namespace)
log.Msg(string(out))
if err != nil {
return err
}
}
}
// Install unknown kinds afterward. Order here is not predictable.
for _, k := range c.UnknownKinds(InstallOrder) {
for _, o := range c.Kind[k] {
o.VersionedObject.AddAnnotations(map[string]string{chart.AnnFile: o.Source})
out, err := marshalAndCreate(o.VersionedObject, namespace, client)
log.Msg(string(out))
if err != nil {
return err
}
}
}
return nil
}
func uninstallKind(kind []*manifest.Manifest, ns, ktype string, dry bool, client kubectl.Runner) {
for _, o := range kind {
if dry {
log.Msg("%s/%s", ktype, o.Name)
} else {
out, err := client.Delete(o.Name, ktype, ns)
if err != nil {
log.Warn("Could not delete %s %s (Skipping): %s", ktype, o.Name, err)
}
log.Info(string(out))
}
}
}
// Install loads a chart into Kubernetes.
//
// If the chart is not found in the workspace, it is fetched and then installed.
//
// During install, manifests are sent to Kubernetes in the ordered specified by InstallOrder.
func Install(chartName, home, namespace string, force bool, generate bool, exclude []string, client kubectl.Runner) {
ochart := chartName
r := mustConfig(home).Repos
table, chartName := r.RepoChart(chartName)
if !chartFetched(chartName, home) {
log.Info("No chart named %q in your workspace. Fetching now.", ochart)
fetch(chartName, chartName, home, table)
}
cd := helm.WorkspaceChartDirectory(home, chartName)
c, err := chart.Load(cd)
if err != nil {
log.Die("Failed to load chart: %s", err)
}
// Give user the option to bale if dependencies are not satisfied.
nope, err := dependency.Resolve(c.Chartfile, helm.WorkspaceChartDirectory(home))
if err != nil {
log.Warn("Failed to check dependencies: %s", err)
if !force {
log.Die("Re-run with --force to install anyway.")
}
} else if len(nope) > 0 {
log.Warn("Unsatisfied dependencies:")
for _, d := range nope {
log.Msg("\t%s %s", d.Name, d.Version)
}
if !force {
log.Die("Stopping install. Re-run with --force to install anyway.")
}
}
// Run the generator if -g is set.
if generate {
Generate(chartName, home, exclude)
}
CheckKubePrereqs()
log.Info("Running `kubectl create -f` ...")
if err := uploadManifests(c, namespace, client); err != nil {
log.Die("Failed to upload manifests: %s", err)
}
log.Info("Done")
PrintREADME(chartName, home)
}
// Install loads a chart into Kubernetes.
//
// If the chart is not found in the workspace, it is fetched and then installed.
//
// During install, manifests are sent to Kubernetes in the following order:
//
// - Namespaces
// - Secrets
// - Volumes
// - Services
// - Pods
// - ReplicationControllers
func Install(chartName, home, namespace string, force bool, dryRun bool) {
ochart := chartName
r := mustConfig(home).Repos
table, chartName := r.RepoChart(chartName)
if !chartFetched(chartName, home) {
log.Info("No chart named %q in your workspace. Fetching now.", ochart)
fetch(chartName, chartName, home, table)
}
cd := filepath.Join(home, WorkspaceChartPath, chartName)
c, err := chart.Load(cd)
if err != nil {
log.Die("Failed to load chart: %s", err)
}
// Give user the option to bale if dependencies are not satisfied.
nope, err := dependency.Resolve(c.Chartfile, filepath.Join(home, WorkspaceChartPath))
if err != nil {
log.Warn("Failed to check dependencies: %s", err)
if !force {
log.Die("Re-run with --force to install anyway.")
}
} else if len(nope) > 0 {
log.Warn("Unsatisfied dependencies:")
for _, d := range nope {
log.Msg("\t%s %s", d.Name, d.Version)
}
if !force {
log.Die("Stopping install. Re-run with --force to install anyway.")
}
}
msg := "Running `kubectl create -f` ..."
if dryRun {
msg = "Performing a dry run of `kubectl create -f` ..."
}
log.Info(msg)
if err := uploadManifests(c, namespace, dryRun); err != nil {
log.Die("Failed to upload manifests: %s", err)
}
log.Info("Done")
PrintREADME(chartName, home)
}
// printSummary prints a diff of charts after upate
func printSummary(diff string) {
if len(diff) == 0 {
log.Msg("Already up-to-date.")
return
}
s := make(repoSummary)
// parse git diff-tree
for _, line := range strings.Split(diff, "\n") {
kv := strings.Split(line, "\t")
st, chart := kv[0], kv[1]
s.add(st, chart)
}
// width of columns
colwidth := 29
// get console width
maxwidth := 118
if w, _, err := terminal.GetSize(int(os.Stdout.Fd())); err == nil {
maxwidth = w
}
// print results
for st, charts := range s {
switch st {
case "A":
log.Msg("Added %d charts", len(charts))
case "D":
log.Msg("Sent %d charts to the depths", len(charts))
case "M":
log.Msg("Updated %d charts", len(charts))
}
line := ""
for _, ch := range charts {
// if adding this column passes the max
// print and reset to zero
if len(line)+colwidth > maxwidth {
log.Msg(line)
line = ""
}
// append to line with padding
line = fmt.Sprintf("%s%-29s", line, ch)
}
log.Msg(line)
}
}
// Search looks for packages with 'term' in their name.
func Search(term, homedir string, regexp bool) {
cfg := mustConfig(homedir)
cdir := helm.CacheDirectory(homedir)
i := search.NewIndex(cfg, cdir)
res, err := i.Search(term, 5, regexp)
if err != nil {
log.Die("Failed to search: %s", err)
}
if len(res) == 0 {
log.Err("No results found. Try using '--regexp'.")
return
}
search.SortScore(res)
for _, r := range res {
c, _ := i.Chart(r.Name)
log.Msg("%s - %s", r.Name, c.Description)
}
}
func deleteChart(c *chart.Chart, ns string, dry bool) error {
// We delete charts in the ALMOST reverse order that we created them. We
// start with services to effectively shut down traffic.
ktype := "service"
for _, o := range c.Services {
if dry {
log.Msg("%s/%s", ktype, o.Name)
} else if err := kubectlDelete(o.Name, ktype, ns); err != nil {
log.Warn("Could not delete %s %s (Skipping): %s", ktype, o.Name, err)
}
}
ktype = "pod"
for _, o := range c.Pods {
if dry {
log.Msg("%s/%s", ktype, o.Name)
} else if err := kubectlDelete(o.Name, ktype, ns); err != nil {
log.Warn("Could not delete %s %s (Skipping): %s", ktype, o.Name, err)
}
}
ktype = "rc"
for _, o := range c.ReplicationControllers {
if dry {
log.Msg("%s/%s", ktype, o.Name)
} else if err := kubectlDelete(o.Name, ktype, ns); err != nil {
log.Warn("Could not delete %s %s (Skipping): %s", ktype, o.Name, err)
}
}
ktype = "secret"
for _, o := range c.Secrets {
if dry {
log.Msg("%s/%s", ktype, o.Name)
} else if err := kubectlDelete(o.Name, ktype, ns); err != nil {
log.Warn("Could not delete %s %s (Skipping): %s", ktype, o.Name, err)
}
}
ktype = "persistentvolume"
for _, o := range c.PersistentVolumes {
if dry {
log.Msg("%s/%s", ktype, o.Name)
} else if err := kubectlDelete(o.Name, ktype, ns); err != nil {
log.Warn("Could not delete %s %s (Skipping): %s", ktype, o.Name, err)
}
}
ktype = "serviceaccount"
for _, o := range c.ServiceAccounts {
if err := kubectlDelete(o.Name, ktype, ns); err != nil {
log.Warn("Could not delete %s %s (Skipping): %s", ktype, o.Name, err)
}
}
ktype = "namespace"
for _, o := range c.Namespaces {
if dry {
log.Msg("%s/%s", ktype, o.Name)
} else if err := kubectlDelete(o.Name, ktype, ns); err != nil {
log.Warn("Could not delete %s %s (Skipping): %s", ktype, o.Name, err)
}
}
return nil
}
package cli
import (
"github.com/codegangsta/cli"
"github.com/helm/helm/log"
)
var homeCmd = cli.Command{
Name: "home",
Usage: "Displays the location of the Helm home.",
ArgsUsage: "",
Action: func(c *cli.Context) {
log.Msg(home(c))
},
}