Skip to content

Commit cdf1325

Browse files
authored
Added extra docs about updating Golang version. (thanos-io#1209)
Signed-off-by: Bartek Plotka <[email protected]>
1 parent d5441f2 commit cdf1325

File tree

5 files changed

+35
-6
lines changed

5 files changed

+35
-6
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
about what components it touches e.g "query:" or ".*:"
44
-->
55

6+
* [] CHANGELOG entry if change is relevant to the end user.
7+
68
## Changes
79

810
<!-- Enumerate changes you made -->

CHANGELOG.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,16 @@ NOTE: As semantic versioning states all 0.y.z releases can contain breaking chan
99

1010
We use *breaking* word for marking changes that are not backward compatible (relates only to v0.y.z releases.)
1111

12-
## [v0.5.0-rc.0](https://github.com/improbable-eng/thanos/releases/tag/v0.5.0-rc.0) - 2019.05.30
12+
## Unreleased.
13+
14+
## [v0.5.0-rc.0](https://github.com/improbable-eng/thanos/releases/tag/v0.5.0-rc.0) - 2019.05.31
1315

1416
TL;DR: Store LRU cache is no longer leaking, Upgraded Thanos UI to Prometheus 2.9, Fixed auto-downsampling, Moved to Go 1.12.5 and more.
1517

18+
This version moved tarballs to Golang 1.12.5 from 1.11 as well, so same warning applies if you use `container_memory_usage_bytes` from cadvisor. Use `container_memory_working_set_bytes` instead.
19+
20+
*breaking* As announced couple of times this release also removes gossip with all configuration flags (`--cluster.*`).
21+
1622
### Fixed
1723

1824
- [#1142](https://github.com/improbable-eng/thanos/pull/1142) fixed major leak on store LRU cache for index items (postings and series).
@@ -65,7 +71,7 @@ TL;DR: Store LRU cache is no longer leaking, Upgraded Thanos UI to Prometheus 2.
6571

6672
## Deprecated
6773

68-
- [#1008](https://github.com/improbable-eng/thanos/pull/1008) Removed Gossip implementation.
74+
- [#1008](https://github.com/improbable-eng/thanos/pull/1008) *breaking* Removed Gossip implementation. All `--cluster.*` flags removed and Thanos will error out if any is provided.
6975

7076
## [v0.4.0](https://github.com/improbable-eng/thanos/releases/tag/v0.4.0) - 2019.05.3
7177

@@ -74,7 +80,7 @@ TL;DR: Store LRU cache is no longer leaking, Upgraded Thanos UI to Prometheus 2.
7480
This release also disables gossip mode by default for all components.
7581
See [this](docs/proposals/approved/201809_gossip-removal.md) for more details.
7682

77-
:warning: This release moves Thanos docker images and artifacts to Golang 1.12. This release includes change in GC's memory release which gives following effect (source: https://golang.org/doc/go1.12):
83+
:warning: This release moves Thanos docker images (NOT artifacts by accident) to Golang 1.12. This release includes change in GC's memory release which gives following effect (source: https://golang.org/doc/go1.12):
7884

7985
> On Linux, the runtime now uses MADV_FREE to release unused memory. This is more efficient but may result in higher reported RSS. The kernel will reclaim the unused data when it is needed. To revert to the Go 1.11 behavior (MADV_DONTNEED), set the environment variable GODEBUG=madvdontneed=1.
8086
@@ -170,7 +176,7 @@ Note that this is required to have SRV resolution working on [Golang 1.11+ with
170176
* tooling: [FEATURE] New dump command to tsdb tool to dump all samples.
171177
* compactor:
172178
* [ENHANCEMENT] When closing the db any running compaction will be cancelled so it doesn't block.
173-
* [CHANGE] Renamed flag `--sync-delay` to `--consistency-delay` [#1053](https://github.com/improbable-eng/thanos/pull/1053)
179+
* [CHANGE] *breaking* Renamed flag `--sync-delay` to `--consistency-delay` [#1053](https://github.com/improbable-eng/thanos/pull/1053)
174180

175181
For ruler essentially whole TSDB CHANGELOG applies beween v0.4.0-v0.6.1: https://github.com/prometheus/tsdb/blob/master/CHANGELOG.md
176182

VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.5.0-rc.0
1+
0.5.0-rc.0-master
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Changing Golang version
3+
type: docs
4+
menu: contributing
5+
slug: /how-to-change-go-version.md
6+
---
7+
8+
Thanos build system is pinned to certain Golang version. This is to ensure that Golang version
9+
changes is done by us in controlled, traceable way.
10+
11+
To update Thanos build system to newer Golang:
12+
13+
1. Edit [.promu.yaml](/.promu.yml) and edit `go: version: <go version>` in YAML to desired version. This will ensure that all artifacts are
14+
built with desired Golang version. How to verify? Download tarball, unpack and invoke `thanos --version`
15+
1. Edit [.circleci/config.yaml](/.circleci/config.yml) and edit ` - image: circleci/golang:<go version>` to desired
16+
Golang version. This will ensure that all docker images and go tests are using desired Golang version. How to verify? Invoke `docker pull improbable/thanos:<version> --version`

docs/release-process.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# Releases
1+
---
2+
title: Release Process
3+
type: docs
4+
menu: thanos
5+
slug: /release-process.md
6+
---
27

38
This page describes the release cadence and process for Thanos project.
49

0 commit comments

Comments
 (0)