9477941c20
These functions and types are shallow wrappers around the context store and were intended for internal use as implementation for the CLI itself. They were exported in3126920af1to be used by plugins and Docker Desktop. However, there's currently no public uses of this, and Docker Desktop does not use these functions. These were deprecated in95eeafa551and are no longer used. This patch removes the deprecated functions as they were meant to be implementation specific for the CLI. If there's a need to provide utilities for manipulating the context-store other than through the CLI itself, we can consider creating an SDK for that purpose. This removes: - `RunCreate` and `CreateOptions` - `RunExport` and `ExportOptions` - `RunImport` - `RunRemove` and `RemoveOptions` - `RunUpdate` and `UpdateOptions` - `RunUse` Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
105 lines
2.9 KiB
Go
105 lines
2.9 KiB
Go
package context
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
|
|
"github.com/docker/cli/cli"
|
|
"github.com/docker/cli/cli/command"
|
|
"github.com/docker/cli/cli/command/formatter/tabwriter"
|
|
"github.com/docker/cli/cli/context/docker"
|
|
"github.com/docker/cli/cli/context/store"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// updateOptions are the options used to update a context.
|
|
type updateOptions struct {
|
|
name string
|
|
description string
|
|
endpoint map[string]string
|
|
}
|
|
|
|
func longUpdateDescription() string {
|
|
buf := bytes.NewBuffer(nil)
|
|
buf.WriteString("Update 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 update my-context --description \"some description\" --docker \"host=tcp://myserver:2376,ca=~/ca-file,cert=~/cert-file,key=~/key-file\"\n")
|
|
return buf.String()
|
|
}
|
|
|
|
func newUpdateCommand(dockerCLI command.Cli) *cobra.Command {
|
|
opts := updateOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "update [OPTIONS] CONTEXT",
|
|
Short: "Update a context",
|
|
Args: cli.ExactArgs(1),
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
opts.name = args[0]
|
|
return runUpdate(dockerCLI, &opts)
|
|
},
|
|
Long: longUpdateDescription(),
|
|
ValidArgsFunction: completeContextNames(dockerCLI, 1, false),
|
|
}
|
|
flags := cmd.Flags()
|
|
flags.StringVar(&opts.description, "description", "", "Description of the context")
|
|
flags.StringToStringVar(&opts.endpoint, "docker", nil, "set the docker endpoint")
|
|
return cmd
|
|
}
|
|
|
|
// runUpdate updates a Docker context.
|
|
func runUpdate(dockerCLI command.Cli, opts *updateOptions) error {
|
|
if err := store.ValidateContextName(opts.name); err != nil {
|
|
return err
|
|
}
|
|
s := dockerCLI.ContextStore()
|
|
c, err := s.GetMetadata(opts.name)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
dockerContext, err := command.GetDockerContext(c)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if opts.description != "" {
|
|
dockerContext.Description = opts.description
|
|
}
|
|
|
|
c.Metadata = dockerContext
|
|
|
|
tlsDataToReset := make(map[string]*store.EndpointTLSData)
|
|
|
|
if opts.endpoint != nil {
|
|
dockerEP, dockerTLS, err := getDockerEndpointMetadataAndTLS(s, opts.endpoint)
|
|
if err != nil {
|
|
return fmt.Errorf("unable to create docker endpoint config: %w", err)
|
|
}
|
|
c.Endpoints[docker.DockerEndpoint] = dockerEP
|
|
tlsDataToReset[docker.DockerEndpoint] = dockerTLS
|
|
}
|
|
if err := validateEndpoints(c); err != nil {
|
|
return err
|
|
}
|
|
if err := s.CreateOrUpdate(c); err != nil {
|
|
return err
|
|
}
|
|
for ep, tlsData := range tlsDataToReset {
|
|
if err := s.ResetEndpointTLSMaterial(opts.name, ep, tlsData); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
_, _ = fmt.Fprintln(dockerCLI.Out(), opts.name)
|
|
_, _ = fmt.Fprintf(dockerCLI.Err(), "Successfully updated context %q\n", opts.name)
|
|
return nil
|
|
}
|
|
|
|
func validateEndpoints(c store.Metadata) error {
|
|
_, err := command.GetDockerContext(c)
|
|
return err
|
|
}
|