Merge pull request #438 from silvin-lubecki/settings-to-parameters

Rename Settings to Parameters

Author: chris-crone

.gitignore

@@ -5,8 +5,9 @@
 *.dockerapp
 _build/
 bin/
-!examples/simple/*.dockerapp
+!examples/*/*.dockerapp
 !e2e/**/*.dockerapp
+!integrations/**/*.dockerapp
 .gradle
 coverage.html
 cover.out

README.md

@@ -41,9 +41,9 @@ hello.dockerapp
 ```
 
 We created a new file `hello.dockerapp` that contains three YAML documents:
-- metadatas
+- metadata
 - the Compose file
-- settings for your application
+- parameters for your application
 
 It should look like this:
 
@@ -69,7 +69,7 @@ services:
 {}
 ```
 
-Let's edit the settings section and add the following default values for our application:
+Let's edit the parameters section and add the following default values for our application:
 
 ```yaml
 port: 5678
@@ -113,7 +113,7 @@ You can then use that Compose file like any other. You could save it to disk or
 $ docker-app render | docker-compose -f - up
 ```
 
-This is where it gets interesting. We can override those settings at runtime, using the `--set` option. Let's specify different option and run `render` again:
+This is where it gets interesting. We can override those parameters at runtime, using the `--set` option. Let's specify different option and run `render` again:
 
 ```
 $ docker-app render --set version=0.2.3 --set port=4567 --set text="hello production"
@@ -131,7 +131,7 @@ services:
       protocol: tcp
 ```
 
