Skip to content

docs: document collateral-proxy#2479

Open
charludo wants to merge 1 commit into
mainfrom
ch/docs/collateral-proxy
Open

docs: document collateral-proxy#2479
charludo wants to merge 1 commit into
mainfrom
ch/docs/collateral-proxy

Conversation

@charludo

Copy link
Copy Markdown
Collaborator

No description provided.

@charludo charludo requested a review from burgerdev June 25, 2026 13:11
@charludo charludo added the documentation Improvements for user docs label Jun 25, 2026
@github-actions

github-actions Bot commented Jun 25, 2026

Copy link
Copy Markdown

Do the documentation changes need to be backported?

Changes to /docs/docs won't be visible until the next release.
If you are fixing something in the docs that should be immediately visible, the changes needs to be made to both /docs/docs and /docs/versioned_docs/version-X.Y, where X.Y is the version of the latest minor release.
This can be done in this same PR.

  • Yes, this should be backported to the current version of the docs.
  • No, the PR only contains docs changes relevant for future versions.

@github-actions

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://edgelesssys.github.io/contrast/pr-preview/pr-2479/

Built to branch gh-pages at 2026-06-25 13:14 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@charludo charludo added this to the v1.22.0 milestone Jun 25, 2026
To inspect the metrics, query the endpoint from inside the cluster, for example:

```bash
kubectl exec statefulset/collateral-proxy -- wget -qO- http://127.0.0.1/metrics

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could also be done with port forwarding (since this is not a CC pod). The script would be more complicated in that case, but we could at least mention the possibility.


Using the proxy requires deploying the proxy once per cluster, then pointing your Contrast components at it when generating your deployment.

### Deploy the proxy

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not sure whether we should even document the server at this point.

  1. It's not going to stay in this repo for too long.
  2. k8s resource defs should be released.

Maybe shelve this section for now and focus on the client side and how Contrast handles this.

Comment on lines +88 to +90
- name: proxy
port: 80
targetPort: 80

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We need a security considerations section that explains why port 80 is ok (answer: the libraries we use check all certificates against an embedded root cert).

@charludo charludo removed this from the v1.22.0 milestone Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements for user docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants