Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up kompose help, remove support for unimplemented commands #83

Merged
merged 1 commit into from
Aug 4, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Build Status](https://travis-ci.org/skippbox/kompose.svg?branch=master)](https://travis-ci.org/skippbox/kompose) [![Join us on Slack](https://s3.eu-central-1.amazonaws.com/ngtuna/join-us-on-slack.png)](https://skippbox.herokuapp.com)

`kompose` is a tool to help users familiar with `docker-compose` move to [Kubernetes](http://kubernetes.io). It takes a Docker Compose file and translates it into Kubernetes objects, it can then submit those objects to a Kubernetes endpoint with the `kompose up` command.
`kompose` is a tool to help users familiar with `docker-compose` move to [Kubernetes](http://kubernetes.io). It takes a Docker Compose file and translates it into Kubernetes objects.

`kompose` is a convenience tool to go from local Docker development to managing your application with Kubernetes. We don't assume that the transformation from docker compose format to Kubernetes API objects will be perfect, but it helps tremendously to start _Kubernetizing_ your application.

Expand Down
14 changes: 2 additions & 12 deletions cli/command/command.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import (
func ConvertCommand() cli.Command {
return cli.Command{
Name: "convert",
Usage: fmt.Sprintf("Convert %s to Kubernetes objects", app.DefaultComposeFile),
Usage: fmt.Sprintf("Convert Docker Compose file (e.g. %s) to Kubernetes objects", app.DefaultComposeFile),
Action: func(c *cli.Context) {
app.Convert(c)
},
Expand Down Expand Up @@ -165,15 +165,5 @@ func ScaleCommand() cli.Command {

// CommonFlags defines the flags that are in common for all subcommands.
func CommonFlags() []cli.Flag {
return []cli.Flag{
cli.BoolFlag{
Name: "verbose,debug",
},
cli.StringFlag{
Name: "file,f",
Usage: "Specify an alternate compose file (default: docker-compose.yml)",
Value: "docker-compose.yml",
EnvVar: "COMPOSE_FILE",
},
}
return []cli.Flag{}
}
13 changes: 7 additions & 6 deletions cli/main/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,20 @@ import (
func main() {
app := cli.NewApp()
app.Name = "kompose"
app.Usage = "Command line interface for Skippbox."
app.Usage = "A tool helping Docker Compose users move to Kubernetes."
app.Version = version.VERSION + " (" + version.GITCOMMIT + ")"
app.Author = "Skippbox Compose Contributors"
app.Author = "Skippbox Kompose Contributors"
app.Email = "https://github.com/skippbox/kompose"
app.EnableBashCompletion = true
app.Before = cliApp.BeforeApp
app.Flags = append(command.CommonFlags())
app.Commands = []cli.Command{
command.ConvertCommand(),
command.UpCommand(),
command.PsCommand(),
command.DeleteCommand(),
command.ScaleCommand(),
// TODO: enable these commands and update docs once we fix them
//command.UpCommand(),
//command.PsCommand(),
//command.DeleteCommand(),
//command.ScaleCommand(),
}

app.Run(os.Args)
Expand Down