-If you prefer you can create a standalone configuration file to store those settings. Let's create `prod.yml` with the following contents:
+If you prefer you can create a standalone configuration file to store those parameters. Let's create `prod.yml` with the following contents:
 
 ```yaml
 version: 0.2.3
@@ -164,7 +164,7 @@ cp docker-app-linux /usr/local/bin/docker-app
 
 If you prefer having the three core documents in separate YAML files, omit the `-s` / `--single-file` option to
 the `docker-app init` command. This will create a directory instead of a single file, containing
-`metadata.yml`, `docker-compose.yml` and `settings.yml`.
+`metadata.yml`, `docker-compose.yml` and `parameters.yml`.
 
 Converting between the two formats can be achieved by using the `docker-app split` and `docker-app merge` commands.
 
@@ -197,7 +197,7 @@ $ docker-app inspect myhubuser/hello
 
 We have lots of ideas for making Compose-based applications easier to share and reuse, and making applications a first-class part of the Docker toolchain. Please let us know what you think about this initial release and about any of the ideas below:
 
-* Introducing environments to the settings file
+* Introducing environments to the parameters file
 * Docker images which launch the application when run
 * Built-in commands for running applications
 * Saving required images into the application artifact to support offline installation
@@ -212,9 +212,10 @@ $ docker-app
 
 Usage:  docker-app [OPTIONS] COMMAND
 
-Docker Application Packages
+Build and deploy Docker Application Packages.
 
 Options:
+  -c, --context string     context to use to connect to the daemon (overrides host flag, DOCKER_HOST env var and default context set with "docker context use")
   -D, --debug              Enable debug mode
   -H, --host list          Daemon socket(s) to connect to
   -l, --log-level string   Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info")
@@ -229,7 +230,7 @@ Commands:
   completion  Generates completion scripts for the specified shell (bash or zsh)
   deploy      Deploy or update an application
   init        Start building a Docker application
-  inspect     Shows metadata, settings and a summary of the compose file for a given application
+  inspect     Shows metadata, parameters and a summary of the compose file for a given application
   merge       Merge a multi-file application into a single file
   push        Push the application to a registry
   render      Render the Compose file for the application

cmd/docker-app/deploy.go

@@ -19,7 +19,7 @@ import (
 
 type deployOptions struct {
 	deployComposeFiles     []string
-	deploySettingsFiles    []string
+	deployParametersFiles  []string
 	deployEnv              []string
 	deployOrchestrator     string
 	deployKubeConfig       string
@@ -42,8 +42,8 @@ func deployCmd(dockerCli command.Cli) *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringArrayVarP(&opts.deploySettingsFiles, "settings-files", "f", []string{}, "Override settings files")
-	cmd.Flags().StringArrayVarP(&opts.deployEnv, "set", "s", []string{}, "Override settings values")
+	cmd.Flags().StringArrayVarP(&opts.deployParametersFiles, "parameters-files", "f", []string{}, "Override with parameters from files")
+	cmd.Flags().StringArrayVarP(&opts.deployEnv, "set", "s", []string{}, "Override parameters values")
 	cmd.Flags().StringVarP(&opts.deployOrchestrator, "orchestrator", "o", "swarm", "Orchestrator to deploy on (swarm, kubernetes)")
 	cmd.Flags().StringVarP(&opts.deployKubeConfig, "kubeconfig", "k", "", "Kubernetes config file to use")
 	cmd.Flags().StringVarP(&opts.deployNamespace, "namespace", "n", "default", "Kubernetes namespace to deploy into")
@@ -57,7 +57,7 @@ func deployCmd(dockerCli command.Cli) *cobra.Command {
 
 func runDeploy(dockerCli command.Cli, flags *pflag.FlagSet, appname string, opts deployOptions) error {
 	app, err := packager.Extract(appname,
-		types.WithSettingsFiles(opts.deploySettingsFiles...),
+		types.WithParametersFiles(opts.deployParametersFiles...),
 		types.WithComposeFiles(opts.deployComposeFiles...),
 	)
 	if err != nil {

cmd/docker-app/image-add.go

@@ -13,9 +13,9 @@ import (
 )
 
 var (
-	imageAddComposeFiles []string
-	imageAddSettingsFile []string
-	imageAddEnv          []string
+	imageAddComposeFiles   []string
+	imageAddParametersFile []string
+	imageAddEnv            []string
 )
 
 func imageAddCmd() *cobra.Command {
@@ -29,7 +29,7 @@ subdirectory.`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			oappname := args[0]
 			app, err := packager.Extract(oappname,
-				types.WithSettingsFiles(imageAddSettingsFile...),
+				types.WithParametersFiles(imageAddParametersFile...),
 				types.WithComposeFiles(imageAddComposeFiles...),
 			)
 			if err != nil {
@@ -66,8 +66,8 @@ subdirectory.`,
 		},
 	}
 	if internal.Experimental == "on" {
-		cmd.Flags().StringArrayVarP(&imageAddComposeFiles, "compose-files", "c", []string{}, "Override Compose files")
-		cmd.Flags().StringArrayVarP(&imageAddSettingsFile, "settings-files", "s", []string{}, "Override settings files")
+		cmd.Flags().StringArrayVarP(&imageAddComposeFiles, "compose-files", "c", []string{}, "Override Compose file")
+		cmd.Flags().StringArrayVarP(&imageAddParametersFile, "parameters-files", "f", []string{}, "Override with parameters from files")
 		cmd.Flags().StringArrayVarP(&imageAddEnv, "env", "e", []string{}, "Override environment values")
 	}
 	return cmd

cmd/docker-app/inspect.go

@@ -11,29 +11,29 @@ import (
 )
 
 var (
-	inspectSettingsFile []string
-	inspectEnv          []string
+	inspectParametersFile []string
+	inspectEnv            []string
 )
 
 // inspectCmd represents the inspect command
 func inspectCmd(dockerCli command.Cli) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "inspect [<app-name>] [-s key=value...] [-f settings-file...]",
-		Short: "Shows metadata, settings and a summary of the compose file for a given application",
+		Use:   "inspect [<app-name>] [-s key=value...] [-f parameters-file...]",
+		Short: "Shows metadata, parameters and a summary of the compose file for a given application",
 		Args:  cli.RequiresMaxArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			app, err := packager.Extract(firstOrEmpty(args),
-				types.WithSettingsFiles(inspectSettingsFile...),
+				types.WithParametersFiles(inspectParametersFile...),
 			)
 			if err != nil {
 				return err
 			}
 			defer app.Cleanup()
-			argSettings := cliopts.ConvertKVStringsToMap(inspectEnv)
-			return inspect.Inspect(dockerCli.Out(), app, argSettings)
+			argParameters := cliopts.ConvertKVStringsToMap(inspectEnv)
+			return inspect.Inspect(dockerCli.Out(), app, argParameters)
 		},
 	}
-	cmd.Flags().StringArrayVarP(&inspectSettingsFile, "settings-files", "f", []string{}, "Override settings files")
-	cmd.Flags().StringArrayVarP(&inspectEnv, "set", "s", []string{}, "Override settings values")
+	cmd.Flags().StringArrayVarP(&inspectParametersFile, "parameters-files", "f", []string{}, "Override with parameters from files")
+	cmd.Flags().StringArrayVarP(&inspectEnv, "set", "s", []string{}, "Override parameters values")
 	return cmd
 }

cmd/docker-app/render.go

@@ -16,22 +16,22 @@ import (
 )
 
 var (
-	formatDriver       string
-	renderComposeFiles []string
-	renderSettingsFile []string
-	renderEnv          []string
-	renderOutput       string
+	formatDriver         string
+	renderComposeFiles   []string
+	renderParametersFile []string
+	renderEnv            []string
+	renderOutput         string
 )
 
 func renderCmd(dockerCli command.Cli) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "render <app-name> [-s key=value...] [-f settings-file...]",
+		Use:   "render <app-name> [-s key=value...] [-f parameters-file...]",
 		Short: "Render the Compose file for the application",
 		Long:  `Render the Compose file for the application.`,
 		Args:  cli.RequiresMaxArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			app, err := packager.Extract(firstOrEmpty(args),
-				types.WithSettingsFiles(renderSettingsFile...),
+				types.WithParametersFiles(renderParametersFile...),
 				types.WithComposeFiles(renderComposeFiles...),
 			)
 			if err != nil {
@@ -64,10 +64,10 @@ func renderCmd(dockerCli command.Cli) *cobra.Command {
 		cmd.Long += `- External Compose files or template Compose files can be specified with the -c flag.
   (Repeat the flag for multiple files). These files will be merged in order with
   the app's own Compose file.`
-		cmd.Flags().StringArrayVarP(&renderComposeFiles, "compose-files", "c", []string{}, "Override Compose files")
+		cmd.Flags().StringArrayVarP(&renderComposeFiles, "compose-files", "c", []string{}, "Override Compose file")
 	}
