cloudfoundry / cloudfoundry/docs-cf-admin
securing-traffic should include internal TLS and Envoy
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 18
- Forks
- 112
- PR merge metrics
- No merged PRs in 30d
Description
securing-traffic.html.md.erb is wrong/outdated since it doesn’t account for Envoy.
The guidance provided at https://gist.github.com/nikhilsuvarna/bd0aa0ef01880270c13d145c61a4af22 should be incorporated to correctly show how TLS is established between the GoRouter and AppContainer.
That is, The CF guide shows:
and:
but not anything like the current state with TLS to the container:
My knowledge of CF isn't enough to determine how much of the current document needs to be deleted as obsolete vs. just adding new content, so I'll start with an issue instead of a PR.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with securing-traffic.html.md.erb and compare its current guidance with the linked gist and the three referenced diagrams. Determine which existing guidance is obsolete and document the current TLS path between the GoRouter, Envoy, and AppContainer; done means the page accurately reflects internal TLS rather than only the older Cloud Foundry flow.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, networking, security
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100