Sitelet https://github.com/kubernetes/kops/commit/c2c893fc3c24ecbd11496f4183833b4932ae766d
Skip to content

Commit c2c893f

Browse files
hakmanhakman
committed
docs: update for gossip DNS removal and add 1.37 release notes
1 parent a93d74f commit c2c893f

12 files changed

Lines changed: 35 additions & 33 deletions

File tree

‎docs/README.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ For a better viewing experience please check out our live documentation site at
112112
* [Hack Directory](contributing/hack.md)
113113
* [How to update `kops` API](contributing/api_updates.md)
114114
* [Low level description on how kops works](contributing/how_it_works.md)
115-
* [Notes on Gossip design](contributing/gossip.md)
116115
* [Notes on master instance sizing](contributing/instancesizes.md)
117116
* [Our release process](contributing/release-process.md)
118117
* [Releasing with Homebrew](contributing/homebrew.md)

‎docs/aws-china.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Getting Started
44

5-
kOps used to only support Google Cloud DNS and Amazon Route53 to provision a kubernetes cluster. But since 1.6.2 `gossip` has been added which make it possible to provision a cluster without one of those DNS providers. Thanks to `gossip`, it's officially supported to provision a fully-functional kubernetes cluster in AWS China Region [which doesn't have Route53 so far][1] since [1.7][2]. Should support both `cn-north-1` and `cn-northwest-1`, but only `cn-north-1` is tested.
5+
kOps supports provisioning a cluster without a hosted DNS provider by using `--dns=none`, which makes it possible to provision a fully-functional kubernetes cluster in AWS China Region [which doesn't have Route53 so far][1]. Should support both `cn-north-1` and `cn-northwest-1`, but only `cn-north-1` is tested.
66

77
Most of the following procedures to provision a cluster are the same with [the guide to use kOps in AWS](getting_started/aws.md). The differences will be highlighted and the similar parts will be omitted.
88

@@ -33,11 +33,11 @@ export AWS_REGION=$(aws configure get region)
3333

3434
## [Configure DNS](getting_started/aws.md#configure-dns)
3535

36-
As the note kindly pointing out, a gossip-based cluster can be easily created by having the cluster name end with `.k8s.local`. We will adopt this trick below. Rest of this section can be skipped safely.
36+
As the note kindly pointing out, a cluster without hosted DNS can be easily created by using `--dns=none` and having the cluster name end with `.k8s.local`. We will adopt this trick below. Rest of this section can be skipped safely.
3737

3838
## [Testing your DNS setup](getting_started/aws.md#testing-your-dns-setup)
3939

40-
Thanks to `gossip`, this section can be skipped safely as well.
40+
Thanks to `--dns=none`, this section can be skipped safely as well.
4141

4242
## [Cluster State storage](getting_started/aws.md#cluster-state-storage)
4343

‎docs/bastion.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,9 @@ spec:
100100
- "sg-***"
101101
```
102102

103-
### Access when using gossip
103+
### Access when using dns=none
104104

105-
When using [gossip mode](gossip.md), there is no DNS zone where we can configure a
105+
When using `--dns=none`, there is no DNS zone where we can configure a
106106
CNAME for the bastion. Because bastions are fronted with a load
107107
balancer, you can instead use the endpoint of the load balancer to
108108
reach your bastion.

‎docs/contributing/gossip.md‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎docs/contributing/ports.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ See also pkg/wellknownports/wellknownports.go
1818
| 3990 | Kube API health check |
1919
| 3991 | etcd-manager - cilium - grpc |
2020
| 3992 | etcd-manager - cilium - quarantined |
21-
| 3993 | dns gossip - dns-controller - memberlist |
21+
| 3993 | dns gossip - dns-controller - memberlist (removed in kOps 1.37) |
2222
| 3994 | etcd-manager - main - quarantined |
2323
| 3995 | etcd-manager - events - quarantined |
2424
| 3996 | etcd-manager - main - grpc |
2525
| 3997 | etcd-manager - events - grpc |
26-
| 3998 | dns gossip - protokube - weave mesh |
27-
| 3999 | dns gossip - dns-controller - weave mesh |
28-
| 4000 | protokube gossip member list |
26+
| 3998 | dns gossip - protokube - weave mesh (removed in kOps 1.37) |
27+
| 3999 | dns gossip - dns-controller - weave mesh (removed in kOps 1.37) |
28+
| 4000 | protokube gossip member list (removed in kOps 1.37) |
2929
| 4001 | etcd main client |
3030
| 4002 | etcd events client |
3131
| 4003 | etcd cilium client |

‎docs/examples/coreos-kops-tests-multimaster.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export KOPS_STATE_STORE=s3://my-kops-s3-bucket-for-cluster-state
4747
Some things to note from here:
4848

4949
- "NAME" will be an environment variable that we'll use from now in order to refer to our cluster name. For this practical exercise, our cluster name is "coreosbasedkopscluster.k8s.local".
50-
- Because we'll use gossip DNS instead of a valid DNS domain on AWS ROUTE53 service, our cluster name needs to include the string **".k8s.local"** at the end (this is covered on our AWS tutorials). You can see more about this on our [Getting Started Doc.](../getting_started/aws.md)
50+
- Because we'll use `--dns=none` instead of a valid DNS domain on AWS ROUTE53 service, our cluster name needs to include the string **".k8s.local"** at the end (this is covered on our AWS tutorials). You can see more about this on our [Getting Started Doc.](../getting_started/aws.md)
5151

5252

5353
## COREOS IMAGE INFORMATION:

‎docs/examples/kops-tests-private-net-bastion-host.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ export KOPS_STATE_STORE=s3://my-kops-s3-bucket-for-cluster-state
4848
Some things to note from here:
4949

5050
- "NAME" will be an environment variable that we'll use from now in order to refer to our cluster name. For this practical exercise, our cluster name is "privatekopscluster.k8s.local".
51-
- Because we'll use gossip DNS instead of a valid DNS domain on AWS ROUTE53 service, our cluster name need to include the string **".k8s.local"** at the end (this is covered on our AWS tutorials). You can see more about this on our [Getting Started Doc.](../getting_started/aws.md)
51+
- Because we'll use `--dns=none` instead of a valid DNS domain on AWS ROUTE53 service, our cluster name need to include the string **".k8s.local"** at the end (this is covered on our AWS tutorials). You can see more about this on our [Getting Started Doc.](../getting_started/aws.md)
5252

5353

5454
## KOPS PRIVATE CLUSTER CREATION:

‎docs/getting_started/aws.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ somewhere to build the required DNS records. There are three scenarios
7272
below and you should choose the one that most closely matches your AWS
7373
situation.
7474

75-
Note: if you want to use [gossip-based DNS](../gossip.md), you can skip this section.
75+
Note: if you want to use `--dns=none`, you can skip this section.
7676

7777
### Scenario 1a: A Domain purchased/hosted via AWS
7878

@@ -203,7 +203,7 @@ kops create cluster --dns private --dns-zone ZABCDEFG $NAME
203203

204204
## Testing your DNS setup
205205

206-
This section is not required if a gossip-based cluster is created.
206+
This section is not required if the cluster is created with `--dns=none`.
207207

208208
You should now be able to dig your domain (or subdomain) and see the AWS Name
209209
Servers on the other end.
@@ -226,7 +226,7 @@ This is a critical component when setting up clusters. If you are experiencing
226226
problems with the Kubernetes API not coming up, chances are something is wrong
227227
with the cluster's DNS.
228228

229-
**Please DO NOT MOVE ON until you have validated your NS records! This is not required if a gossip-based cluster is created.**
229+
**Please DO NOT MOVE ON until you have validated your NS records! This is not required if the cluster is created with `--dns=none`.**
230230

231231
## Cluster State store
232232

@@ -316,7 +316,7 @@ export NAME=myfirstcluster.example.com
316316
export KOPS_STATE_STORE=s3://prefix-example-com-state-store
317317
```
318318

319-
For a gossip-based cluster, make sure the name ends with `k8s.local`. For example:
319+
For a cluster using `--dns=none`, a name ending with `k8s.local` avoids the need for a registered domain. For example:
320320

321321
```bash
322322
export NAME=myfirstcluster.k8s.local

‎docs/getting_started/digitalocean.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ kops delete cluster my-cluster.example.com --yes
6363
6464
## Creating a Multi-Master HA Cluster
6565
66-
In the below example, `dev5.k8s.local` should be replaced with any cluster name that ends with `.k8s.local` such that a gossip based cluster is created.
66+
In the below example, `dev5.k8s.local` should be replaced with any cluster name that ends with `.k8s.local` such that a cluster without hosted DNS is created.
6767
Ensure the master-count is odd-numbered. A load balancer is created dynamically front-facing the master instances.
6868
6969
```bash

‎docs/getting_started/scaleway.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,6 @@ export S3_SECRET_ACCESS_KEY="my-secret-key" # where <my-secret-key> is the S3 AP
7777
kops create cluster --cloud=scaleway --name=my.cluster --zones=fr-par-1 --dns=none --yes
7878
# This creates a cluster with the Scaleway DNS (on a domain name that you own and have registered with Scaleway) in zone pl-waw-1
7979
kops create cluster --cloud=scaleway --name=mycluster.mydomain.com --zones=pl-waw-1 --yes
80-
# This creates a cluster with the gossip DNS in zone nl-ams-2. This is not recommended since the no-DNS option is available because it is more secure.
81-
kops create cluster --cloud=scaleway --name=mycluster.k8s.local --zones=nl-ams-2 --yes
8280
```
8381
These basic commands create a cluster with default parameters:
8482
- Container Network Interface = `cilium`. To change it, set the flag `--networking=calico`. To see the list of supported CNIs, check the [networking page](../networking.md)
@@ -129,7 +127,7 @@ NB: keep in mind that every new call to kOps with the flags `--target=terraform
129127

130128
## For clusters with load-balancers
131129

132-
This concerns clusters using no DNS and gossip DNS. For these types of cluster, a small trick is needed because kOps doesn't know the IPs of the load-balancer at the time of writing the instances' cloud-init configuration, so we will have to run an update, then a rolling-update.
130+
This concerns clusters using no DNS. For these types of cluster, a small trick is needed because kOps doesn't know the IPs of the load-balancer at the time of writing the instances' cloud-init configuration, so we will have to run an update, then a rolling-update.
133131

134132
### Creating a valid cluster
135133

0 commit comments

Comments
 (0)