Merge pull request #10235 from axpraka/update-kops-as-kOps

Update kops as kOps and remove extra spaces from .md files
This commit is contained in:
Kubernetes Prow Robot 2020-11-14 07:45:05 -08:00 committed by GitHub
commit 9e14b29867
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
81 changed files with 185 additions and 193 deletions

View File

@ -14,8 +14,7 @@ Instructions for reporting a vulnerability can be found on the
## Supported Versions
Information about supported kOps versions and the Kubernetes versions they support can be found on the
[Releases and versioning](https://kops.sigs.k8s.io/welcome/releases/) page. Information about supported Kubernetes versions can be found on the
[Kubernetes version and version skew support policy] page on the Kubernetes website.
[Releases and versioning](https://kops.sigs.k8s.io/welcome/releases/) page. Information about supported Kubernetes versions can be found on the [Kubernetes version and version skew support policy] page on the Kubernetes website.
[kubernetes-security-announce]: https://groups.google.com/forum/#!forum/kubernetes-security-announce
[kubernetes-security-announce-rss]: https://groups.google.com/forum/feed/kubernetes-security-announce/msgs/rss_v2_0.xml?num=50

View File

@ -11,7 +11,7 @@ complete lifecycle of Ambassador in your cluster. It also automates many of the
Ambassador. Once installed, the Operator will automatically complete rapid installations and seamless upgrades to new
versions of Ambassador.
This addon deploys Ambassador Operator which installs Ambassador in a kops cluster.
This addon deploys Ambassador Operator which installs Ambassador in a kOps cluster.
##### Note:
The operator requires widely scoped permissions in order to install and manage Ambassador's lifecycle. Both, the

View File

@ -32,7 +32,7 @@ kubectl apply -f ${addon}
An enhanced script which also adds the IAM policies is included here [cluster-autoscaler.sh](cluster-autoscaler.sh)
Question: Which ASG group should be autoscaled?
Answer: By default, kops creates a "nodes" instancegroup and a corresponding ASG group which will have a name such as "nodes.$CLUSTER_NAME", visible in the AWS Console. That ASG is a good choice to begin with. Optionally, you may also create a new instancegroup "kops create ig _newgroupname_", and configure that instead. Set the maxSize of the kOps instancesgroup, and update the cluster so the maxSize propagates to the ASG.
Answer: By default, kOps creates a "nodes" instancegroup and a corresponding ASG group which will have a name such as "nodes.$CLUSTER_NAME", visible in the AWS Console. That ASG is a good choice to begin with. Optionally, you may also create a new instancegroup "kops create ig _newgroupname_", and configure that instead. Set the maxSize of the kOps instancesgroup, and update the cluster so the maxSize propagates to the ASG.
Question: The cluster-autoscaler [documentation](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/cloudprovider/aws) mentions an IAM Policy. Which IAM Role should the Policy be attached to?
Answer: Kops creates two Roles, nodes.$CLUSTER_NAME and masters.$CLUSTER_NAME. Currently the example scripts run the autoscaler process on the k8s master node, so the IAM Policy should be assigned to masters.$CLUSTER_NAME (substituting that variable for your actual cluster name).

View File

@ -1,4 +1,4 @@
# Deploying Citrix Ingress Controller through KOPS
# Deploying Citrix Ingress Controller through kOps
This guide explains how to deploy [Citrix Ingress Controller](https://github.com/citrix/citrix-k8s-ingress-controller) through KOPS addon.

View File

@ -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() {

View File

@ -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
}

View File

@ -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
}

View File

@ -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
}

View File

@ -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
}

View File

@ -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.

View File

@ -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.`))

View File

@ -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".
`))

View File

@ -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".`))

View File

@ -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".`))

View File

@ -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
}

View File

@ -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.

View File

@ -52,17 +52,17 @@ const (
var (
rootLong = templates.LongDesc(i18n.T(`
kops is Kubernetes ops.
kOps is Kubernetes Operations.
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 Operations.`)
)
type Factory interface {

View File

@ -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 {

View File

@ -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"))

View File

@ -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 {

View File

@ -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
}

View File

@ -1,8 +1,8 @@
# Download kOps config spec file
KOPS operates off of a config spec file that is generated during the create phase. It is uploaded to the amazon s3 bucket that is passed in during create.
kOps operates off of a config spec file that is generated during the create phase. It is uploaded to the amazon s3 bucket that is passed in during create.
If you download the config spec file on a running cluster that is configured the way you like it, you can just pass that config spec file in to the create command and have kops create the cluster for you , `kops create -f spec_file` in a completely unattended manner.
If you download the config spec file on a running cluster that is configured the way you like it, you can just pass that config spec file in to the create command and have kOps create the cluster for you, `kops create -f spec_file` in a completely unattended manner.
Let us say you create your cluster with the following configuration options:

View File

@ -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.
controller that performs runtime reconciliation for kOps.
Controllers in kops-controller:

View File

@ -1,6 +1,6 @@
## Kubernetes Bootstrap
This is an overview of how a Kubernetes cluster comes up, when using kops.
This is an overview of how a Kubernetes cluster comes up, when using kOps.
## From spec to complete configuration
@ -31,7 +31,7 @@ In addition, nodeup installs:
## /etc/kubernetes/manifests
kubelet starts pods as controlled by the files in /etc/kubernetes/manifests These files are created
kubelet starts pods as controlled by the files in /etc/kubernetes/manifests. These files are created
by nodeup and protokube (ideally all by protokube, but currently split between the two).
These pods are declared using the standard k8s manifests, just as if they were stored in the API.

View File

@ -3,15 +3,15 @@
## kops
kops is Kubernetes ops.
kOps is Kubernetes Operations.
### Synopsis
kops is Kubernetes ops.
kOps is Kubernetes Operations.
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 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, Kubernetes clusters from the command line. AWS (Amazon Web Services) is currently officially supported, with GCE and OpenStack in beta support.
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.
### Options
@ -50,6 +50,6 @@ kops is Kubernetes ops.
* [kops toolbox](kops_toolbox.md) - Misc infrequently used commands.
* [kops update](kops_update.md) - Update a cluster.
* [kops upgrade](kops_upgrade.md) - Upgrade a kubernetes cluster.
* [kops validate](kops_validate.md) - Validate a kops cluster.
* [kops version](kops_version.md) - Print the kops version information.
* [kops validate](kops_validate.md) - Validate a kOps cluster.
* [kops version](kops_version.md) - Print the kOps version information.

View File

@ -68,5 +68,5 @@ kops completion [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.

View File

@ -75,7 +75,7 @@ kops create -f FILENAME [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops create cluster](kops_create_cluster.md) - Create a Kubernetes cluster.
* [kops create instancegroup](kops_create_instancegroup.md) - Create an instancegroup.
* [kops create secret](kops_create_secret.md) - Create a secret.

View File

@ -116,7 +116,7 @@ kops create cluster [flags]
--ssh-access strings Restrict SSH access to this CIDR. If not set, access will not be restricted by IP. (default [0.0.0.0/0])
--ssh-public-key string SSH public key to use (defaults to ~/.ssh/id_rsa.pub on AWS)
--subnets strings Set to use shared subnets
--target string Valid targets: direct, terraform, cloudformation. Set this flag to terraform if you want kops to generate terraform (default "direct")
--target string Valid targets: direct, terraform, cloudformation. Set this flag to terraform if you want kOps to generate terraform (default "direct")
-t, --topology string Controls network topology for the cluster: public|private. (default "public")
--utility-subnets strings Set to use shared utility subnets
--vpc string Set to use a shared VPC

View File

@ -32,7 +32,7 @@ kops create secret ciliumpassword [flags]
```
-f, -- string Path to the cilium encryption config file
--force Force replace the kops secret if it already exists
--force Force replace the kOps secret if it already exists
-h, --help help for ciliumpassword
```

View File

@ -31,7 +31,7 @@ kops create secret dockerconfig [flags]
```
-f, -- string Path to docker config JSON file
--force Force replace the kops secret if it already exists
--force Force replace the kOps secret if it already exists
-h, --help help for dockerconfig
```

View File

@ -31,7 +31,7 @@ kops create secret encryptionconfig [flags]
```
-f, -- string Path to encryption config yaml file
--force Force replace the kops secret if it already exists
--force Force replace the kOps secret if it already exists
-h, --help help for encryptionconfig
```

View File

@ -9,7 +9,7 @@ Create a weave encryption config.
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.
@ -38,7 +38,7 @@ kops create secret weavepassword [flags]
```
-f, -- string Path to the weave password file (optional)
--force Force replace the kops secret if it already exists
--force Force replace the kOps secret if it already exists
-h, --help help for weavepassword
```

View File

@ -63,7 +63,7 @@ kops delete -f FILENAME [--yes] [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops delete cluster](kops_delete_cluster.md) - Delete a cluster.
* [kops delete instance](kops_delete_instance.md) - Delete an instance
* [kops delete instancegroup](kops_delete_instancegroup.md) - Delete instancegroup

View File

@ -7,7 +7,7 @@ Delete instancegroup
### Synopsis
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.
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.
```
kops delete instancegroup [flags]

View File

@ -43,6 +43,6 @@ Get additional information about cloud and cluster resources.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops describe secrets](kops_describe_secrets.md) - Describe a cluster secret

View File

@ -10,7 +10,7 @@ Edit clusters and other resources.
Edit a resource configuration. 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".
@ -53,7 +53,7 @@ Edit a resource configuration. This command changes the desired configuration in
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops edit cluster](kops_edit_cluster.md) - Edit cluster.
* [kops edit instancegroup](kops_edit_instancegroup.md) - Edit instancegroup.

View File

@ -12,7 +12,7 @@ Edit a cluster configuration.
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".

View File

@ -12,7 +12,7 @@ Edit a cluster configuration.
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".

View File

@ -44,6 +44,6 @@ Export configurations from a cluster.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops export kubecfg](kops_export_kubecfg.md) - Export kubecfg.

View File

@ -30,8 +30,8 @@ kops export kubecfg CLUSTERNAME [flags]
```
--admin duration[=18h0m0s] export a cluster admin user credential with the given lifetime and add it to the cluster context
--all export all clusters from the kops state store
--auth-plugin use the kops authentication plugin
--all export all clusters from the kOps state store
--auth-plugin use the kOps authentication plugin
-h, --help help for kubecfg
--internal use the cluster's internal DNS name
--kubeconfig string the location of the kubeconfig file to create.

View File

@ -68,7 +68,7 @@ kops get [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops get clusters](kops_get_clusters.md) - Get one or many clusters.
* [kops get instancegroups](kops_get_instancegroups.md) - Get one or many instancegroups
* [kops get instances](kops_get_instances.md) - Display cluster instances.

View File

@ -45,6 +45,6 @@ Imports a kubernetes cluster created by kube-up.sh into a state store. This com
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops import cluster](kops_import_cluster.md) - Import a cluster.

View File

@ -56,5 +56,5 @@ kops replace -f FILENAME [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.

View File

@ -31,11 +31,11 @@ Note: terraform users will need to run all of the following commands from the sa
# 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.
@ -44,7 +44,7 @@ Note: terraform users will need to run all of the following commands from the sa
--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.
@ -52,7 +52,7 @@ Note: terraform users will need to run all of the following commands from the sa
--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 \
@ -89,6 +89,6 @@ Note: terraform users will need to run all of the following commands from the sa
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops rolling-update cluster](kops_rolling-update_cluster.md) - Rolling update a cluster.

View File

@ -35,11 +35,11 @@ kops rolling-update cluster [flags]
# 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.
@ -48,7 +48,7 @@ kops rolling-update cluster [flags]
--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.
@ -56,7 +56,7 @@ kops rolling-update cluster [flags]
--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 \

View File

@ -46,6 +46,6 @@ Set a configuration field.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops set cluster](kops_set_cluster.md) - Set cluster fields.

View File

@ -44,8 +44,8 @@ Misc infrequently used commands.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops toolbox convert-imported](kops_toolbox_convert-imported.md) - Convert an imported cluster into a kops cluster.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops toolbox convert-imported](kops_toolbox_convert-imported.md) - Convert an imported cluster into a kOps cluster.
* [kops toolbox dump](kops_toolbox_dump.md) - Dump cluster information
* [kops toolbox instance-selector](kops_toolbox_instance-selector.md) - Generate on-demand or spot instance-group specs by providing resource specs like vcpus and memory.
* [kops toolbox template](kops_toolbox_template.md) - Generate cluster.yaml from template

View File

@ -3,11 +3,11 @@
## kops toolbox convert-imported
Convert an imported cluster into a kops cluster.
Convert an imported cluster into a kOps cluster.
### Synopsis
Convert an imported cluster into a kops cluster.
Convert an imported cluster into a kOps cluster.
```
kops toolbox convert-imported [flags]

View File

@ -44,6 +44,6 @@ Creates or updates cloud resources to match cluster desired configuration.
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops update cluster](kops_update_cluster.md) - Update a cluster.

View File

@ -26,7 +26,7 @@ kops update cluster [flags]
```
--admin duration[=18h0m0s] Also export a cluster admin user credential with the specified lifetime and add it to the cluster context
--allow-kops-downgrade Allow an older version of kops to update the cluster than last used
--allow-kops-downgrade Allow an older version of kOps to update the cluster than last used
--create-kube-config Will control automatically creating the kube config file on your local filesystem (default true)
-h, --help help for cluster
--internal Use the cluster's internal DNS name. Implies --create-kube-config

View File

@ -44,6 +44,6 @@ Automates checking for and applying Kubernetes updates. This upgrades a cluster
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops upgrade cluster](kops_upgrade_cluster.md) - Upgrade a kubernetes cluster.

