-
Notifications
You must be signed in to change notification settings - Fork 20
docs: add health check configuration #1993
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
fix pre-commit
56f7ff7
to
0613fc0
Compare
|
||
In Pomerium, these health checks will report on the status of: | ||
|
||
- Readiness and health of the embedded envoy instance |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Readiness and health of the embedded envoy instance | |
- Readiness and health of the embedded Envoy instance |
|
||
### Liveness | ||
|
||
The `/healthz` endpoint |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing liveness content
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like I accidentally git stashed those changes.
|
||
### Filters | ||
|
||
Unlike HTTP probes, the CLI provides additional flexibility through exclude filters, which let you ignore specific internal conditions reported by Pomerium when evaluating health. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about adding a check definition section with short descriptions of what each of these checks covers, so they can figure out what they might want to filter out?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah probably a good idea to do that, although they're internal checks so may not make intuitive sense to users, so let me take some time to think about the best way to document those
ENG-2290