Documentation ¶
Index ¶
- Constants
- Variables
- func NewCmdCreateBasicAuthSecret(name, fullName string, f kcmdutil.Factory, reader io.Reader, out io.Writer, ...) *cobra.Command
- func NewCmdCreateDockerConfigSecret(name, fullName string, f kcmdutil.Factory, out io.Writer, ...) *cobra.Command
- func NewCmdCreateSSHAuthSecret(name, fullName string, f kcmdutil.Factory, out io.Writer, ...) *cobra.Command
- func NewCmdCreateSecret(name, fullName string, f *clientcmd.Factory, out io.Writer) *cobra.Command
- func NewCmdLinkSecret(name, fullName string, f kcmdutil.Factory, out io.Writer) *cobra.Command
- func NewCmdSecrets(name, fullName string, f *clientcmd.Factory, reader io.Reader, ...) *cobra.Command
- func NewCmdUnlinkSecret(name, fullName string, f kcmdutil.Factory, out io.Writer) *cobra.Command
- type CreateBasicAuthSecretOptions
- func (o *CreateBasicAuthSecretOptions) Complete(f kcmdutil.Factory, args []string) error
- func (o *CreateBasicAuthSecretOptions) CreateBasicAuthSecret() error
- func (o CreateBasicAuthSecretOptions) GetOut() io.Writer
- func (o *CreateBasicAuthSecretOptions) NewBasicAuthSecret() (*api.Secret, error)
- func (o CreateBasicAuthSecretOptions) Validate() error
- type CreateDockerConfigOptions
- func (o *CreateDockerConfigOptions) Complete(f kcmdutil.Factory, args []string) error
- func (o CreateDockerConfigOptions) CreateDockerSecret() error
- func (o CreateDockerConfigOptions) GetOut() io.Writer
- func (o CreateDockerConfigOptions) NewDockerSecret() (*api.Secret, error)
- func (o CreateDockerConfigOptions) Validate() error
- type CreateSSHAuthSecretOptions
- func (o *CreateSSHAuthSecretOptions) Complete(f kcmdutil.Factory, args []string) error
- func (o *CreateSSHAuthSecretOptions) CreateSSHAuthSecret() error
- func (o CreateSSHAuthSecretOptions) GetOut() io.Writer
- func (o *CreateSSHAuthSecretOptions) NewSSHAuthSecret() (*api.Secret, error)
- func (o CreateSSHAuthSecretOptions) Validate() error
- type CreateSecretOptions
- type KnownSecretType
- type LinkSecretOptions
- type SecretOptions
- func (o *SecretOptions) Complete(f kcmdutil.Factory, args []string) error
- func (o SecretOptions) GetMountSecretNames(serviceaccount *kapi.ServiceAccount) sets.String
- func (o SecretOptions) GetOut() io.Writer
- func (o SecretOptions) GetPullSecretNames(serviceaccount *kapi.ServiceAccount) sets.String
- func (o SecretOptions) GetSecretNames(secrets []*kapi.Secret) sets.String
- func (o SecretOptions) GetSecrets(allowNonExisting bool) ([]*kapi.Secret, bool, error)
- func (o SecretOptions) GetServiceAccount() (*kapi.ServiceAccount, error)
- func (o SecretOptions) Validate() error
- type UnlinkSecretOptions
Constants ¶
const ( // SourceUsername is the key of the optional username for basic authentication subcommand SourceUsername = scmauth.UsernameSecret // SourcePassword is the key of the optional password or token for basic authentication subcommand SourcePassword = scmauth.PasswordSecret // SourceCertificate is the key of the optional certificate authority for basic authentication subcommand SourceCertificate = scmauth.CACertName // SourcePrivateKey is the key of the required SSH private key for SSH authentication subcommand SourcePrivateKey = scmauth.SSHPrivateKeyMethodName // SourceGitconfig is the key of the optional gitconfig content for both basic and SSH authentication subcommands SourceGitConfig = scmauth.GitConfigName )
const CreateBasicAuthSecretRecommendedCommandName = "new-basicauth"
CreateBasicAuthSecretRecommendedCommandName represents name of subcommand for `oc secrets` command
const CreateDockerConfigSecretRecommendedName = "new-dockercfg"
const CreateSSHAuthSecretRecommendedCommandName = "new-sshauth"
CreateSSHAuthSecretRecommendedCommandName represents name of subcommand for `oc secrets` command
const LinkSecretRecommendedName = "link"
LinkSecretRecommendedName `oc secrets link`
const NewSecretRecommendedCommandName = "new"
const SecretsRecommendedName = "secrets"
const UnlinkSecretRecommendedName = "unlink"
Variables ¶
var ( KnownSecretTypes = []KnownSecretType{ {kapi.SecretTypeDockercfg, sets.NewString(kapi.DockerConfigKey)}, {kapi.SecretTypeDockerConfigJson, sets.NewString(kapi.DockerConfigJsonKey)}, } )
Functions ¶
func NewCmdCreateBasicAuthSecret ¶
func NewCmdCreateBasicAuthSecret(name, fullName string, f kcmdutil.Factory, reader io.Reader, out io.Writer, newSecretFullName, ocEditFullName string) *cobra.Command
NewCmdCreateBasicAuthSecret implements the OpenShift cli secrets new-basicauth subcommand
func NewCmdCreateDockerConfigSecret ¶
func NewCmdCreateDockerConfigSecret(name, fullName string, f kcmdutil.Factory, out io.Writer, newSecretFullName, ocEditFullName string) *cobra.Command
NewCmdCreateDockerConfigSecret creates a command object for making a dockercfg secret
func NewCmdCreateSSHAuthSecret ¶
func NewCmdCreateSSHAuthSecret(name, fullName string, f kcmdutil.Factory, out io.Writer, newSecretFullName, ocEditFullName string) *cobra.Command
NewCmdCreateSSHAuthSecret implements the OpenShift cli secrets new-sshauth subcommand
func NewCmdCreateSecret ¶
func NewCmdLinkSecret ¶
NewCmdLinkSecret creates a command object for linking a secret reference to a service account
func NewCmdSecrets ¶
Types ¶
type CreateBasicAuthSecretOptions ¶
type CreateBasicAuthSecretOptions struct { SecretName string Username string Password string CertificatePath string GitConfigPath string PromptForPassword bool Reader io.Reader Out io.Writer SecretsInterface kcoreclient.SecretInterface }
CreateBasicAuthSecretOptions holds the credential needed to authenticate against SCM servers.
func (*CreateBasicAuthSecretOptions) Complete ¶
func (o *CreateBasicAuthSecretOptions) Complete(f kcmdutil.Factory, args []string) error
Complete fills CreateBasicAuthSecretOptions fields with data and checks for mutual exclusivity between flags from different option groups.
func (*CreateBasicAuthSecretOptions) CreateBasicAuthSecret ¶
func (o *CreateBasicAuthSecretOptions) CreateBasicAuthSecret() error
CreateBasicAuthSecret saves created Secret structure and prints the secret name to the output on success.
func (CreateBasicAuthSecretOptions) GetOut ¶
func (o CreateBasicAuthSecretOptions) GetOut() io.Writer
GetOut check if the CreateBasicAuthSecretOptions Out Writer is set. Returns it if the Writer is present, if not returns Writer on which all Write calls succeed without doing anything.
func (*CreateBasicAuthSecretOptions) NewBasicAuthSecret ¶
func (o *CreateBasicAuthSecretOptions) NewBasicAuthSecret() (*api.Secret, error)
NewBasicAuthSecret builds up the Secret structure containing secret name, type and data structure containing desired credentials.
func (CreateBasicAuthSecretOptions) Validate ¶
func (o CreateBasicAuthSecretOptions) Validate() error
Validate check if all necessary fields from CreateBasicAuthSecretOptions are present.
type CreateDockerConfigOptions ¶
type CreateDockerConfigOptions struct { SecretName string RegistryLocation string Username string Password string EmailAddress string SecretsInterface kcoreclient.SecretInterface Out io.Writer }
func (*CreateDockerConfigOptions) Complete ¶
func (o *CreateDockerConfigOptions) Complete(f kcmdutil.Factory, args []string) error
func (CreateDockerConfigOptions) CreateDockerSecret ¶
func (o CreateDockerConfigOptions) CreateDockerSecret() error
func (CreateDockerConfigOptions) GetOut ¶
func (o CreateDockerConfigOptions) GetOut() io.Writer
func (CreateDockerConfigOptions) NewDockerSecret ¶
func (o CreateDockerConfigOptions) NewDockerSecret() (*api.Secret, error)
func (CreateDockerConfigOptions) Validate ¶
func (o CreateDockerConfigOptions) Validate() error
type CreateSSHAuthSecretOptions ¶
type CreateSSHAuthSecretOptions struct { SecretName string PrivateKeyPath string CertificatePath string GitConfigPath string PromptForPassword bool Out io.Writer SecretsInterface kcoreclient.SecretInterface }
CreateSSHAuthSecretOptions holds the credential needed to authenticate against SCM servers.
func (*CreateSSHAuthSecretOptions) Complete ¶
func (o *CreateSSHAuthSecretOptions) Complete(f kcmdutil.Factory, args []string) error
Complete fills CreateSSHAuthSecretOptions fields with data and checks whether necessary arguments were provided.
func (*CreateSSHAuthSecretOptions) CreateSSHAuthSecret ¶
func (o *CreateSSHAuthSecretOptions) CreateSSHAuthSecret() error
CreateSSHAuthSecret saves created Secret structure and prints the secret name to the output on success.
func (CreateSSHAuthSecretOptions) GetOut ¶
func (o CreateSSHAuthSecretOptions) GetOut() io.Writer
GetOut check if the CreateSSHAuthSecretOptions Out Writer is set. Returns it if the Writer is present, if not returns Writer on which all Write calls succeed without doing anything.
func (*CreateSSHAuthSecretOptions) NewSSHAuthSecret ¶
func (o *CreateSSHAuthSecretOptions) NewSSHAuthSecret() (*api.Secret, error)
NewSSHAuthSecret builds up the Secret structure containing secret name, type and data structure containing desired credentials.
func (CreateSSHAuthSecretOptions) Validate ¶
func (o CreateSSHAuthSecretOptions) Validate() error
Validate check if all necessary fields from CreateSSHAuthSecretOptions are present.
type CreateSecretOptions ¶
type CreateSecretOptions struct { // Name of the resulting secret Name string // SecretTypeName is the type to use when creating the secret. It is checked against known types. SecretTypeName string // Files/Directories to read from. // Directory sources are listed and any direct file children included (but subfolders are not traversed) Sources []string SecretsInterface kcoreclient.SecretInterface // Writer to write warnings to Stderr io.Writer Out io.Writer // Controls whether to output warnings Quiet bool AllowUnknownTypes bool }
func NewCreateSecretOptions ¶
func NewCreateSecretOptions() *CreateSecretOptions
func (*CreateSecretOptions) BundleSecret ¶
func (o *CreateSecretOptions) BundleSecret() (*kapi.Secret, error)
func (*CreateSecretOptions) Complete ¶
func (o *CreateSecretOptions) Complete(args []string, f *clientcmd.Factory) error
func (*CreateSecretOptions) CreateSecret ¶
func (o *CreateSecretOptions) CreateSecret() (*kapi.Secret, error)
func (*CreateSecretOptions) Validate ¶
func (o *CreateSecretOptions) Validate() error
type KnownSecretType ¶
type KnownSecretType struct { Type kapi.SecretType RequiredContents sets.String }
type LinkSecretOptions ¶
type LinkSecretOptions struct { SecretOptions ForMount bool ForPull bool // contains filtered or unexported fields }
func (*LinkSecretOptions) Complete ¶
func (o *LinkSecretOptions) Complete(f kcmdutil.Factory, args []string) error
func (LinkSecretOptions) LinkSecrets ¶
func (o LinkSecretOptions) LinkSecrets() error
func (LinkSecretOptions) Validate ¶
func (o LinkSecretOptions) Validate() error
type SecretOptions ¶
type SecretOptions struct { TargetName string SecretNames []string Namespace string BuilderFunc func(bool) *resource.Builder KubeCoreClient kcoreclient.CoreInterface Out io.Writer // contains filtered or unexported fields }
SecretOptions Structure holding state for processing secret linking and unlinking.
func (*SecretOptions) Complete ¶
func (o *SecretOptions) Complete(f kcmdutil.Factory, args []string) error
Complete Parses the command line arguments and populates SecretOptions
func (SecretOptions) GetMountSecretNames ¶
func (o SecretOptions) GetMountSecretNames(serviceaccount *kapi.ServiceAccount) sets.String
GetMountSecretNames Get a list of the names of the mount secrets associated with a service account
func (SecretOptions) GetOut ¶
func (o SecretOptions) GetOut() io.Writer
GetOut Retrieve the output writer
func (SecretOptions) GetPullSecretNames ¶
func (o SecretOptions) GetPullSecretNames(serviceaccount *kapi.ServiceAccount) sets.String
GetPullSecretNames Get a list of the names of the pull secrets associated with a service account.
func (SecretOptions) GetSecretNames ¶
func (o SecretOptions) GetSecretNames(secrets []*kapi.Secret) sets.String
GetSecretNames Get a list of the names of the secrets in a set of them
func (SecretOptions) GetSecrets ¶
GetSecrets Return a list of secret objects in the default namespace If allowNonExisting is set to true, we will return the non-existing secrets as well.
func (SecretOptions) GetServiceAccount ¶
func (o SecretOptions) GetServiceAccount() (*kapi.ServiceAccount, error)
GetServiceAccount Retrieve the service account object specified by the command
func (SecretOptions) Validate ¶
func (o SecretOptions) Validate() error
Validate Ensures that all arguments have appropriate values
type UnlinkSecretOptions ¶
type UnlinkSecretOptions struct {
SecretOptions
}
func (UnlinkSecretOptions) UnlinkSecrets ¶
func (o UnlinkSecretOptions) UnlinkSecrets() error