Skip to content

feat: Reference internal-tls TF file in docs#333

Open
MichaelThamm wants to merge 9 commits intomainfrom
feat/jubilant-less-itests
Open

feat: Reference internal-tls TF file in docs#333
MichaelThamm wants to merge 9 commits intomainfrom
feat/jubilant-less-itests

Conversation

@MichaelThamm
Copy link
Copy Markdown
Contributor

@MichaelThamm MichaelThamm commented May 7, 2026

Issue

This moves us in the direction of infaliable docs. We want to have our TF modules in docs tested so that we have guarantee we are not misleading our users.

In tandem with these docs:

Solution

In the Deploy COS Lite using Terraform section you can see the HCL broken up into 3 parts:
image

this is because the first and last part are being tested by our tests/integration and are infallible.

This is a step in the right direction, but is not the complete "infallible" story. The problem is that the itest requires Jubilant to create temp models, however the user is expected to create them in the tutorials. This is why I added a cos-meta.tf file in the docs/tutorials dir so we can reference this in all our docs for TF API usage. This also means that if we change the model creation UX in TF then we only need to update this in one place.

Checklist

  • I have added or updated relevant documentation.
  • PR title makes an appropriate release note and follows conventional commits syntax.
  • Merge target is the correct branch, and relevant tandem backport PRs opened.

Context

Eventually we need to conform to the CC008 spec:

Juju models are defined in Product modules, and then fed to the various charm modules and component models that consume juju model UUIDs as inputs. Since product modules may generally be user-facing, product teams may decide to expose the model name as input variable to either create or consume a model. The TF resource (either juju_model resource or data juju model) is then used to pass the related UUID to charm and component modules.

This will simplify the docs and make them truly "infallible".

Testing Instructions

Upgrade Notes

MichaelThamm and others added 3 commits May 7, 2026 14:33
Co-authored-by: Copilot <copilot@github.com>
@MichaelThamm MichaelThamm requested a review from a team as a code owner May 7, 2026 19:16
@MichaelThamm MichaelThamm changed the title feat: Doc anchor in tests and general cleanup feat: Doc anchor in tests and COS install cleanup May 7, 2026
@MichaelThamm MichaelThamm changed the title feat: Doc anchor in tests and COS install cleanup feat: Reference internal-tls TF file in docs May 7, 2026
Comment thread docs/tutorial/cos-lite-microk8s-sandbox.md
Comment thread docs/tutorial/cos-lite-microk8s-sandbox.md Outdated
Comment thread tests/integration/cos_lite/tls_internal/track-dev.tf Outdated
Comment thread tests/integration/cos/tls_internal/track-dev.tf Outdated
@MichaelThamm MichaelThamm mentioned this pull request May 8, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants