2018-11-09 09:10:41 -05:00
|
|
|
package context
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"fmt"
|
|
|
|
|
|
|
|
"github.com/docker/cli/cli"
|
|
|
|
"github.com/docker/cli/cli/command"
|
2022-05-12 07:18:48 -04:00
|
|
|
"github.com/docker/cli/cli/command/completion"
|
2022-04-25 06:00:55 -04:00
|
|
|
"github.com/docker/cli/cli/command/formatter/tabwriter"
|
2018-11-09 09:10:41 -05:00
|
|
|
"github.com/docker/cli/cli/context/docker"
|
|
|
|
"github.com/docker/cli/cli/context/store"
|
2022-09-28 16:18:51 -04:00
|
|
|
"github.com/docker/docker/errdefs"
|
2018-11-09 09:10:41 -05:00
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
)
|
|
|
|
|
2019-01-21 03:37:20 -05:00
|
|
|
// CreateOptions are the options used for creating a context
|
|
|
|
type CreateOptions struct {
|
2021-06-16 03:08:42 -04:00
|
|
|
Name string
|
|
|
|
Description string
|
|
|
|
Docker map[string]string
|
|
|
|
From string
|
2018-11-09 09:10:41 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
func longCreateDescription() string {
|
|
|
|
buf := bytes.NewBuffer(nil)
|
|
|
|
buf.WriteString("Create a context\n\nDocker endpoint config:\n\n")
|
|
|
|
tw := tabwriter.NewWriter(buf, 20, 1, 3, ' ', 0)
|
|
|
|
fmt.Fprintln(tw, "NAME\tDESCRIPTION")
|
|
|
|
for _, d := range dockerConfigKeysDescriptions {
|
|
|
|
fmt.Fprintf(tw, "%s\t%s\n", d.name, d.description)
|
|
|
|
}
|
|
|
|
tw.Flush()
|
|
|
|
buf.WriteString("\nExample:\n\n$ docker context create my-context --description \"some description\" --docker \"host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file\"\n")
|
|
|
|
return buf.String()
|
|
|
|
}
|
|
|
|
|
2023-11-20 11:38:50 -05:00
|
|
|
func newCreateCommand(dockerCLI command.Cli) *cobra.Command {
|
2019-01-21 03:37:20 -05:00
|
|
|
opts := &CreateOptions{}
|
2018-11-09 09:10:41 -05:00
|
|
|
cmd := &cobra.Command{
|
|
|
|
Use: "create [OPTIONS] CONTEXT",
|
|
|
|
Short: "Create a context",
|
|
|
|
Args: cli.ExactArgs(1),
|
|
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
2019-01-21 03:37:20 -05:00
|
|
|
opts.Name = args[0]
|
2023-11-20 11:38:50 -05:00
|
|
|
return RunCreate(dockerCLI, opts)
|
2018-11-09 09:10:41 -05:00
|
|
|
},
|
2022-05-12 07:18:48 -04:00
|
|
|
Long: longCreateDescription(),
|
|
|
|
ValidArgsFunction: completion.NoComplete,
|
2018-11-09 09:10:41 -05:00
|
|
|
}
|
|
|
|
flags := cmd.Flags()
|
2019-01-21 03:37:20 -05:00
|
|
|
flags.StringVar(&opts.Description, "description", "", "Description of the context")
|
|
|
|
flags.StringToStringVar(&opts.Docker, "docker", nil, "set the docker endpoint")
|
2019-03-22 10:20:40 -04:00
|
|
|
flags.StringVar(&opts.From, "from", "", "create context from a named context")
|
2018-11-09 09:10:41 -05:00
|
|
|
return cmd
|
|
|
|
}
|
|
|
|
|
2019-01-21 03:37:20 -05:00
|
|
|
// RunCreate creates a Docker context
|
2023-11-20 11:38:50 -05:00
|
|
|
func RunCreate(dockerCLI command.Cli, o *CreateOptions) error {
|
|
|
|
s := dockerCLI.ContextStore()
|
2022-02-22 07:46:35 -05:00
|
|
|
err := checkContextNameForCreation(s, o.Name)
|
2018-11-09 09:10:41 -05:00
|
|
|
if err != nil {
|
2022-02-22 07:46:35 -05:00
|
|
|
return err
|
2018-11-09 09:10:41 -05:00
|
|
|
}
|
2019-05-13 11:22:02 -04:00
|
|
|
switch {
|
2022-02-24 06:59:15 -05:00
|
|
|
case o.From == "" && o.Docker == nil:
|
2023-11-20 11:38:50 -05:00
|
|
|
err = createFromExistingContext(s, dockerCLI.CurrentContext(), o)
|
2019-05-13 11:22:02 -04:00
|
|
|
case o.From != "":
|
2022-02-22 07:46:35 -05:00
|
|
|
err = createFromExistingContext(s, o.From, o)
|
2019-05-13 11:22:02 -04:00
|
|
|
default:
|
2023-06-20 07:36:54 -04:00
|
|
|
err = createNewContext(s, o)
|
2019-05-13 11:22:02 -04:00
|
|
|
}
|
|
|
|
if err == nil {
|
2023-11-20 11:38:50 -05:00
|
|
|
fmt.Fprintln(dockerCLI.Out(), o.Name)
|
|
|
|
fmt.Fprintf(dockerCLI.Err(), "Successfully created context %q\n", o.Name)
|
2019-05-13 11:22:02 -04:00
|
|
|
}
|
|
|
|
return err
|
2019-03-22 10:20:40 -04:00
|
|
|
}
|
|
|
|
|
2023-06-20 07:36:54 -04:00
|
|
|
func createNewContext(contextStore store.ReaderWriter, o *CreateOptions) error {
|
2019-01-21 03:37:20 -05:00
|
|
|
if o.Docker == nil {
|
2018-11-09 09:10:41 -05:00
|
|
|
return errors.New("docker endpoint configuration is required")
|
|
|
|
}
|
2023-06-20 07:36:54 -04:00
|
|
|
dockerEP, dockerTLS, err := getDockerEndpointMetadataAndTLS(contextStore, o.Docker)
|
2018-11-09 09:10:41 -05:00
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "unable to create docker endpoint config")
|
|
|
|
}
|
2022-03-30 13:05:21 -04:00
|
|
|
contextMetadata := store.Metadata{
|
|
|
|
Endpoints: map[string]interface{}{
|
|
|
|
docker.DockerEndpoint: dockerEP,
|
|
|
|
},
|
|
|
|
Metadata: command.DockerContext{
|
|
|
|
Description: o.Description,
|
|
|
|
},
|
|
|
|
Name: o.Name,
|
|
|
|
}
|
|
|
|
contextTLSData := store.ContextTLSData{}
|
2018-11-09 09:10:41 -05:00
|
|
|
if dockerTLS != nil {
|
2022-03-30 13:05:21 -04:00
|
|
|
contextTLSData.Endpoints = map[string]store.EndpointTLSData{
|
|
|
|
docker.DockerEndpoint: *dockerTLS,
|
|
|
|
}
|
2018-11-09 09:10:41 -05:00
|
|
|
}
|
2022-02-22 07:46:35 -05:00
|
|
|
if err := validateEndpoints(contextMetadata); err != nil {
|
2018-11-09 09:10:41 -05:00
|
|
|
return err
|
|
|
|
}
|
2023-06-20 07:36:54 -04:00
|
|
|
if err := contextStore.CreateOrUpdate(contextMetadata); err != nil {
|
2018-11-09 09:10:41 -05:00
|
|
|
return err
|
|
|
|
}
|
2023-06-20 07:36:54 -04:00
|
|
|
return contextStore.ResetTLSMaterial(o.Name, &contextTLSData)
|
2018-11-09 09:10:41 -05:00
|
|
|
}
|
|
|
|
|
2019-04-15 06:03:03 -04:00
|
|
|
func checkContextNameForCreation(s store.Reader, name string) error {
|
2020-09-24 10:24:24 -04:00
|
|
|
if err := store.ValidateContextName(name); err != nil {
|
2018-11-09 09:10:41 -05:00
|
|
|
return err
|
|
|
|
}
|
2022-09-28 16:18:51 -04:00
|
|
|
if _, err := s.GetMetadata(name); !errdefs.IsNotFound(err) {
|
2018-11-09 09:10:41 -05:00
|
|
|
if err != nil {
|
|
|
|
return errors.Wrap(err, "error while getting existing contexts")
|
|
|
|
}
|
|
|
|
return errors.Errorf("context %q already exists", name)
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2019-03-22 10:20:40 -04:00
|
|
|
|
2022-02-22 07:46:35 -05:00
|
|
|
func createFromExistingContext(s store.ReaderWriter, fromContextName string, o *CreateOptions) error {
|
2022-02-24 06:59:15 -05:00
|
|
|
if len(o.Docker) != 0 {
|
|
|
|
return errors.New("cannot use --docker flag when --from is set")
|
2019-03-22 10:20:40 -04:00
|
|
|
}
|
2022-02-22 07:46:35 -05:00
|
|
|
reader := store.Export(fromContextName, &descriptionDecorator{
|
|
|
|
Reader: s,
|
|
|
|
description: o.Description,
|
2019-03-22 10:20:40 -04:00
|
|
|
})
|
|
|
|
defer reader.Close()
|
|
|
|
return store.Import(o.Name, s, reader)
|
|
|
|
}
|
|
|
|
|
2022-02-22 07:46:35 -05:00
|
|
|
type descriptionDecorator struct {
|
2019-04-15 06:03:03 -04:00
|
|
|
store.Reader
|
2022-02-22 07:46:35 -05:00
|
|
|
description string
|
2019-03-22 10:20:40 -04:00
|
|
|
}
|
|
|
|
|
2022-02-22 07:46:35 -05:00
|
|
|
func (d *descriptionDecorator) GetMetadata(name string) (store.Metadata, error) {
|
2019-04-18 09:12:30 -04:00
|
|
|
c, err := d.Reader.GetMetadata(name)
|
2019-03-22 10:20:40 -04:00
|
|
|
if err != nil {
|
|
|
|
return c, err
|
|
|
|
}
|
|
|
|
typedContext, err := command.GetDockerContext(c)
|
|
|
|
if err != nil {
|
|
|
|
return c, err
|
|
|
|
}
|
|
|
|
if d.description != "" {
|
|
|
|
typedContext.Description = d.description
|
|
|
|
}
|
|
|
|
c.Metadata = typedContext
|
|
|
|
return c, nil
|
|
|
|
}
|