mirror of https://github.com/kubernetes/kops.git
kops as kOps for document
Updated kops as kOps for document.
This commit is contained in:
parent
3033caa5e7
commit
cb53f89c22
|
@ -59,11 +59,11 @@ var (
|
|||
completion_long = templates.LongDesc(i18n.T(`
|
||||
Output shell completion code for the specified shell (bash or zsh).
|
||||
The shell code must be evaluated to provide interactive
|
||||
completion of kops commands. This can be done by sourcing it from
|
||||
completion of kops commands. This can be done by sourcing it from
|
||||
the .bash_profile.
|
||||
|
||||
Note: this requires the bash-completion framework, which is not installed
|
||||
by default on Mac. Once installed, bash_completion must be evaluated. This can be done by adding the
|
||||
by default on Mac. Once installed, bash_completion must be evaluated. This can be done by adding the
|
||||
following line to the .bash_profile
|
||||
|
||||
|
||||
|
|
|
@ -203,7 +203,7 @@ func NewCmdCreateCluster(f *util.Factory, out io.Writer) *cobra.Command {
|
|||
}
|
||||
|
||||
cmd.Flags().BoolVarP(&options.Yes, "yes", "y", options.Yes, "Specify --yes to immediately create the cluster")
|
||||
cmd.Flags().StringVar(&options.Target, "target", options.Target, fmt.Sprintf("Valid targets: %s, %s, %s. Set this flag to %s if you want kops to generate terraform", cloudup.TargetDirect, cloudup.TargetTerraform, cloudup.TargetCloudformation, cloudup.TargetTerraform))
|
||||
cmd.Flags().StringVar(&options.Target, "target", options.Target, fmt.Sprintf("Valid targets: %s, %s, %s. Set this flag to %s if you want kOps to generate terraform", cloudup.TargetDirect, cloudup.TargetTerraform, cloudup.TargetCloudformation, cloudup.TargetTerraform))
|
||||
|
||||
// Configuration / state location
|
||||
if featureflag.EnableSeparateConfigBase.Enabled() {
|
||||
|
|
|
@ -88,7 +88,7 @@ func NewCmdCreateSecretCiliumEncryptionConfig(f *util.Factory, out io.Writer) *c
|
|||
}
|
||||
|
||||
cmd.Flags().StringVarP(&options.CiliumPasswordFilePath, "", "f", "", "Path to the cilium encryption config file")
|
||||
cmd.Flags().BoolVar(&options.Force, "force", options.Force, "Force replace the kops secret if it already exists")
|
||||
cmd.Flags().BoolVar(&options.Force, "force", options.Force, "Force replace the kOps secret if it already exists")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
|
@ -88,7 +88,7 @@ func NewCmdCreateSecretDockerConfig(f *util.Factory, out io.Writer) *cobra.Comma
|
|||
}
|
||||
|
||||
cmd.Flags().StringVarP(&options.DockerConfigPath, "", "f", "", "Path to docker config JSON file")
|
||||
cmd.Flags().BoolVar(&options.Force, "force", options.Force, "Force replace the kops secret if it already exists")
|
||||
cmd.Flags().BoolVar(&options.Force, "force", options.Force, "Force replace the kOps secret if it already exists")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
|
@ -88,7 +88,7 @@ func NewCmdCreateSecretEncryptionConfig(f *util.Factory, out io.Writer) *cobra.C
|
|||
}
|
||||
|
||||
cmd.Flags().StringVarP(&options.EncryptionConfigPath, "", "f", "", "Path to encryption config yaml file")
|
||||
cmd.Flags().BoolVar(&options.Force, "force", options.Force, "Force replace the kops secret if it already exists")
|
||||
cmd.Flags().BoolVar(&options.Force, "force", options.Force, "Force replace the kOps secret if it already exists")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
|
@ -35,7 +35,7 @@ var (
|
|||
Create a new weave encryption secret, and store it in the state store.
|
||||
Used to weave networking to use encrypted communication between nodes.
|
||||
|
||||
If no password is provided, kops will generate one at random.
|
||||
If no password is provided, kOps will generate one at random.
|
||||
|
||||
WARNING: cannot be enabled on a running cluster without downtime.`))
|
||||
|
||||
|
@ -89,7 +89,7 @@ func NewCmdCreateSecretWeaveEncryptionConfig(f *util.Factory, out io.Writer) *co
|
|||
}
|
||||
|
||||
cmd.Flags().StringVarP(&options.WeavePasswordFilePath, "", "f", "", "Path to the weave password file (optional)")
|
||||
cmd.Flags().BoolVar(&options.Force, "force", options.Force, "Force replace the kops secret if it already exists")
|
||||
cmd.Flags().BoolVar(&options.Force, "force", options.Force, "Force replace the kOps secret if it already exists")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
|
@ -44,7 +44,7 @@ type deleteInstanceOptions struct {
|
|||
Yes bool
|
||||
CloudOnly bool
|
||||
|
||||
// The following two variables are when kops is validating a cluster
|
||||
// The following two variables are when kOps is validating a cluster
|
||||
// between detach and deletion.
|
||||
|
||||
// FailOnDrainError fail deletion if drain errors.
|
||||
|
|
|
@ -35,7 +35,7 @@ import (
|
|||
|
||||
var (
|
||||
deleteIgLong = templates.LongDesc(i18n.T(`
|
||||
Delete an instancegroup configuration. kops has the concept of "instance groups",
|
||||
Delete an instancegroup configuration. kOps has the concept of "instance groups",
|
||||
which are a group of similar virtual machines. On AWS, they map to an
|
||||
AutoScalingGroup. An ig work either as a Kubernetes master or a node.`))
|
||||
|
||||
|
|
|
@ -30,7 +30,7 @@ var (
|
|||
This command changes the desired configuration in the registry.
|
||||
|
||||
To set your preferred editor, you can define the EDITOR environment variable.
|
||||
When you have done this, kops will use the editor that you have set.
|
||||
When you have done this, kOps will use the editor that you have set.
|
||||
|
||||
kops edit does not update the cloud resources, to apply the changes use "kops update cluster".
|
||||
`))
|
||||
|
|
|
@ -51,7 +51,7 @@ var (
|
|||
This command changes the desired cluster configuration in the registry.
|
||||
|
||||
To set your preferred editor, you can define the EDITOR environment variable.
|
||||
When you have done this, kops will use the editor that you have set.
|
||||
When you have done this, kOps will use the editor that you have set.
|
||||
|
||||
kops edit does not update the cloud resources, to apply the changes use "kops update cluster".`))
|
||||
|
||||
|
|
|
@ -45,7 +45,7 @@ var (
|
|||
This command changes the instancegroup desired configuration in the registry.
|
||||
|
||||
To set your preferred editor, you can define the EDITOR environment variable.
|
||||
When you have done this, kops will use the editor that you have set.
|
||||
When you have done this, kOps will use the editor that you have set.
|
||||
|
||||
kops edit does not update the cloud resources, to apply the changes use "kops update cluster".`))
|
||||
|
||||
|
|
|
@ -61,7 +61,7 @@ type ExportKubecfgOptions struct {
|
|||
user string
|
||||
internal bool
|
||||
|
||||
// UseKopsAuthenticationPlugin controls whether we should use the kops auth helper instead of a static credential
|
||||
// UseKopsAuthenticationPlugin controls whether we should use the kOps auth helper instead of a static credential
|
||||
UseKopsAuthenticationPlugin bool
|
||||
}
|
||||
|
||||
|
@ -83,12 +83,12 @@ func NewCmdExportKubecfg(f *util.Factory, out io.Writer) *cobra.Command {
|
|||
}
|
||||
|
||||
cmd.Flags().StringVar(&options.KubeConfigPath, "kubeconfig", options.KubeConfigPath, "the location of the kubeconfig file to create.")
|
||||
cmd.Flags().BoolVar(&options.all, "all", options.all, "export all clusters from the kops state store")
|
||||
cmd.Flags().BoolVar(&options.all, "all", options.all, "export all clusters from the kOps state store")
|
||||
cmd.Flags().DurationVar(&options.admin, "admin", options.admin, "export a cluster admin user credential with the given lifetime and add it to the cluster context")
|
||||
cmd.Flags().Lookup("admin").NoOptDefVal = kubeconfig.DefaultKubecfgAdminLifetime.String()
|
||||
cmd.Flags().StringVar(&options.user, "user", options.user, "add an existing user to the cluster context")
|
||||
cmd.Flags().BoolVar(&options.internal, "internal", options.internal, "use the cluster's internal DNS name")
|
||||
cmd.Flags().BoolVar(&options.UseKopsAuthenticationPlugin, "auth-plugin", options.UseKopsAuthenticationPlugin, "use the kops authentication plugin")
|
||||
cmd.Flags().BoolVar(&options.UseKopsAuthenticationPlugin, "auth-plugin", options.UseKopsAuthenticationPlugin, "use the kOps authentication plugin")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
|
@ -67,11 +67,11 @@ var (
|
|||
# Preview a rolling-update.
|
||||
kops rolling-update cluster
|
||||
|
||||
# Roll the currently selected kops cluster with defaults.
|
||||
# Roll the currently selected kOps cluster with defaults.
|
||||
# Nodes will be drained and the cluster will be validated between node replacement.
|
||||
kops rolling-update cluster --yes
|
||||
|
||||
# Roll the k8s-cluster.example.com kops cluster,
|
||||
# Roll the k8s-cluster.example.com kOps cluster,
|
||||
# do not fail if the cluster does not validate,
|
||||
# wait 8 min to create new node, and wait at least
|
||||
# 8 min to validate the cluster.
|
||||
|
@ -80,7 +80,7 @@ var (
|
|||
--master-interval=8m \
|
||||
--node-interval=8m
|
||||
|
||||
# Roll the k8s-cluster.example.com kops cluster,
|
||||
# Roll the k8s-cluster.example.com kOps cluster,
|
||||
# do not validate the cluster because of the cloudonly flag.
|
||||
# Force the entire cluster to roll, even if rolling update
|
||||
# reports that the cluster does not need to be rolled.
|
||||
|
@ -88,7 +88,7 @@ var (
|
|||
--cloudonly \
|
||||
--force
|
||||
|
||||
# Roll the k8s-cluster.example.com kops cluster,
|
||||
# Roll the k8s-cluster.example.com kOps cluster,
|
||||
# only roll the node instancegroup,
|
||||
# use the new drain and validate functionality.
|
||||
kops rolling-update cluster k8s-cluster.example.com --yes \
|
||||
|
@ -106,7 +106,7 @@ type RollingUpdateOptions struct {
|
|||
Force bool
|
||||
CloudOnly bool
|
||||
|
||||
// The following two variables are when kops is validating a cluster
|
||||
// The following two variables are when kOps is validating a cluster
|
||||
// during a rolling update.
|
||||
|
||||
// FailOnDrainError fail rolling-update if drain errors.
|
||||
|
|
|
@ -52,17 +52,17 @@ const (
|
|||
|
||||
var (
|
||||
rootLong = templates.LongDesc(i18n.T(`
|
||||
kops is Kubernetes ops.
|
||||
kOps is Kubernetes ops.
|
||||
|
||||
kops is the easiest way to get a production grade Kubernetes cluster up and running.
|
||||
kOps is the easiest way to get a production grade Kubernetes cluster up and running.
|
||||
We like to think of it as kubectl for clusters.
|
||||
|
||||
kops helps you create, destroy, upgrade and maintain production-grade, highly available,
|
||||
kOps helps you create, destroy, upgrade and maintain production-grade, highly available,
|
||||
Kubernetes clusters from the command line. AWS (Amazon Web Services) is currently
|
||||
officially supported, with GCE and OpenStack in beta support.
|
||||
`))
|
||||
|
||||
rootShort = i18n.T(`kops is Kubernetes ops.`)
|
||||
rootShort = i18n.T(`kOps is Kubernetes ops.`)
|
||||
)
|
||||
|
||||
type Factory interface {
|
||||
|
|
|
@ -33,7 +33,7 @@ import (
|
|||
|
||||
var (
|
||||
toolboxConvertImportedLong = templates.LongDesc(i18n.T(`
|
||||
Convert an imported cluster into a kops cluster.`))
|
||||
Convert an imported cluster into a kOps cluster.`))
|
||||
|
||||
toolboxConvertImportedExample = templates.Examples(i18n.T(`
|
||||
|
||||
|
@ -45,7 +45,7 @@ var (
|
|||
--newname k8s-cluster.example.com
|
||||
`))
|
||||
|
||||
toolboxConvertImportedShort = i18n.T(`Convert an imported cluster into a kops cluster.`)
|
||||
toolboxConvertImportedShort = i18n.T(`Convert an imported cluster into a kOps cluster.`)
|
||||
)
|
||||
|
||||
type ToolboxConvertImportedOptions struct {
|
||||
|
|
|
@ -125,7 +125,7 @@ func NewCmdUpdateCluster(f *util.Factory, out io.Writer) *cobra.Command {
|
|||
cmd.Flags().Lookup("admin").NoOptDefVal = kubeconfig.DefaultKubecfgAdminLifetime.String()
|
||||
cmd.Flags().StringVar(&options.user, "user", options.user, "Existing user to add to the cluster context. Implies --create-kube-config")
|
||||
cmd.Flags().BoolVar(&options.internal, "internal", options.internal, "Use the cluster's internal DNS name. Implies --create-kube-config")
|
||||
cmd.Flags().BoolVar(&options.AllowKopsDowngrade, "allow-kops-downgrade", options.AllowKopsDowngrade, "Allow an older version of kops to update the cluster than last used")
|
||||
cmd.Flags().BoolVar(&options.AllowKopsDowngrade, "allow-kops-downgrade", options.AllowKopsDowngrade, "Allow an older version of kOps to update the cluster than last used")
|
||||
cmd.Flags().StringVar(&options.Phase, "phase", options.Phase, "Subset of tasks to run: "+strings.Join(cloudup.Phases.List(), ", "))
|
||||
cmd.Flags().StringSliceVar(&options.LifecycleOverrides, "lifecycle-overrides", options.LifecycleOverrides, "comma separated list of phase overrides, example: SecurityGroups=Ignore,InternetGateway=ExistsAndWarnIfChanges")
|
||||
viper.BindPFlag("lifecycle-overrides", cmd.Flags().Lookup("lifecycle-overrides"))
|
||||
|
|
|
@ -37,7 +37,7 @@ var (
|
|||
# Kops will try for 10 minutes to validate the cluster 3 times.
|
||||
kops validate cluster --wait 10m --count 3`))
|
||||
|
||||
validateShort = i18n.T(`Validate a kops cluster.`)
|
||||
validateShort = i18n.T(`Validate a kOps cluster.`)
|
||||
)
|
||||
|
||||
func NewCmdValidate(f *util.Factory, out io.Writer) *cobra.Command {
|
||||
|
|
|
@ -28,12 +28,12 @@ import (
|
|||
|
||||
var (
|
||||
versionLong = templates.LongDesc(i18n.T(`
|
||||
Print the kops version and git SHA.`))
|
||||
Print the kOps version and git SHA.`))
|
||||
|
||||
versionExample = templates.Examples(i18n.T(`
|
||||
kops version`))
|
||||
|
||||
versionShort = i18n.T(`Print the kops version information.`)
|
||||
versionShort = i18n.T(`Print the kOps version information.`)
|
||||
)
|
||||
|
||||
// NewCmdVersion builds a cobra command for the kops version command
|
||||
|
@ -54,7 +54,7 @@ func NewCmdVersion(f *util.Factory, out io.Writer) *cobra.Command {
|
|||
}
|
||||
}
|
||||
|
||||
cmd.Flags().BoolVar(&options.Short, "short", options.Short, "only print the main kops version, useful for scripting")
|
||||
cmd.Flags().BoolVar(&options.Short, "short", options.Short, "only print the main kOps version, useful for scripting")
|
||||
|
||||
return cmd
|
||||
}
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
# Architecture: kops-controller
|
||||
|
||||
kops-controller runs as a DaemonSet on the master node(s). It is a kubebuilder
|
||||
controller that performs runtime reconciliation for kops.
|
||||
kops-controller runs as a DaemonSet on the master node(s). It is a kubebuilder
|
||||
controller that performs runtime reconciliation for kOps.
|
||||
|
||||
Controllers in kops-controller:
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ https://go.k8s.io/bot-commands).
|
|||
|
||||
## Office Hours
|
||||
|
||||
kOps maintainers set aside one hour every other week for **public** office hours. This time is used to gather with community members interested in kops. This session is open to both developers and users.
|
||||
kOps maintainers set aside one hour every other week for **public** office hours. This time is used to gather with community members interested in kOps. This session is open to both developers and users.
|
||||
|
||||
For more information, checkout the [office hours page.](office_hours.md)
|
||||
|
||||
|
|
Loading…
Reference in New Issue