feat: Reference internal-tls TF file in docs#333
Open
MichaelThamm wants to merge 9 commits intomainfrom
Open
Conversation
MichaelThamm
commented
May 8, 2026
MichaelThamm
commented
May 8, 2026
3 tasks
sinapah
approved these changes
May 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 Terraformsection you can see the HCL broken up into 3 parts:this is because the first and last part are being tested by our
tests/integrationand 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.tffile 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
Context
Eventually we need to conform to the CC008 spec:
This will simplify the docs and make them truly "infallible".
Testing Instructions
Upgrade Notes