View File

@ -3,7 +3,7 @@
## kops validate
Validate a kops cluster.
Validate a kOps cluster.
### Synopsis
@ -45,6 +45,6 @@ This command validates a cluster. See: kops validate cluster -h
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops validate cluster](kops_validate_cluster.md) - Validate a kops cluster.
* [kops](kops.md) - kOps is Kubernetes Operations.
* [kops validate cluster](kops_validate_cluster.md) - Validate a kOps cluster.

View File

@ -3,7 +3,7 @@
## kops validate cluster
Validate a kops cluster.
Validate a kOps cluster.
### Synopsis
@ -58,5 +58,5 @@ kops validate cluster [flags]
### SEE ALSO
* [kops validate](kops_validate.md) - Validate a kops cluster.
* [kops validate](kops_validate.md) - Validate a kOps cluster.

View File

@ -3,11 +3,11 @@
## kops version
Print the kops version information.
Print the kOps version information.
### Synopsis
Print the kops version and git SHA.
Print the kOps version and git SHA.
```
kops version [flags]
@ -23,7 +23,7 @@ kops version [flags]
```
-h, --help help for version
--short only print the main kops version, useful for scripting
--short only print the main kOps version, useful for scripting
```
### Options inherited from parent commands
@ -48,5 +48,5 @@ kops version [flags]
### SEE ALSO
* [kops](kops.md) - kops is Kubernetes ops.
* [kops](kops.md) - kOps is Kubernetes Operations.

View File

@ -22,8 +22,7 @@ spec:
```
When configuring a LoadBalancer, you can also choose to have a public load balancer or an internal (VPC only) load balancer. The `type`
field should be `Public` or `Internal`.
When configuring a LoadBalancer, you can also choose to have a public load balancer or an internal (VPC only) load balancer. The `type` field should be `Public` or `Internal`.
Also, you can add precreated additional security groups to the load balancer by setting `additionalSecurityGroups`.

