[docs] node affinity docs; 0.2.0 release prep #133
Conversation
schallert
commented
May 1, 2019
schallert
commented
- Changelog entries for 0.2.0
- Docs on new features (tolerations, expanded node affinity)
Codecov Report
@@ Coverage Diff @@
## master #133 +/- ##
======================================
Coverage 71.9% 71.9%
======================================
Files 26 26
Lines 1808 1808
======================================
Hits 1300 1300
Misses 406 406
Partials 102 102Continue to review full report at Codecov.
|
schallert
force-pushed
the
schallert/0_2_0_docs
branch
from
89a19d5
to
8a0d867
Compare
CHANGELOG.md
Outdated
|
|
||
| * [FEATURE] Allow specifying of etcd endpoints on M3DBCluster spec ([#99][99]) | ||
| * [FEATURE] Allow specifying security contexts for M3DB pods ([#107][107]) | ||
| * [FEATURE] Allow specifying tolerations of m3db pods ([#111][111]) |
There was a problem hiding this comment.
nit: m3db -> M3DB for consistency
| @@ -18,13 +52,28 @@ | |||
|
|
|||
| ## 0.1.0 | |||
|
|
|||
| * TODO | |||
| * Fix helm manifests. | |||
There was a problem hiding this comment.
Should the header for this be 0.1.1?
CHANGELOG.md
Outdated
| [117]: https://github.com/m3db/m3db-operator/pull/117 | ||
| [118]: https://github.com/m3db/m3db-operator/pull/118 | ||
| [119]: https://github.com/m3db/m3db-operator/pull/119 | ||
| [99]: https://github.com/m3db/m3db-operator/pull/99 |
There was a problem hiding this comment.
nit: Worth ordering 99 above 100 here? Rest seem to be in order, super nit though.
docs/configuration/node_affinity.md
Outdated
|
|
||
| By leveraging Kubernetes' node affinity and M3DB's isolation groups, the operator can guarantee that M3DB pods are | ||
| distributed across failure domains. For example, in a Kubernetes cluster spread across 3 zones in a cloud region, the | ||
| `isolationGroups` below config would guarantee that no single zone failure could degrade the M3DB cluster. |
There was a problem hiding this comment.
nit: below config -> configuration below
| values: | ||
| - m3db-dedicated-pool | ||
| tolerations: | ||
| - key: m3db-dedicated |
There was a problem hiding this comment.
Should this need to be m3db-dedicated-pool or is m3db-dedicated and m3db-dedicated-pool somehow related somewhere?
There was a problem hiding this comment.
So m3db-dedicated-pool the nodepool and m3db-dedicated the taint are two separate things, I wanted to convey that they could be named differently (like foo and bar even). Maybe I should make them even more different to clarify that? Or can just mention it
scripts/prep_changelog.sh
Outdated
|
|
||
| # Script for transforming non-hyperlink changelog entries into ones with | ||
| # hyperlinks using an opionated toolset (https://github.com/chmln/sd and | ||
| # https://github.com/BurntSushi/ripgrep). |
There was a problem hiding this comment.
Probably not worth doing now, but is there a way to bundle these in some cargo deps list so users can just make dependencies and get these installed for free locally?
There was a problem hiding this comment.
I should just stop being lazy and make it work with grep and sed
schallert
force-pushed
the
schallert/0_2_0_docs
branch
from
b5addc8
to
61da7b6
Compare
- Changelog entries for 0.2.0 - Docs on new features (tolerations, expanded node affinity)
schallert
force-pushed
the
schallert/0_2_0_docs
branch
from
e62f3ad
to
7159b43
Compare
|
Landing now to get fixes on a tagged release, will follow up for doc feedback if there's more. |
