Conversation
Claude Code ReviewThis repository is configured for manual code reviews. Comment |
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>
Member
Author
|
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
EXAMPLES.mdAuthentication Examples section explaining these use the Terraform IAC module (multi_sso: true) formatVARIABLES.mdAuthentication Parameters section with the same contextSingleSignOnProviderdropdown)Background
Two SSO deployment formats exist:
SingleSignOnProviderdropdown + sharedSingleSignOnClientId/Secret/BaseUrlmulti_sso: true): per-provider params documented hereCompanion PR: quiltdata/quilt#4771
🤖 Generated with Claude Code
Greptile Summary
This PR primarily adds clarifying notes to
EXAMPLES.mdandVARIABLES.mdexplaining 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 Intelm5to Graviton2m6gacross all documentation and the live Terraform module defaults.Key changes:
EXAMPLES.mdand the Authentication Parameters section inVARIABLES.md, correctly distinguishing Terraform vs. CFT Console parameter formats.modules/quilt/variables.tf):search_instance_typechanged fromm5.xlarge.elasticsearch→m6g.xlarge.elasticsearchandsearch_dedicated_master_typefromm5.large.elasticsearch→m6g.large.elasticsearch. This is a potentially impactful change for existing users who rely on module defaults and upgrade without pinning their instance type.m5.12xlarge.elasticsearchin the "Extreme Scale" / "XXX-Large" / "XXXX-Large" examples inEXAMPLES.md(line 313) andREADME.md(lines 868, 880) were not updated tom6g, unlike all other instance sizes.[1.6.0]entry is missing its link definition at the bottom ofCHANGELOG.md, and the[Unreleased]comparison link still targets1.5.0...HEADinstead of1.6.0...HEAD.Confidence Score: 4/5
[1.6.0]link reference and stale[Unreleased]link), EXAMPLES.md and README.md (leftoverm5.12xlarge.elasticsearchreferences not migrated tom6g).Important Files Changed
search_instance_typefromm5.xlarge.elasticsearchtom6g.xlarge.elasticsearchandsearch_dedicated_master_typefromm5.large.elasticsearchtom6g.large.elasticsearch. Clean and correct change.[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 to1.5.0...HEADinstead of1.6.0...HEAD.m5.12xlarge.elasticsearchin the "Extreme Scale" example at line 313.m5.12xlarge.elasticsearchin the "XXX-Large" and "XXXX-Large" sizing examples at lines 868 and 880.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]Comments Outside Diff (2)
EXAMPLES.md, line 313 (link)Missed m5 → m6g migration for extreme-scale example
All other instance types in this file were updated from
m5tom6g, but this "Extreme Scale" example at line 313 still referencesm5.12xlarge.elasticsearch. The same oversight exists inREADME.mdat lines 868 and 880 (the "XXX-Large" and "XXXX-Large" sections). For documentation consistency, these should be updated tom6g.12xlarge.elasticsearchif that instance size is available in the target regions.CHANGELOG.md, line 84-85 (link)Missing
[1.6.0]link reference and stale[Unreleased]linkThe
[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 against1.5.0...HEADrather than1.6.0...HEAD. Both will render as non-clickable text in rendered Markdown.Last reviewed commit: fa113a0