View File

@ -144,12 +144,10 @@ which would end up in a drop-in file on nodes of the instance group in question.
## mixedInstancesPolicy (AWS Only)
A Mixed Instances Policy utilizing EC2 Spot and the `capacity-optimized` allocation strategy allows an EC2 Autoscaling Group to
select the instance types with the highest capacity. This reduces the chance of a spot interruption on your instance group.
A Mixed Instances Policy utilizing EC2 Spot and the `capacity-optimized` allocation strategy allows an EC2 Autoscaling Group to select the instance types with the highest capacity. This reduces the chance of a spot interruption on your instance group.
Instance groups with a mixedInstancesPolicy can be generated with the `kops toolbox instance-selector` command.
The instance-selector accepts user supplied resource parameters like vcpus, memory, and much more to dynamically select instance types
that match your criteria.
The instance-selector accepts user supplied resource parameters like vcpus, memory, and much more to dynamically select instance types that match your criteria.
```bash
kops toolbox instance-selector --vcpus 4 --flexible --usage-class spot --instance-group-name spotgroup
@ -187,7 +185,7 @@ spec:
### Instances
Instances is a list of instance types which we are willing to run in the EC2 Auto Scaling group
Instances is a list of instance types which we are willing to run in the EC2 Auto Scaling group.
### onDemandAllocationStrategy

View File

@ -20,7 +20,7 @@ Backups and restores of etcd on kOps are covered in [etcd_backup_restore_encrypt
## Direct Data Access
It's not typically necessary to view or manipulate the data inside of etcd directly with etcdctl, because all operations usually go through kubectl commands. However, it can be informative during troubleshooting, or just to understand kubernetes better. Here are the steps to accomplish that on kops.
It's not typically necessary to view or manipulate the data inside of etcd directly with etcdctl, because all operations usually go through kubectl commands. However, it can be informative during troubleshooting, or just to understand kubernetes better. Here are the steps to accomplish that on kOps.
1\. Connect to an etcd-manager pod

View File

@ -36,7 +36,7 @@ You can also rerun [these steps](../development/building.md) if previously built
## Upgrading Kubernetes
Upgrading Kubernetes is easy with kops. The cluster spec contains a `kubernetesVersion`, so you can simply edit it with `kops edit`, and apply the updated configuration to your cluster.
Upgrading Kubernetes is easy with kOps. The cluster spec contains a `kubernetesVersion`, so you can simply edit it with `kops edit`, and apply the updated configuration to your cluster.
The `kops upgrade` command also automates checking for and applying updates.

View File

@ -40,8 +40,7 @@ The API objects are currently stored in an abstraction called a ["state store"](
Configuration of a kubernetes cluster is actually relatively complicated: there are a lot of options, and many combinations
must be configured consistently with each other.
Similar to the way creating a Kubernetes object populates other spec values, the `kops create cluster` command will infer other values
that are not set, so that you can specify a minimal set of values (but if you don't want to override the default value, you simply specify the fields!).
Similar to the way creating a Kubernetes object populates other spec values, the `kops create cluster` command will infer other values that are not set, so that you can specify a minimal set of values (but if you don't want to override the default value, you simply specify the fields!).
Because more values are inferred than with simpler k8s objects, we record the user-created spec separately from the
complete inferred specification. This means we can keep track of which values were actually set by the user, vs just being

View File

@ -23,7 +23,7 @@ preparing for a new kubernetes release, we will try to advance the master branch
to focus on the new functionality, and start cherry-picking back more selectively
to the release branches only as needed.
Generally we don't encourage users to run older kops versions, or older
Generally we don't encourage users to run older kOps versions, or older
branches, because newer versions of kOps should remain compatible with older
versions of Kubernetes.
@ -118,8 +118,7 @@ git fetch origin # sync back up
## Wait for CI job to complete
The staging CI job should now see the tag, and build it (from the
trusted prow cluster, using Google Cloud Build).
The staging CI job should now see the tag, and build it (from the trusted prow cluster, using Google Cloud Build).
The job is here: https://testgrid.k8s.io/sig-cluster-lifecycle-kops#kops-postsubmit-push-to-staging

View File

@ -1,6 +1,6 @@
## Release notes for kops 1.20 series
## Release notes for kOps 1.20 series
(The kops 1.20 release has not been released yet; this is a document to gather the notes prior to the release).
(The kOps 1.20 release has not been released yet; this is a document to gather the notes prior to the release).
# Significant changes
@ -16,7 +16,7 @@
# Deprecations
* Support for Kubernetes versions 1.13 and 1.14 are deprecated and will be removed in kops 1.21.
* Support for Kubernetes versions 1.13 and 1.14 are deprecated and will be removed in kOps 1.21.
* The [manifest based metrics server addon](https://github.com/kubernetes/kops/tree/master/addons/metrics-server) has been deprecated in favour of a configurable addon.

View File

@ -1,8 +1,6 @@
## Running in a shared VPC
When launching into a shared VPC, kOps will reuse the VPC and Internet Gateway. If you are not using an Internet Gateway
or NAT Gateway you can tell kOps to ignore egress. By default, kops creates a new subnet per zone and a new route table,
but you can instead use a shared subnet (see [below](#shared-subnets)).
When launching into a shared VPC, kOps will reuse the VPC and Internet Gateway. If you are not using an Internet Gateway or NAT Gateway you can tell kOps to ignore egress. By default, kOps creates a new subnet per zone and a new route table, but you can instead use a shared subnet (see [below](#shared-subnets)).
1. Use `kops create cluster` with the `--vpc` argument for your existing VPC:
@ -161,7 +159,7 @@ spec:
### Shared NAT Egress
On AWS in private [topology](topology.md), kops creates one NAT Gateway (NGW) per AZ. If your shared VPC is already set up with an NGW in the subnet that `kops` deploys private resources to, it is possible to specify the ID and have `kops`/`kubernetes` use it.
On AWS in private [topology](topology.md), kOps creates one NAT Gateway (NGW) per AZ. If your shared VPC is already set up with an NGW in the subnet that `kops` deploys private resources to, it is possible to specify the ID and have `kops`/`kubernetes` use it.
If you don't want to use NAT Gateways but have setup [EC2 NAT Instances](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) in your VPC that you can share, it's possible to specify the IDs of said instances and have `kops`/`kubernetes` use them.

View File

@ -85,7 +85,7 @@ Wait for the cluster to initialize. If all goes well, you should have a working
#### Editing the cluster
It's possible to use Terraform to make changes to your infrastructure as defined by kops. In the example below we'd like to change some cluster configs:
It's possible to use Terraform to make changes to your infrastructure as defined by kOps. In the example below we'd like to change some cluster configs:
```
$ kops edit cluster \

