rudimentary best practices for applications (#157) #180
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NissesSenap
reviewed
Dec 16, 2022
| ## Secret Management | ||
|
|
||
| 1. Make sure no secrets are commited to either source code repository, nor gitops repository. | ||
| 2. Load secrets using Secret Store CSI Driver. It is documented extensively [here](https://xenitab.github.io/docs/xks/developer-guide/secrets-management). |
There was a problem hiding this comment.
It's okay to get secrets from Cloud provider key vault solutions as well. As long as you don't save passwords in git you are okay :)
|
|
||
| Add tracing to your application. We have found that modern trace tools provide pretty good configuration out of the box. You just need to add an appropriate tracing library to your application. Consider reading our extended [extended documentation on tracing](https://xenitab.github.io/docs/xks/developer-guide/observability). | ||
|
|
||
| ## Pod disruption budgets |
There was a problem hiding this comment.
Maybe change this to availability or something similar. I think this PDB documentation is to in depth for a overview page.
I think you should mention pdb as a part of getting good avaliability in k8s together with things like antiaffinity and link to our other docs for more details.
|
|
||
| Your pod can be shut down by kubernetes. Make sure the following has been configured. | ||
|
|
||
| 1. Your application has graceful shutdown that closes connection to database. |
There was a problem hiding this comment.
Mention something about sigterm and that you application needs to capture it and then close the connections.
We probably have some docs about this in some application specific part. Can link to that.
|
ping @dachrillz |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.