From 607c64a286ea348712bc4ec64976ae07c1d2dfbc Mon Sep 17 00:00:00 2001 From: Cory Johns Date: Tue, 29 Sep 2026 19:54:44 +0000 Subject: [PATCH] docs: deprecate this repo in favor of the per-cloud modules (ENG-8762) [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 --- README.md | 97 ++++++++++++++++++------------------------------------- 1 file changed, 31 insertions(+), 66 deletions(-) diff --git a/README.md b/README.md index bcdf443..4a4c742 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,33 @@ # Cost and Usage Report (CUR) setup for Stacklet customers -This repository provides automation for setting up a CUR in your organizational account in such a way that the Stacklet platform, running in a different account, can access and use the CUR data. - -More background information, along with instructions for accomplishing the same thing via the AWS console, can be found in the Stacklet documentation. - -## AWS - -> [!TIP] -> For AWS users, a Terraform module is available at https://github.com/stacklet/terraform-aws-stacklet-cur-setup - -### Overview - -The terraform in this repository is meant to be applied in your organization's payer account, independent of any account in which the Stacklet platform is running, and must be applied by a role that has permissions to create a new CUR in the AWS billing console. - -It does the following: - -* Creates an S3 bucket named `-stacklet-shared-cur` in your organization's account -* Creates an hourly CUR, with resource IDs, in parquet format, which is written to the S3 bucket -* Grants limited read permissions to the S3 bucket, by the `-cur-read` role in the Stacklet platform SAAS account - -This setup ensures that the CUR is in the format required by Stacklet, and that the Stacklet platform SAAS account can read CUR data in the correct S3 bucket. - -### Inputs - -The terraform accepts three inputs: - -* `customer_prefix` - (required) The customer prefix -* `stacklet_saas_account_id` - (required) The account ID where the Stacklet platform for this customer is deployed -* `s3_region` - (optional) AWS region where the s3 bucket is created (default: us-east-1) -* `clouds` - (required) List of clouds to set up, requires ["aws"] - -If you need help identifying the correct values for `customer_prefix` and `stacklet_saas_account_id`, please contact Stacklet customer service. - -## Azure - -### Overview - -The terraform in this repository is meant to be applied in each subscription, independent of any account in which the Stacklet platform is running, and must be applied by a user or service principal that has permissions to create Cost Management exports, storage accounts, and resource groups. Stacklet utilizes credentials provided in Stacklet to read from the created Storage Account. - -It does the following: - -* Creates a Resource Group to contain all created resources -* Creates a Storage Account to store cost management exports -* Creates a Cost Management export job to push data into the Storage Account - -This setup ensures that the Cost Management export is in the format required by Stacklet. - -### Inputs - -The terraform accepts three inputs: - -* `customer_prefix` - (required) The customer prefix -* `clouds` - (required) List of clouds to set up, requires ["azure"] -* `resource_group_location` - (required) Resource Group Location - -If you need help identifying the correct value for `customer_prefix`, please contact Stacklet customer service. - -## Running the Terraform - -Make sure you update the `export`s below with real values. - -```bash -cd terraform/ -terraform init -terraform plan -terraform apply - ``` +> [!WARNING] +> This repository is deprecated and no longer maintained. Use the dedicated +> module for your cloud instead: +> +> * AWS: [terraform-aws-stacklet-cur-setup](https://github.com/stacklet/terraform-aws-stacklet-cur-setup) +> * Azure: [terraform-azure-stacklet-cost-setup](https://github.com/stacklet/terraform-azure-stacklet-cost-setup) + +This repository configured cost reporting in your cloud account, so that the +Stacklet platform running elsewhere could read it. That automation now lives in +the two repositories above, one per cloud. Each is a reusable Terraform module +with its own documentation, and each carries fixes that this repository never +received. + +The Terraform here remains only as a record of what existing users deployed. Do +not start a new setup from it. + +## Migrating + +Follow the README of the repository for your cloud. Neither module is a drop-in +replacement for what is here. + +* The Azure module requires a new `stacklet_principal_id` input, and it declares + no provider block. Its README covers both changes under "Migrating to 1.0.0". +* The AWS module drops the `s3_region` input and takes the region from the + `aws` provider that the caller configures. Set a region on that provider, or + in the environment, since the module no longer defaults to `us-east-1`. +* Each module covers a single cloud, so the `clouds` input has no equivalent. + Apply the module for the cloud you need. + +Contact Stacklet customer service for help identifying `customer_prefix` or any +other Stacklet-supplied value.