[TT-17927] Update documentation for master - #2796
Merged
Merged
probelabs / Visor: architecture
succeeded
Aug 31, 2026 in 30s
✅ Check Passed (Warnings Found)
architecture check passed. Found 1 warning, but fail_if condition was not met.
Details
📊 Summary
- Total Issues: 1
- Warning Issues: 1
🔍 Failure Condition Results
Passed Conditions
- global_fail_if: Condition passed
Issues by Category
Architecture (1)
⚠️ snippets/dashboard-config.mdx:629 - The configuration structure for IAM-based storage authentication is inconsistent across different Tyk components. In the Dashboard, it is defined as a top-levelredis_iam_authblock. However, in other components like the Gateway, MDCB, and Pump, the equivalent configuration is nested within the specific storage block it applies to (e.g.,storage.iam_auth,analytics_storage.iam_auth). This architectural inconsistency can create confusion for operators who need to configure multiple components in a Tyk stack, as they must remember different structural patterns for the same feature.
Powered by Visor from Probelabs
💡 TIP: You can chat with Visor using /visor ask <your question>
Annotations
Check warning on line 653 in snippets/dashboard-config.mdx
probelabs / Visor: architecture
architecture Issue
The configuration structure for IAM-based storage authentication is inconsistent across different Tyk components. In the Dashboard, it is defined as a top-level `redis_iam_auth` block. However, in other components like the Gateway, MDCB, and Pump, the equivalent configuration is nested within the specific storage block it applies to (e.g., `storage.iam_auth`, `analytics_storage.iam_auth`). This architectural inconsistency can create confusion for operators who need to configure multiple components in a Tyk stack, as they must remember different structural patterns for the same feature.
Raw output
To improve architectural consistency and user experience, the configuration schema should be harmonized across all components. The nested pattern used in the Gateway (`storage.iam_auth`) is more explicit and scalable. Consider refactoring the Dashboard configuration in a future major version to adopt this nested structure, for example by placing IAM settings under a new `storage.redis.iam_auth` block.
Loading