Skip to content

Commit e69fdd3

Browse files
author
Willem Mali
committed
spelled out abbreviations, moved HA example to HA docs, integrated some other suggestions from @chrislovecn
1 parent 85bcbe5 commit e69fdd3

File tree

4 files changed

+43
-63
lines changed

4 files changed

+43
-63
lines changed

README.md

+2-26
Original file line numberDiff line numberDiff line change
@@ -68,20 +68,6 @@ $ mv kops-linux-amd64 /usr/local/bin/kops # Move the kops to /usr/local/bin
6868
```
6969

7070

71-
### Developer From Source
72-
73-
Go 1.8+ and make are required. You may need to do a full build including pushing protokube, nodeup, and kops to s3.
74-
75-
See the [install notes](/docs/install.md) for more information.
76-
77-
```console
78-
$ go get -d k8s.io/kops
79-
$ cd ${GOPATH}/src/k8s.io/kops/
80-
$ git checkout release
81-
$ make
82-
```
83-
84-
At this time, Windows is not a supported platform.
8571

8672

8773
## History
@@ -151,20 +137,10 @@ date +%V
151137

152138
The maintainers and other community members are generally available on the [kubernetes slack](https://github.com/kubernetes/community#slack-chat) in [#kops](https://kubernetes.slack.com/messages/kops/), so come find and chat with us about how kops can be better for you!
153139

154-
## Other Resources
155-
156-
- Create [kubecfg settings for kubectl](/docs/tips.md#create-kubecfg-settings-for-kubectl)
157-
- Set up [add-ons](/docs/addons.md), to add important functionality to Kubernetes
158-
- Learn about [InstanceGroups](/docs/instance_groups.md); change
159-
instance types, number of nodes, and other options
160-
- Read about [networking options](/docs/networking.md)
161-
- Look at our [other interesting modes](/docs/commands.md#other-interesting-modes)
162-
- Full command line interface [documentation](/docs/cli/kops.md)
163-
164140

165141
## GitHub Issues
166142

167-
#### Bugs
143+
### Bugs
168144

169145
If you think you have found a bug please follow the instructions below.
170146

@@ -176,7 +152,7 @@ If you think you have found a bug please follow the instructions below.
176152
- Feel free to reach out to the kops community on [kubernetes slack](https://github.com/kubernetes/community#slack-chat)
177153

178154

179-
#### Features
155+
### Features
180156

181157
We also use the issue tracker to track features. If you have an idea for a feature, or think you can help kops become even more awesome follow the steps below.
182158

docs/README.md

+10-14
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
Documentation Index
22
===================
33

4-
This page serves as a categorized index for all `kops` documentation.
5-
6-
74
Quick start
85
-----------
96
* [Getting started on AWS](aws.md)
@@ -13,8 +10,8 @@ Quick start
1310
Overview
1411
--------
1512

16-
* [CLI](#cli)
17-
* [Introspection](#introspection)
13+
* [Command-line interface](#commandline-interface)
14+
* [Inspection](#inspection)
1815
* [`kops` design documents](#kops-design-documents)
1916
* [Networking](#networking)
2017
* [Operations](#operations)
@@ -23,7 +20,7 @@ Overview
2320

2421

2522

26-
### CLI ###
23+
### Command-line interface ###
2724

2825
* [CLI argument explanations](arguments.md)
2926
* [CLI reference](cli/kops.md)
@@ -35,7 +32,7 @@ Overview
3532
* how to point kubectl to your `kops` cluster
3633

3734

38-
### Introspection ###
35+
### Inspection ###
3936

4037
* [Download `kops` configuration](download_config.md)
4138
* methods to download the current generated `kops` configuration
@@ -64,21 +61,20 @@ Overview
6461
* [Cluster addon manager](addon_manager.md)
6562
* [Cluster addons](addons.md)
6663
* [Cluster configuration management](changing_configuration.md)
67-
* [Cluster with HA creation example](advanced_create.md)
6864
* [Cluster upgrades and migrations](cluster_upgrades_and_migrations.md)
6965
* [`etcd` volume encryption setup](etcd_volume_encryption.md)
7066
* [`etcd` backup setup](etcd_backup.md)
7167
* [GPU setup](gpu.md)
7268
* [High Availability](high_availability.md)
7369
* [InstanceGroup images](images.md)
74-
* how to modify IG images and information on available/tested images
70+
* how to use other image for cluster nodes, and information on available/tested images
71+
* [`k8s` upgrading](upgrade.md)
72+
* [`kops` updating](update_kops.md)
73+
* [`kube-up` to `kops` upgrade](upgrade_from_kubeup.md)
7574
* [Label management](labels.md)
76-
* for AWS instance tags and `k8s` node labels
77-
* [`kube-up` to `kops` migration](upgrade_from_kubeup.md)
75+
* for cluster nodes
7876
* [Secret management](secrets.md)
79-
* [Single-master to multi-master migration](single-to-multi-master.md)
80-
* [`k8s` updating](upgrade.md)
81-
* [`kops` updating](update_kops.md)
77+
* [Single-master to multi-master update](single-to-multi-master.md)
8278

8379

8480
### Security ###

docs/advanced_create.md

-20
This file was deleted.

docs/high_availability.md

+31-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# High Availability (HA)
1+
High Availability (HA)
2+
======================
23

3-
## Introduction
4+
Introduction
5+
-------------
46

57
Kubernetes has two strategies for high availability:
68

@@ -27,7 +29,9 @@ In short:
2729
* A multi-node kops cluster can tolerate the outage of a single AZ
2830
* Federation will allow you to create "uber-clusters" that can tolerate a regional outage
2931

30-
## Using Kops HA
32+
33+
Using Kops HA
34+
-------------
3135

3236
We can create HA clusters using kops, but only it's important to note that migrating from a single-master
3337
cluster to a multi-master cluster is a complicated operation (described [here](./single-to-multi-master.md)).
@@ -58,3 +62,27 @@ As a result there are a few considerations that need to be taken into account wh
5862
If we create 2 (or more) masters in the same AZ, then failure of the AZ will likely cause etcd to lose quorum
5963
and stop operating (with 3 nodes). Running in the same AZ therefore increases the risk of cluster disruption,
6064
though it can be a valid scenario, particularly if combined with [federation](https://kubernetes.io/docs/user-guide/federation/).
65+
66+
67+
Advanced Example
68+
----------------
69+
70+
Another example `create cluster` invocation for HA with [a private network topology](topology.md):
71+
72+
```
73+
kops create cluster \
74+
--node-count 3 \
75+
--zones us-west-2a,us-west-2b,us-west-2c \
76+
--master-zones us-west-2a,us-west-2b,us-west-2c \
77+
--dns-zone example.com \
78+
--node-size t2.medium \
79+
--master-size t2.medium \
80+
--node-security-groups sg-12345678 \
81+
--master-security-groups sg-12345678,i-abcd1234 \
82+
--topology private \
83+
--networking weave \
84+
--cloud-labels "Team=Dev,Owner=John Doe" \
85+
--image 293135079892/k8s-1.4-debian-jessie-amd64-hvm-ebs-2016-11-16 \
86+
${NAME}
87+
```
88+

0 commit comments

Comments
 (0)