Skip to content
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

GA roadmap: Incident management and troubleshooting guides #854

Closed
Tracked by #2592
dholbach opened this issue Mar 30, 2022 · 5 comments
Closed
Tracked by #2592

GA roadmap: Incident management and troubleshooting guides #854

dholbach opened this issue Mar 30, 2022 · 5 comments
Labels
area/docs Documentation related issues and pull requests
Milestone

Comments

@dholbach
Copy link
Member

From https://fluxcd.io/roadmap/

Let's discuss "Incident management and troubleshooting guides" - what do we want to add to our docs to be able to resolve this issue?

@dholbach dholbach added this to the GA milestone Mar 30, 2022
@pjbgf pjbgf mentioned this issue Mar 30, 2022
18 tasks
@pjbgf pjbgf added the area/docs Documentation related issues and pull requests label Mar 30, 2022
@dholbach
Copy link
Member Author

I had a chat with @pjbgf about this and we came to the conclusion that starting with a "troubleshooting cheatsheet" could be a good start. The next step could be a more general doc, including a flow diagram, some more background info, etc

does that make sense? here's a quick draft (needs more text still): https://docs.google.com/document/d/1FV4adriWQIH-0JZXeknZhKlPbxa8SibrRcX6SVhgOaQ/edit#

@makkes
Copy link
Member

makkes commented Jun 13, 2022

I like what's already in that doc. Thanks @dholbach. From my point of view we can just start with the items in there and extend the troubleshooting guide/runbook going forward.

@makkes
Copy link
Member

makkes commented Jun 13, 2022

We may want to move over some items from the FAQ, e.g. https://fluxcd.io/docs/faq/#how-do-i-resolve-webhook-does-not-support-dry-run-errors

@dholbach
Copy link
Member Author

dholbach commented Jul 20, 2022

https://fluxcd.io/docs/cheatsheets/troubleshooting/ was landed in #1033

We discussed in the 2022-07-20 meeting to ask the community in the next monthly update for feedback on what they feel they'd need to feel well set up for incident management and troubleshooting - or what they use internally e.g. playbooks, etc

@pjbgf pjbgf moved this to In Progress in Maintainers' Focus Jul 20, 2022
@pjbgf pjbgf moved this from In Progress to Up-Next in Maintainers' Focus Jul 20, 2022
@pjbgf pjbgf moved this from Up-Next to In Progress in Maintainers' Focus Aug 26, 2022
@pjbgf
Copy link
Member

pjbgf commented Aug 26, 2022

The current documentation on this front suffices for GA, from now on it will be an on-going effort to keep it up to date and improve it.

Closing as per #1094 (comment).

@pjbgf pjbgf closed this as completed Aug 26, 2022
Repository owner moved this from In Progress to Since Last Dev Meeting in Maintainers' Focus Aug 26, 2022
@kingdonb kingdonb moved this from Since Last Dev Meeting to Done in Maintainers' Focus Aug 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests
Projects
Status: Done
Development

No branches or pull requests

3 participants