View File

@ -1,6 +1,6 @@
# Upgrading kubernetes
Upgrading kubernetes is very easy with kOps, as long as you are using a compatible version of kops.
Upgrading kubernetes is very easy with kOps, as long as you are using a compatible version of kOps.
The kOps `1.18.x` series (for example) supports the kubernetes 1.16, 1.17 and 1.18 series,
as per the kubernetes deprecation policy. Older versions of kubernetes will likely still work, but these
are on a best-effort basis and will have little if any testing. kOps `1.18` will not support the kubernetes

View File

@ -1,7 +1,7 @@
# Managinging Instance Groups
kOps has the concept of "instance groups", which are a group of similar machines. On AWS, they map to
an AutoScalingGroup.
an Auto Scaling group.
By default, a cluster has:

View File

@ -1,7 +1,7 @@
# Upgrading from kube-up to kOps
kOps let you upgrade an existing kubernetes cluster installed using kube-up, to a cluster managed by
kops.
kOps.
** This is a slightly risky procedure, so we recommend backing up important data before proceeding.
Take a snapshot of your EBS volumes; export all your data from kubectl etc. **

View File

@ -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)

View File

@ -1,6 +1,6 @@
## 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.
Office hours are hosted on a [zoom video chat](https://zoom.us/j/97072789944?pwd=VVlUR3dhN2h5TEFQZHZTVVd4SnJUdz09) on Fridays at [12 noon (Eastern Time)/9 am (Pacific Time)](http://www.worldtimebuddy.com/?pl=1&lid=100,5,8,12) during weeks with odd "numbers". To check this weeks' number, run: `date +%V`. If the response is odd, join us on Friday for office hours!

View File

@ -13,7 +13,7 @@ support Kubernetes 1.16.5, 1.15.2, and several previous Kubernetes versions.
## Compatibility Matrix
| kops version | k8s 1.14.x | k8s 1.15.x | k8s 1.16.x | k8s 1.17.x | k8s 1.18.x |
| kOps version | k8s 1.14.x | k8s 1.15.x | k8s 1.16.x | k8s 1.17.x | k8s 1.18.x |
|---------------|------------|------------|------------|------------|------------|
| 1.18.0 | ✔ | ✔ | ✔ | ✔ | ✔ |
| 1.17.x | ✔ | ✔ | ✔ | ✔ | ⚫ |
@ -23,7 +23,7 @@ support Kubernetes 1.16.5, 1.15.2, and several previous Kubernetes versions.
Use the latest version of kOps for all releases of Kubernetes, with the caveat
that higher versions of Kubernetes are not _officially_ supported by kops.
that higher versions of Kubernetes are not _officially_ supported by kOps.
Releases which are ~~crossed out~~ _should_ work, but we suggest they be upgraded soon.
## Release Schedule

View File

@ -1,3 +1,3 @@
This directory contains docs that add contextual help to error messages.
The links are baked into kops, and thus we cannot rename or move these files (at least not quickly).
The links are baked into kOps, and thus we cannot rename or move these files (at least not quickly).

View File

@ -3,7 +3,7 @@
Kops has established a deprecation policy for Kubernetes version support.
Kops will remove support for Kubernetes versions as follows:
| kops version | Removes support for Kubernetes version |
| kOps version | Removes support for Kubernetes version |
|--------------|----------------------------------------|
| 1.18 | 1.8 and below |
| 1.19 | 1.9 and 1.10 |

View File

@ -1,5 +1,5 @@
# Kops Upgrade Recommended
You are running a version of kops that we recommend upgrading.
You are running a version of kOps that we recommend upgrading.
The latest releases are available from [Github Releases](https://github.com/kubernetes/kops/releases)