-	cmd.Flags().StringArrayVarP(&renderSettingsFile, "settings-files", "f", []string{}, "Override settings files")
-	cmd.Flags().StringArrayVarP(&renderEnv, "set", "s", []string{}, "Override settings values")
+	cmd.Flags().StringArrayVarP(&renderParametersFile, "parameters-files", "f", []string{}, "Override with parameters from files")
+	cmd.Flags().StringArrayVarP(&renderEnv, "set", "s", []string{}, "Override parameters values")
 	cmd.Flags().StringVarP(&renderOutput, "output", "o", "-", "Output file")
 	cmd.Flags().StringVar(&formatDriver, "formatter", "yaml", "Configure the output format (yaml|json)")
 	return cmd

cmd/docker-app/validate.go

@@ -10,29 +10,29 @@ import (
 )
 
 var (
-	validateSettingsFile []string
-	validateEnv          []string
+	validateParametersFile []string
+	validateEnv            []string
 )
 
 func validateCmd() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   "validate [<app-name>] [-s key=value...] [-f settings-file...]",
+		Use:   "validate [<app-name>] [-s key=value...] [-f parameters-file...]",
 		Short: "Checks the rendered application is syntactically correct",
 		Args:  cli.RequiresMaxArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			app, err := packager.Extract(firstOrEmpty(args),
-				types.WithSettingsFiles(validateSettingsFile...),
+				types.WithParametersFiles(validateParametersFile...),
 			)
 			if err != nil {
 				return err
 			}
 			defer app.Cleanup()
