Skip to content

Commit

Permalink
Update docs, CHANGES, and mkdocs-material
Browse files Browse the repository at this point in the history
* Update mkdocs-material from v4.4.2 to v4.4.3
* Update recommended Terraform provider versions
* Cleanup the changelog before release
  • Loading branch information
dghubble committed Oct 7, 2019
1 parent ab72f1a commit 5196709
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 22 deletions.
11 changes: 7 additions & 4 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Notable changes between versions.

## Latest
## v1.16.1

* Kubernetes [v1.16.1](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG-1.16.md#v1161)
* Update etcd from v3.3.15 to [v3.4.1](https://github.com/etcd-io/etcd/releases/tag/v3.4.1)
Expand All @@ -12,20 +12,22 @@ Notable changes between versions.

#### AWS

* Add `node_labels` variable to internal `workers` module ([#550](https://github.com/poseidon/typhoon/pull/550))
* Add `worker_node_labels` variable to set initial worker node labels ([#550](https://github.com/poseidon/typhoon/pull/550))
* Add `node_labels` variable to internal `workers` pool module ([#550](https://github.com/poseidon/typhoon/pull/550))
* For Fedora CoreOS, detect most recent AMI in the region

#### Azure

* Promote `networking` provider Calico VXLAN out of experimental (set `networking = "calico"`)
* Add `node_labels` variable to internal `workers` module ([#550](https://github.com/poseidon/typhoon/pull/550))
* Add `worker_node_labels` variable to set initial worker node labels ([#550](https://github.com/poseidon/typhoon/pull/550))
* Add `node_labels` variable to internal `workers` pool module ([#550](https://github.com/poseidon/typhoon/pull/550))
* Change `workers` module default `vm_type` to `Standard_DS1_v2` (followup to [#539](https://github.com/poseidon/typhoon/pull/539))

#### Bare-Metal

* For Fedora CoreOS, use new kernel, initrd, and raw paths ([#563](https://github.com/poseidon/typhoon/pull/563))
* Fix Terraform missing comma error ([#549](https://github.com/poseidon/typhoon/pull/549))
* Remove deprecated `container_linux_oem` variable ([#562](https://github.com/poseidon/typhoon/pull/562))
* For Fedora CoreOS, use new kernel, initrd, and raw paths ([#563](https://github.com/poseidon/typhoon/pull/563))

#### DigitalOcean

Expand All @@ -34,6 +36,7 @@ Notable changes between versions.

#### Google Cloud

* Add `worker_node_labels` variable to set initial worker node labels ([#550](https://github.com/poseidon/typhoon/pull/550))
* Add `node_labels` variable to internal `workers` module ([#550](https://github.com/poseidon/typhoon/pull/550))

#### Addons
Expand Down
4 changes: 2 additions & 2 deletions docs/cl/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Install [Terraform](https://www.terraform.io/downloads.html) v0.12.x on your sys

```sh
$ terraform version
Terraform v0.12.7
Terraform v0.12.9
```

Add the [terraform-provider-ct](https://github.com/poseidon/terraform-provider-ct) plugin binary for your system to `~/.terraform.d/plugins/`, noting the final name.
Expand Down Expand Up @@ -49,7 +49,7 @@ Configure the AWS provider to use your access key credentials in a `providers.tf

```tf
provider "aws" {
version = "2.29.0"
version = "2.31.0"
region = "eu-central-1"
shared_credentials_file = "/home/user/.config/aws/credentials"
}
Expand Down
9 changes: 4 additions & 5 deletions docs/cl/azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Install [Terraform](https://www.terraform.io/downloads.html) v0.12.x on your sys

```sh
$ terraform version
Terraform v0.12.7
Terraform v0.12.9
```

Add the [terraform-provider-ct](https://github.com/poseidon/terraform-provider-ct) plugin binary for your system to `~/.terraform.d/plugins/`, noting the final name.
Expand Down Expand Up @@ -50,7 +50,7 @@ Configure the Azure provider in a `providers.tf` file.

```tf
provider "azurerm" {
version = "1.34.0"
version = "1.35.0"
}
provider "ct" {
Expand Down Expand Up @@ -217,23 +217,22 @@ Reference the DNS zone with `azurerm_dns_zone.clusters.name` and its resource gr
| worker_type | Machine type for workers | "Standard_DS1_v2" | See below |
| os_image | Channel for a Container Linux derivative | "coreos-stable" | coreos-stable, coreos-beta, coreos-alpha |
| disk_size | Size of the disk in GB | 40 | 100 |
| worker_node_labels | List of initial worker node labels | [] | ["worker-pool=default"] |
| worker_priority | Set priority to Low to use reduced cost surplus capacity, with the tradeoff that instances can be deallocated at any time | Regular | Low |
| controller_clc_snippets | Controller Container Linux Config snippets | [] | [example](/advanced/customization/#usage) |
| worker_clc_snippets | Worker Container Linux Config snippets | [] | [example](/advanced/customization/#usage) |
| networking | Choice of networking provider | "flannel" | "flannel" or "calico" |
| host_cidr | CIDR IPv4 range to assign to instances | "10.0.0.0/16" | "10.0.0.0/20" |
| pod_cidr | CIDR IPv4 range to assign to Kubernetes pods | "10.2.0.0/16" | "10.22.0.0/16" |
| service_cidr | CIDR IPv4 range to assign to Kubernetes services | "10.3.0.0/16" | "10.3.0.0/24" |
| cluster_domain_suffix | FQDN suffix for Kubernetes services answered by coredns. | "cluster.local" | "k8s.example.com" |
| worker_node_labels | List of initial worker node labels | [] | ["worker-pool=default"] |

Check the list of valid [machine types](https://azure.microsoft.com/en-us/pricing/details/virtual-machines/linux/) and their [specs](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes-general). Use `az vm list-skus` to get the identifier.

!!! warning
Unlike AWS and GCP, Azure requires its *virtual* networks to have non-overlapping IPv4 CIDRs (yeah, go figure). Instead of each cluster just using `10.0.0.0/16` for instances, each Azure cluster's `host_cidr` must be non-overlapping (e.g. 10.0.0.0/20 for the 1st cluster, 10.0.16.0/20 for the 2nd cluster, etc).

!!! warning
Do not choose a `controller_type` smaller than `Standard_DS1_v2`. Smaller instances are not sufficient for running a controller.
Do not choose a `controller_type` smaller than `Standard_B2s`. Smaller instances are not sufficient for running a controller.

#### Low Priority

Expand Down
4 changes: 2 additions & 2 deletions docs/cl/bare-metal.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Install [Terraform](https://www.terraform.io/downloads.html) v0.12.x on your sys

```sh
$ terraform version
Terraform v0.12.7
Terraform v0.12.9
```

Add the [terraform-provider-matchbox](https://github.com/poseidon/terraform-provider-matchbox) plugin binary for your system to `~/.terraform.d/plugins/`, noting the final name.
Expand Down Expand Up @@ -166,7 +166,7 @@ module "bare-metal-mercury" {
cluster_name = "mercury"
matchbox_http_endpoint = "http://matchbox.example.com"
os_channel = "coreos-stable"
os_version = "1632.3.0"
os_version = "2191.5.0"
# configuration
k8s_domain_name = "node1.example.com"
Expand Down
4 changes: 2 additions & 2 deletions docs/cl/digital-ocean.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Install [Terraform](https://www.terraform.io/downloads.html) v0.12.x on your sys

```sh
$ terraform version
Terraform v0.12.7
Terraform v0.12.9
```

Add the [terraform-provider-ct](https://github.com/poseidon/terraform-provider-ct) plugin binary for your system to `~/.terraform.d/plugins/`, noting the final name.
Expand Down Expand Up @@ -50,7 +50,7 @@ Configure the DigitalOcean provider to use your token in a `providers.tf` file.

```tf
provider "digitalocean" {
version = "1.7.0"
version = "1.8.0"
token = "${chomp(file("~/.config/digital-ocean/token"))}"
}
Expand Down
4 changes: 2 additions & 2 deletions docs/cl/google-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Install [Terraform](https://www.terraform.io/downloads.html) v0.12.x on your sys

```sh
$ terraform version
Terraform v0.12.7
Terraform v0.12.9
```

Add the [terraform-provider-ct](https://github.com/poseidon/terraform-provider-ct) plugin binary for your system to `~/.terraform.d/plugins/`, noting the final name.
Expand Down Expand Up @@ -49,7 +49,7 @@ Configure the Google Cloud provider to use your service account key, project-id,

```tf
provider "google" {
version = "2.15.0"
version = "2.16.0"
project = "project-id"
region = "us-central1"
credentials = file("~/.config/google-cloud/terraform.json")
Expand Down
6 changes: 3 additions & 3 deletions docs/fedora-coreos/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Install [Terraform](https://www.terraform.io/downloads.html) v0.12.x on your sys

```sh
$ terraform version
Terraform v0.12.7
Terraform v0.12.9
```

Add the [terraform-provider-ct](https://github.com/poseidon/terraform-provider-ct) plugin binary for your system to `~/.terraform.d/plugins/`, noting the final name.
Expand Down Expand Up @@ -52,7 +52,7 @@ Configure the AWS provider to use your access key credentials in a `providers.tf

```tf
provider "aws" {
version = "2.29.0"
version = "2.31.0"
region = "eu-central-1"
shared_credentials_file = "/home/user/.config/aws/credentials"
}
Expand All @@ -73,7 +73,7 @@ Define a Kubernetes cluster using the module `aws/fedora-coreos/kubernetes`.

```tf
module "aws-tempest" {
source = "git::https://github.com/poseidon/typhoon//aws/fedora-coreos/kubernetes?ref=DEVELOPMENT_SHA"
source = "git::https://github.com/poseidon/typhoon//aws/fedora-coreos/kubernetes?ref=v1.16.1"
# AWS
cluster_name = "tempest"
Expand Down
2 changes: 1 addition & 1 deletion docs/fedora-coreos/bare-metal.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Install [Terraform](https://www.terraform.io/downloads.html) v0.12.x on your sys

```sh
$ terraform version
Terraform v0.12.7
Terraform v0.12.9
```

Add the [terraform-provider-matchbox](https://github.com/poseidon/terraform-provider-matchbox) plugin binary for your system to `~/.terraform.d/plugins/`, noting the final name.
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
mkdocs==1.0.4
mkdocs-material==4.4.2
mkdocs-material==4.4.3
pygments==2.2.0
pymdown-extensions==5.0.0

0 comments on commit 5196709

Please sign in to comment.