c5b597c7c1
Reorganized documentation to be part of MkDocs site with three new
comprehensive guides covering API7 Gateway configuration.
Changes:
1. Documentation Structure:
- Moved SECRET-MANAGEMENT.md from helm/ to web/docs/
- Created service-discovery.md with complete guide
- Created ingress-routing.md with routing architecture
- Moved externalsecret examples to web/docs/examples/
2. New Documentation - Service Discovery:
- How service discovery works (architecture diagram)
- Benefits vs static configuration
- Configuration examples
- RBAC requirements
- Advanced use cases (auto-scaling, rolling updates)
- Load balancing algorithms
- Monitoring and troubleshooting
- Best practices
3. New Documentation - Ingress & Routing:
- Complete traffic flow architecture
- Ingress configuration explained
- Gateway routing rules and priority
- URI matching patterns (prefix, exact, regex)
- TLS/SSL with cert-manager
- Advanced routing scenarios:
* Multiple domains
* Path-based routing
* Header-based routing
* Method-based routing
- Configuration examples (microservices, WebSocket, canary)
- Monitoring and debugging
- Troubleshooting common issues
4. MkDocs Navigation:
- Updated mkdocs.yml with new pages in Configuration section
- Added: Ingress & Routing
- Added: Service Discovery
- Added: Secret Management
5. Examples Directory:
- Created web/docs/examples/ for configuration examples
- Moved ExternalSecret examples with multiple providers:
* AWS Secrets Manager
* HashiCorp Vault
* Azure Key Vault
* GCP Secret Manager
All documentation now integrated into MkDocs site with proper
navigation, cross-references, and Material theme styling.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
77 lines
1.8 KiB
YAML
77 lines
1.8 KiB
YAML
site_name: API7 Enterprise Demo Documentation
|
|
site_description: Complete documentation for API7 Enterprise Gateway demo deployment
|
|
site_author: CommandWare
|
|
site_url: https://demo.commandware.it/docs
|
|
docs_dir: docs
|
|
|
|
theme:
|
|
name: material
|
|
palette:
|
|
- scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.top
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
icon:
|
|
repo: fontawesome/brands/git-alt
|
|
|
|
repo_name: demos/api7-demo
|
|
repo_url: https://git.commandware.com/demos/api7-demo
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started: getting-started.md
|
|
- Architecture:
|
|
- Overview: architecture.md
|
|
- Kubernetes Resources: kubernetes-resources.md
|
|
- Configuration:
|
|
- API7 Gateway: api7-configuration.md
|
|
- Ingress & Routing: ingress-routing.md
|
|
- Service Discovery: service-discovery.md
|
|
- Secret Management: secret-management.md
|
|
- CI/CD Pipeline: cicd-pipeline.md
|
|
- Troubleshooting: troubleshooting.md
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- tables
|
|
- attr_list
|
|
- md_in_html
|
|
- toc:
|
|
permalink: true
|
|
|
|
plugins:
|
|
- search
|
|
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/brands/git-alt
|
|
link: https://git.commandware.com/demos/api7-demo
|
|
version:
|
|
provider: mike
|
|
|
|
copyright: Copyright © 2025 CommandWare
|