Skip to content

Add Atmos Auth guides and blog post#1659

Merged
osterman merged 11 commits intodocs/leapp-atmosauth-migrationfrom
osterman/auth-docs-improvements
Oct 18, 2025
Merged

Add Atmos Auth guides and blog post#1659
osterman merged 11 commits intodocs/leapp-atmosauth-migrationfrom
osterman/auth-docs-improvements

Conversation

@osterman
Copy link
Member

what

  • New Guide: Configuring Geodesic with Atmos Auth: This guide provides detailed instructions on integrating atmos auth with Geodesic. It covers updating the Geodesic Dockerfile with necessary environment variables, configuring the Makefile for automatic authentication, and setting up source profiles for assume-role utilities.
  • Updated Leapp Migration Guide: The existing guide for migrating from Leapp has been updated to remove the embedded Geodesic configuration section. It now includes a cross-reference to the new standalone Geodesic guide.
  • New Blog Post: A new blog post introduces the two authentication guides, highlighting the benefits of atmos auth and providing clear getting started instructions. The blog post has been streamlined, removing specific "Why These Guides Matter" and "What's Next" chapters.
  • Fixes:
    • Corrected AWS region inconsistency in the Leapp migration guide from us-east-2 to us-east-1 to match the Leapp session reference.
    • Resolved an issue in the Leapp migration guide where AWS_CONFIG_FILE was being redefined, by introducing AWS_CONFIG_TEAMS to preserve the Atmos authentication configuration path.

why

  • Improved Documentation: The creation of a dedicated guide for Geodesic integration enhances clarity and usability for teams using both tools.
  • Better Separation of Concerns: Moving the Geodesic configuration to its own guide makes the Leapp migration guide more focused and easier to follow.
  • Increased Adoption: The blog post serves as an announcement and introduction, encouraging users to explore and adopt the new authentication features.
  • Accuracy and Consistency: Fixing the region inconsistency and the AWS_CONFIG_FILE redefinition ensures the documentation is accurate and prevents potential user confusion and configuration errors.

references

osterman and others added 5 commits October 18, 2025 08:08
Updated provider region from us-east-2 to us-east-1 to match the Leapp
session example shown in the documentation (US-EAST-1). This ensures
users copying the example will use the correct region that corresponds
to their Leapp configuration reference.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Changed the second AWS_CONFIG_FILE assignment to use AWS_CONFIG_TEAMS
to avoid clobbering the Atmos-managed config path. This ensures that:

- AWS_CONFIG_FILE points to Atmos auth config (required for authentication)
- AWS_CONFIG_TEAMS points to teams config (for assume-role utilities)

Added a note explaining the separation and how to update Geodesic
utilities that reference the teams config.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Created comprehensive documentation for configuring Geodesic with
Atmos Auth and introduced both guides with a blog post:

New Files:
- website/docs/cli/commands/auth/tutorials/configuring-geodesic-with-atmos-auth.mdx
  Complete guide for integrating Geodesic with Atmos Auth, including:
  - Dockerfile environment variable configuration
  - Makefile automatic login setup
  - Source profile configuration for assume-role
  - Complete working examples and troubleshooting

- website/blog/2025-10-18-auth-tutorials-geodesic-leapp.md
  Blog post announcing the new auth guides with:
  - Overview of what's new
  - Key benefits of using Atmos Auth
  - Getting started instructions
  - Links to detailed guides

Modified Files:
- website/docs/cli/commands/auth/tutorials/migrating-from-leapp.mdx
  Replaced inline Geodesic integration section with reference to
  the new dedicated guide, keeping Leapp migration guide focused

This reorganization provides better separation of concerns and makes
it easier to maintain and discover each guide independently.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Dropped "Why These Guides Matter" and "What's Next" sections to
keep the blog post more focused and concise.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@osterman osterman requested a review from a team as a code owner October 18, 2025 13:19
@mergify mergify bot added stacked Stacked triage Needs triage labels Oct 18, 2025
Renamed configuring-geodesic-with-atmos-auth.mdx to
configuring-geodesic.mdx for a cleaner, more concise filename.

