Skip to content

add 1st draft for charm architecture docs#534

Merged
Thanhphan1147 merged 18 commits into
mainfrom
add_charm_architecture_docs
Jun 22, 2026
Merged

add 1st draft for charm architecture docs#534
Thanhphan1147 merged 18 commits into
mainfrom
add_charm_architecture_docs

Conversation

@Thanhphan1147

@Thanhphan1147 Thanhphan1147 commented Jun 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

What this PR does

Add project-architecture.md to document the overall architecture of the haproxy monorepo

Checklist

  • I followed the contributing guide
  • I added or updated the documentation (if applicable)
  • I updated docs/changelog.md with user-relevant changes
  • I added a change artifact for user-relevant changes in docs/release-notes/artifacts. If no change artifact is necessary, I tagged the PR with the label no-release-note.
  • I used AI to assist with preparing this PR
  • I added or updated tests as needed (unit and integration)
  • If integration test modules are used: I updated the workflow configuration
    (e.g., in .github/workflows/integration_tests.yaml, ensure the modules list is correct)
  • If this PR involves a Grafana dashboard: I added a screenshot of the dashboard
  • If this PR involves Terraform: terraform fmt passes and tflint reports no errors

@Thanhphan1147 Thanhphan1147 requested a review from erinecon June 4, 2026 15:10
@Thanhphan1147 Thanhphan1147 added documentation Improvements or additions to documentation no-release-note This PR does not require a change artifact labels Jun 4, 2026
erinecon
erinecon reviewed Jun 4, 2026
View reviewed changes

@erinecon erinecon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for drafting this Explanation page 🎉 some initial thoughts from me

Comment thread docs/explanation/charm-architecture.md Outdated
Comment thread docs/explanation/charm-architecture.md Outdated
Comment thread docs/explanation/charm-architecture.md Outdated
Comment thread docs/explanation/charm-architecture.md Outdated
Comment thread docs/explanation/charm-architecture.md Outdated
erinecon
erinecon reviewed Jun 8, 2026
View reviewed changes

@erinecon erinecon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for adding more information to this page! This round of comments contains nits + questions about the ddos-configurator

Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md
Comment thread docs/explanation/project-architecture.md
Thanhphan1147 and others added 5 commits June 22, 2026 07:47
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
1a4ab78 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
2da2e94 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
eda4d9f 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
dbfe48d 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147
Merge branch 'main' into add_charm_architecture_docs
00ca4c6
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
1a3c3cc 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147
docs: address PR review comments on project architecture page
9a237a9 
- Code-format charm names in README links
- Rename section header to 'High-level overview of deployment'
- Update Container_Boundary title to 'HAProxy deployment'
- Fix ddos component ID conflict in C4 diagram
- Add ddos-protection relation to diagram
- Add UpdateRelStyle() calls for improved diagram readability
- Expand SPOE and OIDC acronyms in full on first use
- Add ddos-configurator description paragraph
- Enhance integrations section with context and ddos-configurator link
@Thanhphan1147 Thanhphan1147 requested a review from erinecon June 22, 2026 12:12
erinecon
erinecon approved these changes Jun 22, 2026
View reviewed changes

@erinecon erinecon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much! Nits only on the charm naming. But nothing that's blocking :D

Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Comment thread docs/explanation/project-architecture.md Outdated
Thanhphan1147 and others added 2 commits June 22, 2026 14:32
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
6095182 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
fdcd9aa 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
Thanhphan1147 and others added 4 commits June 22, 2026 14:33
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
a173f55 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
0db1de9 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
8813679 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147 @erinecon
Update docs/explanation/project-architecture.md
11ee576 
Co-authored-by: Erin Conley <erin.conley@canonical.com>
@Thanhphan1147 Thanhphan1147 merged commit 2e810f2 into main Jun 22, 2026
97 checks passed
@Thanhphan1147 Thanhphan1147 deleted the add_charm_architecture_docs branch June 22, 2026 12:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erinecon erinecon erinecon approved these changes

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation Libraries: Out of sync no-release-note This PR does not require a change artifact

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Thanhphan1147 @erinecon