Skip to content

docs(sso): note that auth params are Terraform/multi_sso format only#103

Open
drernie wants to merge 2 commits intomainfrom
docs-sso
Open

docs(sso): note that auth params are Terraform/multi_sso format only#103
drernie wants to merge 2 commits intomainfrom
docs-sso

Conversation

@drernie
Copy link
Copy Markdown
Member

@drernie drernie commented Mar 14, 2026

Summary

  • Adds a clarifying note to EXAMPLES.md Authentication Examples section explaining these use the Terraform IAC module (multi_sso: true) format
  • Adds a clarifying note to VARIABLES.md Authentication Parameters section with the same context
  • Both notes cross-link to the technical reference for CloudFormation Console / Marketplace users who use a different parameter set (SingleSignOnProvider dropdown)

Background

Two SSO deployment formats exist:

  • CFT Console / Marketplace (50+ customer deployments): SingleSignOnProvider dropdown + shared SingleSignOnClientId/Secret/BaseUrl
  • Terraform IAC module (multi_sso: true): per-provider params documented here

Companion PR: quiltdata/quilt#4771

🤖 Generated with Claude Code

Greptile Summary

This PR primarily adds clarifying notes to EXAMPLES.md and VARIABLES.md explaining that the authentication parameters (GoogleAuth, AzureAuth, etc.) are specific to Terraform IAC module deployments (multi_sso: true) and cross-links to the technical reference for CloudFormation Console/Marketplace users. It also bundles the 1.6.0 release, which changes the default Elasticsearch instance types from Intel m5 to Graviton2 m6g across all documentation and the live Terraform module defaults.

Key changes:

  • New SSO clarifying notes added to the Authentication Examples section in EXAMPLES.md and the Authentication Parameters section in VARIABLES.md, correctly distinguishing Terraform vs. CFT Console parameter formats.
  • Default instance type change (modules/quilt/variables.tf): search_instance_type changed from m5.xlarge.elasticsearchm6g.xlarge.elasticsearch and search_dedicated_master_type from m5.large.elasticsearchm6g.large.elasticsearch. This is a potentially impactful change for existing users who rely on module defaults and upgrade without pinning their instance type.
  • Inconsistent migration: m5.12xlarge.elasticsearch in the "Extreme Scale" / "XXX-Large" / "XXXX-Large" examples in EXAMPLES.md (line 313) and README.md (lines 868, 880) were not updated to m6g, unlike all other instance sizes.
  • CHANGELOG link references: The new [1.6.0] entry is missing its link definition at the bottom of CHANGELOG.md, and the [Unreleased] comparison link still targets 1.5.0...HEAD instead of 1.6.0...HEAD.

Confidence Score: 4/5

  • Safe to merge with minor documentation consistency fixes recommended.
  • The SSO documentation notes are accurate and helpful. The Terraform default change is intentional and changelog-documented. The two issues found (missed m5.12xlarge → m6g migration and missing CHANGELOG link references) are purely documentation/cosmetic and do not affect runtime behavior or infrastructure correctness.
  • CHANGELOG.md (missing [1.6.0] link reference and stale [Unreleased] link), EXAMPLES.md and README.md (leftover m5.12xlarge.elasticsearch references not migrated to m6g).

Important Files Changed

Filename Overview
modules/quilt/variables.tf Updates default search_instance_type from m5.xlarge.elasticsearch to m6g.xlarge.elasticsearch and search_dedicated_master_type from m5.large.elasticsearch to m6g.large.elasticsearch. Clean and correct change.
CHANGELOG.md Adds a new [1.6.0] entry for the Graviton2 default instance type change, but missing the [1.6.0] link reference at the bottom of the file and the [Unreleased] link still points to 1.5.0...HEAD instead of 1.6.0...HEAD.
EXAMPLES.md Updates m5 → m6g instance types throughout, adds the SSO clarifying note, but misses updating the m5.12xlarge.elasticsearch in the "Extreme Scale" example at line 313.
README.md Updates m5 → m6g instance type documentation throughout minimum/production requirements sections, but misses updating m5.12xlarge.elasticsearch in the "XXX-Large" and "XXXX-Large" sizing examples at lines 868 and 880.
VARIABLES.md Updates default instance type documentation from m5 to m6g, and adds the SSO clarifying note to the Authentication Parameters section. No issues found.
examples/main.tf Updates m5 → m6g instance types in commented/active configuration examples, along with minor trailing whitespace cleanup. Clean change.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Quilt Deployment] --> B{Deployment Method?}

    B --> C[CloudFormation Console\nor AWS Marketplace]
    B --> D[Terraform IAC Module]

    C --> E[SSO Parameters\nSingleSignOnProvider\nSingleSignOnClientId\nSingleSignOnClientSecret\nSingleSignOnBaseUrl]

    D --> F[SSO Parameters\nmulti_sso: true\nGoogleAuth / GoogleClientId / GoogleClientSecret\nOktaAuth / OktaBaseUrl / OktaClientId / OktaClientSecret\nAzureAuth / AzureClientId / AzureClientSecret\nOneLoginAuth / OneLoginBaseUrl / ...]

    E --> G[Single provider\nshared params]
    F --> H[Multiple simultaneous\nproviders supported]

    D --> I[Default ES Instance Types\nv1.6.0 Change]
    I --> J[Data Nodes: m6g.xlarge.elasticsearch\nMaster Nodes: m6g.large.elasticsearch\nGraviton2 - better price/perf]
Loading

Comments Outside Diff (2)

  1. EXAMPLES.md, line 313 (link)

    Missed m5 → m6g migration for extreme-scale example

    All other instance types in this file were updated from m5 to m6g, but this "Extreme Scale" example at line 313 still references m5.12xlarge.elasticsearch. The same oversight exists in README.md at lines 868 and 880 (the "XXX-Large" and "XXXX-Large" sections). For documentation consistency, these should be updated to m6g.12xlarge.elasticsearch if that instance size is available in the target regions.

  2. CHANGELOG.md, line 84-85 (link)

    Missing [1.6.0] link reference and stale [Unreleased] link

    The [1.6.0] section header was added but its comparison link is missing at the bottom of the file (the link definitions section). Additionally, the [Unreleased] link still compares against 1.5.0...HEAD rather than 1.6.0...HEAD. Both will render as non-clickable text in rendered Markdown.

Last reviewed commit: fa113a0

@claude
Copy link
Copy Markdown

claude bot commented Mar 14, 2026

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review.

CloudFormation Console and Marketplace deployments use a different
parameter set (SingleSignOnProvider dropdown). Add clarifying notes
with cross-links to the technical reference.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@drernie
Copy link
Copy Markdown
Member Author

drernie commented Mar 14, 2026

Not sure if this is necessary, but there was enough confusion it felt worth proposing.

…meter format

The per-provider params (GoogleAuth, AzureAuth, etc.) apply to stacks built
with multi_sso: true — not specifically to Terraform deployments. A TF-deployed
stack with multi_sso: false still uses the SingleSignOn* params. Reframe both
notes around the multi_sso build flag and add a practical check (look for the
SingleSignOnProvider dropdown) so users can self-diagnose.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

1 participant