cli

Documentation

Overview

Copyright 2020 The UnDistro authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020 The UnDistro authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020 The UnDistro authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020 The UnDistro authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020 The UnDistro authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func Examples(s string) string
• func LongDesc(s string) string
• func NewCmdGet(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
• func NewCmdInstall(f *ConfigFlags, streams genericclioptions.IOStreams) *cobra.Command
• func NewCmdKubeconfig(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command
• func NewCmdMove(f *ConfigFlags, streams genericclioptions.IOStreams) *cobra.Command
• func NewUndistroCommand(in io.Reader, out, err io.Writer) *cobra.Command
• type Config
• type ConfigFlags
  • func NewConfigFlags() *ConfigFlags
  • func (f *ConfigFlags) AddFlags(flags *pflag.FlagSet, goflags *flag.FlagSet)
  • func (f *ConfigFlags) Init() func()
• type Credentials
• type InstallOptions
  • func NewInstallOptions(streams genericclioptions.IOStreams) *InstallOptions
  • func (o *InstallOptions) Complete(f *ConfigFlags, cmd *cobra.Command, args []string) error
  • func (o *InstallOptions) RunInstall(f cmdutil.Factory, cmd *cobra.Command) error
  • func (o *InstallOptions) Validate() error
• type KubeconfigOptions
  • func NewKubeconfigOptions(streams genericclioptions.IOStreams) *KubeconfigOptions
  • func (o *KubeconfigOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error
  • func (o *KubeconfigOptions) RunGetKubeconfig(f cmdutil.Factory, cmd *cobra.Command) error
• type MoveOptions
  • func NewMoveOptions(streams genericclioptions.IOStreams) *MoveOptions
  • func (o *MoveOptions) Complete(f *ConfigFlags, cmd *cobra.Command, args []string) error
  • func (o *MoveOptions) RunMove(f cmdutil.Factory, cmd *cobra.Command) error
  • func (o *MoveOptions) Validate() error
• type Provider
• type Purpose

Constants

const (
	// KubeconfigDataName is the key used to store a Kubeconfig in the secret's data field.
	KubeconfigDataName = "value"
	// Kubeconfig is the secret name suffix storing the Cluster Kubeconfig.
	Kubeconfig = Purpose("kubeconfig")
	// UserKubeconfig is the secret name suffix storing the Cluster Kubeconfig for user usage.
	UserKubeconfig = Purpose("user-kubeconfig")
)

const Indentation = `  `

Functions

func Examples

func Examples(s string) string

Examples normalizes a command's examples to follow the conventions.

func LongDesc

func LongDesc(s string) string

LongDesc normalizes a command's long description to follow the conventions.

func NewCmdGet

func NewCmdGet(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdInstall

func NewCmdInstall(f *ConfigFlags, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdKubeconfig

func NewCmdKubeconfig(f cmdutil.Factory, streams genericclioptions.IOStreams) *cobra.Command

func NewCmdMove

func NewCmdMove(f *ConfigFlags, streams genericclioptions.IOStreams) *cobra.Command

func NewUndistroCommand

func NewUndistroCommand(in io.Reader, out, err io.Writer) *cobra.Command

Types

type Config

type Config struct {
	Credentials Credentials `mapstructure:"credentials"`
	Providers   []Provider  `mapstructure:"providers"`
}

type ConfigFlags

type ConfigFlags struct {
	ConfigFile *string
	Verbosity  *int
	*genericclioptions.ConfigFlags
}

func NewConfigFlags

func NewConfigFlags() *ConfigFlags

NewConfigFlags returns ConfigFlags with default values set

func (*ConfigFlags) AddFlags

func (f *ConfigFlags) AddFlags(flags *pflag.FlagSet, goflags *flag.FlagSet)

func (*ConfigFlags) Init

func (f *ConfigFlags) Init() func()

type Credentials

type Credentials struct {
	Username string `mapstructure:"username"`
	Password string `mapstructure:"password"`
}

type InstallOptions

type InstallOptions struct {
	ConfigPath  string
	ClusterName string
	genericclioptions.IOStreams
}

func NewInstallOptions

func NewInstallOptions(streams genericclioptions.IOStreams) *InstallOptions

func (*InstallOptions) Complete

func (o *InstallOptions) Complete(f *ConfigFlags, cmd *cobra.Command, args []string) error

func (*InstallOptions) RunInstall

func (o *InstallOptions) RunInstall(f cmdutil.Factory, cmd *cobra.Command) error

func (*InstallOptions) Validate

func (o *InstallOptions) Validate() error

type KubeconfigOptions

type KubeconfigOptions struct {
	genericclioptions.IOStreams
	Namespace   string
	ClusterName string
}

func NewKubeconfigOptions

func NewKubeconfigOptions(streams genericclioptions.IOStreams) *KubeconfigOptions

func (*KubeconfigOptions) Complete

func (o *KubeconfigOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error

func (*KubeconfigOptions) RunGetKubeconfig

func (o *KubeconfigOptions) RunGetKubeconfig(f cmdutil.Factory, cmd *cobra.Command) error

type MoveOptions

type MoveOptions struct {
	ConfigPath  string
	ClusterName string
	Namespace   string
	genericclioptions.IOStreams
}

func NewMoveOptions

func NewMoveOptions(streams genericclioptions.IOStreams) *MoveOptions

func (*MoveOptions) Complete

func (o *MoveOptions) Complete(f *ConfigFlags, cmd *cobra.Command, args []string) error

func (*MoveOptions) RunMove

func (o *MoveOptions) RunMove(f cmdutil.Factory, cmd *cobra.Command) error

func (*MoveOptions) Validate

func (o *MoveOptions) Validate() error

type Provider

type Provider struct {
	Name          string            `mapstructure:"name"`
	Configuration map[string]string `mapstructure:"configuration"`
}

type Purpose

type Purpose string

Purpose is the name to append to the secret generated for a cluster.