Merge pull request #96995 from sachinkumarsingh092/fix-comments-kubectl-create

Fix typos and add comments in functions for `kubectl create` subcommands
This commit is contained in:
Kubernetes Prow Robot 2020-12-10 22:23:22 -08:00 committed by GitHub
commit 084ab7641d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 1 deletions

View File

@ -49,6 +49,7 @@ var (
kubectl create cronjob my-job --image=busybox --schedule="*/1 * * * *" -- date`)
)
// CreateCronJobOptions is returned by NewCreateCronJobOptions
type CreateCronJobOptions struct {
PrintFlags *genericclioptions.PrintFlags
@ -72,6 +73,7 @@ type CreateCronJobOptions struct {
genericclioptions.IOStreams
}
// NewCreateCronJobOptions returns an initialized CreateCronJobOptions instance
func NewCreateCronJobOptions(ioStreams genericclioptions.IOStreams) *CreateCronJobOptions {
return &CreateCronJobOptions{
PrintFlags: genericclioptions.NewPrintFlags("created").WithTypeSetter(scheme.Scheme),
@ -110,6 +112,7 @@ func NewCmdCreateCronJob(f cmdutil.Factory, ioStreams genericclioptions.IOStream
return cmd
}
// Complete completes all the required options
func (o *CreateCronJobOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error {
name, err := NameFromCommandArgs(cmd, args)
if err != nil {
@ -165,6 +168,7 @@ func (o *CreateCronJobOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, a
return nil
}
// Run performs the execution of 'create cronjob' sub command
func (o *CreateCronJobOptions) Run() error {
cronjob := o.createCronJob()

View File

@ -79,6 +79,7 @@ type CreateDeploymentOptions struct {
genericclioptions.IOStreams
}
// NewCreateDeploymentOptions returns an initialized CreateDeploymentOptions instance
func NewCreateDeploymentOptions(ioStreams genericclioptions.IOStreams) *CreateDeploymentOptions {
return &CreateDeploymentOptions{
Port: -1,
@ -173,6 +174,7 @@ func (o *CreateDeploymentOptions) Complete(f cmdutil.Factory, cmd *cobra.Command
return nil
}
// Validate makes sure there is no discrepency in provided option values
func (o *CreateDeploymentOptions) Validate() error {
if len(o.Images) > 1 && len(o.Command) > 0 {
return fmt.Errorf("cannot specify multiple --image options and command")

View File

@ -71,6 +71,7 @@ type PriorityClassOptions struct {
genericclioptions.IOStreams
}
// NewPriorityClassOptions returns an initialized PriorityClassOptions instance
func NewPriorityClassOptions(ioStreams genericclioptions.IOStreams) *PriorityClassOptions {
return &PriorityClassOptions{
Value: 0,

View File

@ -45,7 +45,7 @@ var (
kubectl create rolebinding admin --clusterrole=admin --user=user1 --user=user2 --group=group1`))
)
// RoleBindingOpts holds the options for 'create rolebinding' sub command
// RoleBindingOptions holds the options for 'create rolebinding' sub command
type RoleBindingOptions struct {
PrintFlags *genericclioptions.PrintFlags
PrintObj func(obj runtime.Object) error