Pin etcd client version #148
Conversation
Always use `go.etcd.io/etcd` over `github.com/coreos/etcd` or `github.com/etcd-io/etcd`.
| @@ -4,6 +4,8 @@ go 1.13 | |||
|
|
|||
| // Pin k8s.io/* dependencies to kubernetes-1.16.0 to match controller-runtime v0.4.0 | |||
| replace ( | |||
| // This must match the version below | |||
| go.etcd.io/etcd => go.etcd.io/etcd v0.0.0-20191023171146-3cf2f69b5738 | |||
There was a problem hiding this comment.
Actually, this doesn't have to match the version below. replace directives are always used regardless of the require directives below IF you are building the current module.
If something imports this module, then the replace directives are ignored, at which point those people depending on us may need a similar replace directive in their own module.
There was a problem hiding this comment.
Would you say it's 'good practice' to match as below?
| github.com/dustinkirkland/golang-petname v0.0.0-20190613200456-11339a705ed2 | ||
| github.com/go-logr/logr v0.1.0 | ||
| github.com/google/go-cmp v0.3.0 | ||
| github.com/google/gofuzz v1.0.0 | ||
| github.com/robfig/cron/v3 v3.0.0 | ||
| github.com/stretchr/testify v1.4.0 | ||
| go.etcd.io/etcd v3.3.17+incompatible | ||
| // Pin spesific etcd version via tag. See https://github.com/etcd-io/etcd/pull/11477 | ||
| go.etcd.io/etcd v0.0.0-20191023171146-3cf2f69b5738 |
There was a problem hiding this comment.
iirc these get re-written by go mod tidy anyway - if you just had the commit ref here it should work (and go mod will automatically compute to v0.0.0-* version of the ref)
There was a problem hiding this comment.
These get re-written by
go mod tidy
It doesn't seem to. I've run tidy a few times since I added this with no change.
I'm pretty much following the documentation for the version workaround.
There was a problem hiding this comment.
What I mean is if you added/manually specified the commit ref here, go mod tidy would rewrite it into the form you've written here 😄
I don't think using that linked script is necessary.. simply getting the ref for that tag and adding it here, then running go mod tidy should do it.
Thanks to the work of etcd-io/etcd#11477 we can pin our etcd client version to v3.4.3 instead of the v3.3.17 we were using. This has the limitation of needing to be careful upgraded when new versions come out (using the script in the previously linked pull request against etcd).
Note that the go.sum still references other versions of etcd:
Some investigation with
go mod treeseem to suggest thatgithub.com/coreos/etcd v3.3.15comes fromk8s.io/apiserverandk8s.io/apiextensions-apiserver.github.com/coreos/etcd v3.3.10ultimately comes fromsigs.k8s.io/kind, viagithub.com/spf13/cobraandgithub.com/spf13/viper.There's not a lot I can do about these, but I don't believe our code uses them.