-			argSettings := cliopts.ConvertKVStringsToMap(validateEnv)
-			_, err = render.Render(app, argSettings)
+			argParameters := cliopts.ConvertKVStringsToMap(validateEnv)
+			_, err = render.Render(app, argParameters)
 			return err
 		},
 	}
-	cmd.Flags().StringArrayVarP(&validateSettingsFile, "settings-files", "f", []string{}, "Override settings files")
-	cmd.Flags().StringArrayVarP(&validateEnv, "set", "s", []string{}, "Override settings values")
+	cmd.Flags().StringArrayVarP(&validateParametersFile, "parameters-files", "f", []string{}, "Override with parameters from files")
+	cmd.Flags().StringArrayVarP(&validateEnv, "set", "s", []string{}, "Override parameters values")
 	return cmd
 }

e2e/commands_test.go

@@ -29,7 +29,7 @@ services:
   hello-world:
     image: hello-world
 ---
-# This section contains the default values for your application settings.`
+# This section contains the default values for your application parameters.`
 )
 
 func TestRenderTemplates(t *testing.T) {
@@ -59,14 +59,14 @@ func TestRender(t *testing.T) {
 
 func testRenderApp(appPath string, env ...string) func(*testing.T) {
 	return func(t *testing.T) {
-		envSettings := map[string]string{}
+		envParameters := map[string]string{}
 		data, err := ioutil.ReadFile(filepath.Join(appPath, "env.yml"))
 		assert.NilError(t, err)
-		assert.NilError(t, yaml.Unmarshal(data, &envSettings))
+		assert.NilError(t, yaml.Unmarshal(data, &envParameters))
 		args := []string{dockerApp, "render", filepath.Join(appPath, "my.dockerapp"),
-			"-f", filepath.Join(appPath, "settings-0.yml"),
+			"-f", filepath.Join(appPath, "parameters-0.yml"),
 		}
-		for k, v := range envSettings {
+		for k, v := range envParameters {
 			args = append(args, "-s", fmt.Sprintf("%s=%s", k, v))
 		}
 		result := icmd.RunCmd(icmd.Cmd{
@@ -130,7 +130,7 @@ maintainers:
 		fs.WithMode(0755),
 		fs.WithFile(internal.MetadataFileName, meta, fs.WithMode(0644)), // too many variables, cheating
 		fs.WithFile(internal.ComposeFileName, composeData, fs.WithMode(0644)),
-		fs.WithFile(internal.SettingsFileName, "NGINX_ARGS: FILL ME\nNGINX_VERSION: latest\n", fs.WithMode(0644)),
+		fs.WithFile(internal.ParametersFileName, "NGINX_ARGS: FILL ME\nNGINX_VERSION: latest\n", fs.WithMode(0644)),
 	)
 	assert.Assert(t, fs.Equal(dirName, manifest))
 

…tdata/attachments.dockerapp/settings.yml …ata/attachments.dockerapp/parameters.ymle2e/testdata/attachments.dockerapp/settings.yml renamed to e2e/testdata/attachments.dockerapp/parameters.yml e2e/testdata/attachments.dockerapp/settings.yml renamed to e2e/testdata/attachments.dockerapp/parameters.yml

@@ -6,8 +6,8 @@ Service (1) Replicas Ports Image
 ----------- -------- ----- -----
 test        1              alpine:latest
 
-Settings (4)         Value
-------------         -----
+Parameters (4)       Value
+--------------       -----
 myapp.alpine_version latest
 myapp.command1       cat
 myapp.command2       foo