From 11e540000f8ef49d4441a027282849f632d36a37 Mon Sep 17 00:00:00 2001 From: Dalton Hubble Date: Sat, 10 Dec 2022 09:47:59 -0800 Subject: [PATCH] Update CHANGES to reiterate Terraform Module Registry deprecation * Terraform supports sourcing modules from either Git repos or from their own hosted Terraform Module Registry, introduced a few years ago * Typhoon docs have always shown using Git-based module sources, not the Terraform Module Registry. For example, module usage should be `source = "git::https://github.com/poseidon/typhoon/...` not `source = poseidon/kubernetes/...` * Typhoon published Flatcar Linux modules (CoreOS Container Linux at the time) to Terraform Module Registry, but the approach has a number of drawbacks for publishers and for users. * Terraform's Module Registry requires subtree mirroring Typhoon to special terraform-platform-kubernetes repos. This distorts Git history, requires special automation, and the registry's naming requirements don't allow us to publish our full matrix of modules (Fedora CoreOS and Flatcar Linux, across AWS, Azure, GCP, on-prem, and DigitalOcean) * Terraform's Module Registry only supports release versions (no commit SHAs or forks) * Ultimately, the Terraform Module Registry limits user flexibility, has tedious publishing constraints, and introduces centralization where the current decentralized Git-based approach is simpler and more featureful Note: This does not affect Terraform _Providers_ like `poseidon/matchbox` or `poseidon/ct`. For Terraform providers, Terraform's centralized platform eases provider plugin installation and provides value --- CHANGES.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGES.md b/CHANGES.md index b439e3dc..e3cecc18 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -10,6 +10,8 @@ Notable changes between versions. * Update etcd from v3.5.5 to [v3.5.6](https://github.com/etcd-io/etcd/releases/tag/v3.5.6) * Update Cilium from v1.12.3 to [v1.12.4](https://github.com/cilium/cilium/releases/tag/v1.12.4) * Update flannel from v0.15.1 to [v0.20.2](https://github.com/flannel-io/flannel/releases/tag/v0.20.2) +* Reminder: Modules are no longer published to the [Terraform Module Registry](https://registry.terraform.io/search/modules?q=poseidon) ([#1282](https://github.com/poseidon/typhoon/pull/1282)) + * See [#1282](https://github.com/poseidon/typhoon/pull/1282) and [v1.25.4](https://github.com/poseidon/typhoon/releases/tag/v1.25.4) for details ### AWS @@ -34,6 +36,11 @@ Notable changes between versions. * Link to new Mastodon account for release announcements * [@typhoon@fosstodon.org](https://fosstodon.org/@typhoon) * [@poseidon@fosstodon.org](https://fosstodon.org/@poseidon) +* Deprecate publishing to the [Terraform Module Registry](https://registry.terraform.io/search/modules?q=poseidon) + * Typhoon docs have always shown using Git-based module sources, not the Terraform Module Registry + * Module usage should be `source = "git::https://github.com/poseidon/typhoon/...` not `source = poseidon/kubernetes/...` + * Terraform's Module Registry requires subtree mirroring typhoon to special terraform-platform-kubernetes repos, only supports release versions (no commit SHAs or forks), only ever contained Flatcar Linux modules (not Fedora CoreOS) for historical reasons + * Note, this does not affect Terraform Providers like `poseidon/matchbox` or `poseidon/ct`, the registry works well for providers ### Fedora CoreOS