Skip to content

docs: deprecate this repo in favor of the per-cloud modules (ENG-8762) - #17

Merged
johnsca merged 1 commit into
mainfrom
johnsca/chore/ENG-8762/retire-cur-setup
Sep 29, 2026
Merged

johnsca merged 1 commit into
mainfrom
johnsca/chore/ENG-8762/retire-cur-setup

Conversation

@johnsca

@johnsca johnsca commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

ENG-8762

what

Replaces the setup instructions in the README with a deprecation notice that sends readers to terraform-aws-stacklet-cur-setup or terraform-azure-stacklet-cost-setup, and adds a short migration section covering the input differences that stop either module from being a drop-in swap. Leaves the Terraform in the tree untouched.

why

Both clouds now have their own versioned module repository, and each carries fixes that this repo never received. As long as the README still reads as working instructions, a new customer who lands here follows an unmaintained path, so the README is the thing that has to redirect them.

The migration section stays deliberately thin, since both replacement repos document themselves well and the Azure one has a "Migrating to 1.0.0" section. It names only the three input differences a reader would otherwise hit as a surprise: the new Azure stacklet_principal_id, the dropped AWS s3_region, and the dropped clouds selector.

Nothing changes on the cloud-infra side yet. Marking the repo archived there is a separate decision, since the repo module has no archived support and the one precedent archived on GitHub first, then removed the module from state.

testing

  • uvx prek run --all-files passes.
  • Links in the rendered README resolve to the two module repos.

docs

This change is the docs change. The docs-service half of ENG-8762, which points customers at the correct repo, lands separately.

[ENG-8762](https://stacklet.atlassian.net/browse/ENG-8762)

What
----

- Replace the setup instructions in the README with a deprecation notice
  pointing at terraform-aws-stacklet-cur-setup and
  terraform-azure-stacklet-cost-setup.
- Add a short migration section covering the three input differences that
  stop either module from being a drop-in swap: the new Azure
  `stacklet_principal_id`, the dropped AWS `s3_region`, and the dropped
  `clouds` selector.

Why
----

- Both clouds now have a dedicated, versioned module repository, and each
  carries fixes this repo never received. Leaving working instructions here
  sends new users down an unmaintained path.
- The Terraform stays in place so existing users can still see what they
  deployed, so the README has to be the thing that redirects them.

Testing
----

- [x] `uvx prek run --all-files` passes.
- [ ] Links in the rendered README resolve to the two module repos.

Docs
----

This change is itself the docs change. The docs-service side of ENG-8762,
which links customers to the correct repo, is handled separately.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@johnsca
johnsca marked this pull request as ready for review September 29, 2026 20:17
@johnsca
johnsca requested a review from a team as a code owner September 29, 2026 20:17

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.
Architecture diagram
sequenceDiagram
    participant User as New Customer
    participant Repo as terraform-cur-setup (deprecated README)
    participant AWSMod as terraform-aws-stacklet-cur-setup
    participant AzureMod as terraform-azure-stacklet-cost-setup
    participant Docs as Module Documentation

    Note over User,Docs: Documentation Redirection Flow

    User->>Repo: Lands on deprecated repo README
    Repo->>Repo: Displays deprecation warning
    Repo-->>User: Redirects to cloud-specific modules

    alt AWS customer
        User->>AWSMod: Follows link to AWS module
        AWSMod->>Docs: PostgreSQL README
        Docs-->>AWSMod: Configuration instructions
        AWSMod-->>User: Inputs: customer_prefix, stacklet_saas_account_id
        Note over AWSMod: Region from configured aws provider
    else Azure customer
        User->>AzureMod: Follows link to Azure module
        AzureMod->>Docs: README + "Migrating to 1.0.0"
        Docs-->>AzureMod: Configuration instructions
        AzureMod-->>User: Inputs: customer_prefix, stacklet_principal_id
        Note over AzureMod: No provider block declared
    end

    Note over Repo: Terraform remains as historical record
    Note over User: Clouds input has no equivalent in modules
Loading

Re-trigger cubic

Comment thread README.md Resolved

@tvansteenburgh tvansteenburgh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @johnsca

@johnsca
johnsca merged commit ee47aaa into main Sep 29, 2026
3 checks passed
@johnsca
johnsca deleted the johnsca/chore/ENG-8762/retire-cur-setup branch September 29, 2026 20:32
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