Updated all references in:
- migrating-from-leapp.mdx
- blog post
- internal document id

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
osterman and others added 3 commits October 18, 2025 08:24
Added explicit clarification that authentication happens on the host
machine (laptop), not inside the Geodesic container:

- New "How Authentication Works" section explaining the flow
- Expanded workflow with clear host vs container context
- Updated troubleshooting to emphasize host-based re-authentication
- Added keychain integration note explaining limitations in containers
- Clarified that browser-based SSO requires host machine access

This addresses confusion about where atmos auth login runs and when
keychain integration is available.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Updated Geodesic section in blog post to emphasize:
- Authentication happens on host machine (laptop)
- Authentication occurs before container starts, not inside it
- Keychain integration limitations with containers

This aligns with the detailed clarifications added to the guide itself.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Changed "clarifies" to "covers" and "explains" - the blog post
should describe what the guide contains, not frame it as fixing
or clarifying previous documentation since this is net-new content.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@codecov
Copy link

codecov bot commented Oct 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66.01%. Comparing base (6f7b06f) to head (727261a).
⚠️ Report is 1 commits behind head on docs/leapp-atmosauth-migration.

Additional details and impacted files

Impacted file tree graph

@@                        Coverage Diff                         @@
##           docs/leapp-atmosauth-migration    #1659      +/-   ##
==================================================================
- Coverage                           66.01%   66.01%   -0.01%     
==================================================================
  Files                                 343      343              
  Lines                               38686    38686              
==================================================================
- Hits                                25539    25537       -2     
- Misses                              11153    11156       +3     
+ Partials                             1994     1993       -1     
Flag Coverage Δ
unittests 66.01% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Changed Dockerfile variables to use proper Atmos naming:
- DEFAULT_ATMOS_PROVIDER → ATMOS_AUTH_PROVIDER
- DEFAULT_ATMOS_IDENTITY → ATMOS_AUTH_IDENTITY

Also added ATMOS_IDENTITY env var which Atmos actually reads to
determine the default identity (as documented in auth env docs).

The previous naming (DEFAULT_*) didn't follow Atmos conventions and
could be confused with actual Atmos environment variables. The new
names make it clear these are Geodesic-specific build args used to
construct credential paths, while ATMOS_IDENTITY is the actual env
var that Atmos reads.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Created comprehensive announcement post for atmos auth release,
backdated to v1.194.1 release (Oct 13, 2025).

The post covers:
- The authentication problem platform teams face
- Why existing solutions (Leapp, aws-vault, etc.) fall short
- How atmos auth solves these problems
- That it can be used standalone, not just with full Atmos
- Configuration as code approach vs wiki-ops
- Getting started guide and examples

Emphasizes that this solves a problem teams face repeatedly,
inspired by aws-vault and aws2saml, but built natively into
Atmos for better integration and shared configuration.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@osterman osterman merged commit 28e48f1 into docs/leapp-atmosauth-migration Oct 18, 2025
47 checks passed
@osterman osterman deleted the osterman/auth-docs-improvements branch October 18, 2025 17:59
@mergify mergify bot removed the triage Needs triage label Oct 18, 2025
osterman added a commit that referenced this pull request Oct 20, 2025
* initial migration guide

* remove extra image

* update docs

* bugfix build and update docs a bit for makefile and source profiles

* fix links

* Update image and guide

* update guide

