Skip to content

docs: add preview-bucket-01 tutorial (multi-cloud bucket audit) - #716

Merged
general-kroll-4-life merged 2 commits into
stackql:mainfrom
nirmalpatel008:tutorial/preview-bucket-01
Aug 18, 2026
Merged

general-kroll-4-life merged 2 commits into
stackql:mainfrom
nirmalpatel008:tutorial/preview-bucket-01

Conversation

@nirmalpatel008

Copy link
Copy Markdown
Contributor

Adds a new tutorial under docs/tutorials/preview-bucket-01/ that runs a cross-cloud storage bucket audit against AWS, GCP, and Azure in one Docker command.

Discussed and approved in Slack (#stackql-socials, 15 Aug) — first of the "docs/tutorials/" convention we agreed to establish for reader-facing walkthroughs that live alongside the main repo.

What's in this PR

  • README.md — standalone tutorial walkthrough
  • docker-compose.bucket.audit.yaml — pinned to stackql/stackql:v0.10.601, with the AWS_REGION region substitution fix so the query is env-driven rather than hardcoded
  • audit/.env.audit.example — env template, blank values, safe to commit
  • .gitignore — excludes audit/.env.audit (real credentials) and audit/output/*
  • audit/output/.gitkeep — placeholder so the output folder exists

Tested

Ran end-to-end against real cross-cloud credentials tonight. Audit returned 225 rows across AWS, GCP, and Azure. Both the region substitution fix and the v0.10.601 pin verified working.

Related

Companion blog post ("Auditing three clouds without writing three scripts") going to stackql.io/blog tomorrow after review.

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.

# Never commit real credentials
audit/.env.audit

# Ignore any audit output artefacts

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.

you can remove this section once the .gitkeep -> .gitignore change is done

- Replace audit/output/.gitkeep with .gitignore (self-documenting pattern matching cicd/vol/vendor-secrets/.gitignore)

- Simplify root .gitignore (drop redundant output rules)

- Remove --env-file from tutorial run command (verified redundant with env_file directive in compose; audit returns identical output either way)
@nirmalpatel008

Copy link
Copy Markdown
Contributor Author

Both review comments addressed in 588fcc9.

Also verified the --env-file flag — you were right, it was redundant. env_file: in the compose is enough on its own, both with and without the CLI flag return identical output. Removed the flag from the README run command and dropped the paragraph that referenced it.

Ready for re-review whenever you have a moment.

@general-kroll-4-life
general-kroll-4-life merged commit 6c14a39 into stackql:main Aug 18, 2026
3 checks passed
social4hyq pushed a commit to social4hyq/homebrew-core that referenced this pull request Sep 20, 2026
stackql 0.10.605

Created-by: HarmonybrewBot
Commit-by: HarmonybrewBot
Merged-by: HarmonybrewBot
Description: Created by `brew bump`

---

Created with `brew bump-formula-pr`.<details>
  <summary>release notes</summary>
  <pre>## What's Changed
* embedded-mcp-packaging by @jeffreyaven in stackql/stackql#718
* preview-access-audit-plus-unstable by @general-kroll-4-life in stackql/stackql#719
* docs: add preview-bucket-01 tutorial (multi-cloud bucket audit) by @nirmalpatel008 in stackql/stackql#716
* immutable-release-assets + retire gleam/kotlin/swift by @jeffreyaven in stackql/stackql#720

## New Contributors
* @nirmalpatel008 made their first contribution in stackql/stackql#716

**Full Changelog**: https://github.com/stackql/stackql/compare/v0.10.601...v0.10.605</pre>
  <p>View the full release notes at <a href="https://github.com/stackql/stackql/releases/tag/v0.10.605">https://github.com/stackql/stackql/releases/tag/v0.10.605</a>.</p>
</details>
<hr>

See merge request: Harmonybrew/homebrew-core!17203
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