mirror of
https://github.com/containers/podman.git
synced 2025-05-20 08:36:23 +08:00
b5d1d89a37
Allow automatic generation for shell completion scripts with the internal cobra functions (requires v1.0.0+). This should replace the handwritten completion scripts and even adds support for fish. With this approach it is less likley that completions and code are out of sync. We can now create the scripts with - podman completion bash - podman completion zsh - podman completion fish To test the completion run: source <(podman completion bash) The same works for podman-remote and podman --remote and it will complete your remote containers/images with the correct endpoints values from --url/--connection. The completion logic is written in go and provided by the cobra library. The completion functions lives in `cmd/podman/completion/completion.go`. The unit test at cmd/podman/shell_completion_test.go checks if each command and flag has an autocompletion function set. This prevents that commands and flags have no shell completion set. This commit does not replace the current autocompletion scripts. Closes #6440 Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
76 lines
2.3 KiB
Go
76 lines
2.3 KiB
Go
package pods
|
|
|
|
import (
|
|
"fmt"
|
|
"io/ioutil"
|
|
"os"
|
|
|
|
"github.com/containers/common/pkg/completion"
|
|
"github.com/containers/podman/v2/cmd/podman/common"
|
|
"github.com/containers/podman/v2/cmd/podman/registry"
|
|
"github.com/containers/podman/v2/cmd/podman/utils"
|
|
"github.com/containers/podman/v2/pkg/domain/entities"
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
kubeOptions = entities.GenerateKubeOptions{}
|
|
kubeFile = ""
|
|
kubeDescription = `Command generates Kubernetes pod and service YAML (v1 specification) from a Podman container or pod.
|
|
|
|
Whether the input is for a container or pod, Podman will always generate the specification as a pod.`
|
|
|
|
kubeCmd = &cobra.Command{
|
|
Use: "kube [options] CONTAINER | POD",
|
|
Short: "Generate Kubernetes YAML from a container or pod.",
|
|
Long: kubeDescription,
|
|
RunE: kube,
|
|
Args: cobra.ExactArgs(1),
|
|
ValidArgsFunction: common.AutocompleteContainersAndPods,
|
|
Example: `podman generate kube ctrID
|
|
podman generate kube podID
|
|
podman generate kube --service podID`,
|
|
}
|
|
)
|
|
|
|
func init() {
|
|
registry.Commands = append(registry.Commands, registry.CliCommand{
|
|
Mode: []entities.EngineMode{entities.ABIMode, entities.TunnelMode},
|
|
Command: kubeCmd,
|
|
Parent: generateCmd,
|
|
})
|
|
flags := kubeCmd.Flags()
|
|
flags.BoolVarP(&kubeOptions.Service, "service", "s", false, "Generate YAML for a Kubernetes service object")
|
|
|
|
filenameFlagName := "filename"
|
|
flags.StringVarP(&kubeFile, filenameFlagName, "f", "", "Write output to the specified path")
|
|
_ = kubeCmd.RegisterFlagCompletionFunc(filenameFlagName, completion.AutocompleteDefault)
|
|
|
|
flags.SetNormalizeFunc(utils.AliasFlags)
|
|
}
|
|
|
|
func kube(cmd *cobra.Command, args []string) error {
|
|
report, err := registry.ContainerEngine().GenerateKube(registry.GetContext(), args[0], kubeOptions)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
content, err := ioutil.ReadAll(report.Reader)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if cmd.Flags().Changed("filename") {
|
|
if _, err := os.Stat(kubeFile); err == nil {
|
|
return errors.Errorf("cannot write to %q; file exists", kubeFile)
|
|
}
|
|
if err := ioutil.WriteFile(kubeFile, content, 0644); err != nil {
|
|
return errors.Wrapf(err, "cannot write to %q", kubeFile)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
fmt.Println(string(content))
|
|
return nil
|
|
}
|