* Add Atmos Auth guides and blog post (#1659)

* Fix AWS region inconsistency in Leapp migration docs

Updated provider region from us-east-2 to us-east-1 to match the Leapp
session example shown in the documentation (US-EAST-1). This ensures
users copying the example will use the correct region that corresponds
to their Leapp configuration reference.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Fix AWS_CONFIG_FILE redefinition in Geodesic Dockerfile

Changed the second AWS_CONFIG_FILE assignment to use AWS_CONFIG_TEAMS
to avoid clobbering the Atmos-managed config path. This ensures that:

- AWS_CONFIG_FILE points to Atmos auth config (required for authentication)
- AWS_CONFIG_TEAMS points to teams config (for assume-role utilities)

Added a note explaining the separation and how to update Geodesic
utilities that reference the teams config.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Add Geodesic guide and blog post for auth tutorials

Created comprehensive documentation for configuring Geodesic with
Atmos Auth and introduced both guides with a blog post:

New Files:
- website/docs/cli/commands/auth/tutorials/configuring-geodesic-with-atmos-auth.mdx
  Complete guide for integrating Geodesic with Atmos Auth, including:
  - Dockerfile environment variable configuration
  - Makefile automatic login setup
  - Source profile configuration for assume-role
  - Complete working examples and troubleshooting

- website/blog/2025-10-18-auth-tutorials-geodesic-leapp.md
  Blog post announcing the new auth guides with:
  - Overview of what's new
  - Key benefits of using Atmos Auth
  - Getting started instructions
  - Links to detailed guides

Modified Files:
- website/docs/cli/commands/auth/tutorials/migrating-from-leapp.mdx
  Replaced inline Geodesic integration section with reference to
  the new dedicated guide, keeping Leapp migration guide focused

This reorganization provides better separation of concerns and makes
it easier to maintain and discover each guide independently.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Remove unnecessary sections from blog post

Dropped "Why These Guides Matter" and "What's Next" sections to
keep the blog post more focused and concise.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Changes auto-committed by Conductor

* Rename Geodesic guide to remove redundant suffix

Renamed configuring-geodesic-with-atmos-auth.mdx to
configuring-geodesic.mdx for a cleaner, more concise filename.

Updated all references in:
- migrating-from-leapp.mdx
- blog post
- internal document id

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Clarify authentication flow for Geodesic integration

Added explicit clarification that authentication happens on the host
machine (laptop), not inside the Geodesic container:

- New "How Authentication Works" section explaining the flow
- Expanded workflow with clear host vs container context
- Updated troubleshooting to emphasize host-based re-authentication
- Added keychain integration note explaining limitations in containers
- Clarified that browser-based SSO requires host machine access

This addresses confusion about where atmos auth login runs and when
keychain integration is available.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Update blog post to clarify host-based authentication

Updated Geodesic section in blog post to emphasize:
- Authentication happens on host machine (laptop)
- Authentication occurs before container starts, not inside it
- Keychain integration limitations with containers

This aligns with the detailed clarifications added to the guide itself.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Remove change-oriented language from blog post

Changed "clarifies" to "covers" and "explains" - the blog post
should describe what the guide contains, not frame it as fixing
or clarifying previous documentation since this is net-new content.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Update Geodesic env vars to follow Atmos conventions

Changed Dockerfile variables to use proper Atmos naming:
- DEFAULT_ATMOS_PROVIDER → ATMOS_AUTH_PROVIDER
- DEFAULT_ATMOS_IDENTITY → ATMOS_AUTH_IDENTITY

Also added ATMOS_IDENTITY env var which Atmos actually reads to
determine the default identity (as documented in auth env docs).

The previous naming (DEFAULT_*) didn't follow Atmos conventions and
could be confused with actual Atmos environment variables. The new
names make it clear these are Geodesic-specific build args used to
construct credential paths, while ATMOS_IDENTITY is the actual env
var that Atmos reads.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Add blog post introducing atmos auth feature

Created comprehensive announcement post for atmos auth release,
backdated to v1.194.1 release (Oct 13, 2025).

The post covers:
- The authentication problem platform teams face
- Why existing solutions (Leapp, aws-vault, etc.) fall short
- How atmos auth solves these problems
- That it can be used standalone, not just with full Atmos
- Configuration as code approach vs wiki-ops
- Getting started guide and examples

Emphasizes that this solves a problem teams face repeatedly,
inspired by aws-vault and aws2saml, but built natively into
Atmos for better integration and shared configuration.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>

* Update website/docs/cli/commands/auth/tutorials/configuring-geodesic.mdx

Co-authored-by: Dan Miller <miller0daniel@gmail.com>

* Refactor Leapp migration docs for clarity (#1668)

* Changes auto-committed by Conductor

* Changes auto-committed by Conductor

* Changes auto-committed by Conductor

* Update website/docs/cli/commands/auth/tutorials/configuring-geodesic.mdx

Co-authored-by: Dan Miller <miller0daniel@gmail.com>

---------

Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <erik@cloudposse.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Dan Miller <miller0daniel@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stacked Stacked

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant