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

Document a general-purpose recovery process #4991

Merged
merged 4 commits into from
May 23, 2019

Conversation

cjllanwarne
Copy link
Contributor

@cjllanwarne cjllanwarne commented May 21, 2019

An attempt to document my observation of our general purpose debugging process - will hopefully help the next generation of Cromwell fire troubleshooters.

  • Moves the release processes under a new "processes" banner instead of awkwardly sitting in "scripts"
  • Adds a general-purpose recover process

See the process rendered and in situ

NB: If this gets approval, I'll update our playbook to link to this as our "general purpose fallback process"

@aednichols
Copy link
Collaborator

Now I see what's wrong with the playbook, no dot graphs

@@ -0,0 +1,18 @@
# Documented Processes
Copy link
Contributor

Choose a reason for hiding this comment

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

how happy is the Markdown toolchain going to be with uppercase file extensions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure which toolchain - or which extension - you mean. Do you have a specific downstream tool in mind?

Copy link
Contributor

Choose a reason for hiding this comment

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

No just TOLing.

@@ -0,0 +1,7 @@
#!/usr/bin/env bash

while IFS= read -r -d '' file
Copy link
Contributor

@mcovarr mcovarr May 21, 2019

Choose a reason for hiding this comment

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

why not just

for dot in $(find . -name "*.dot" -print0)
do
...
done

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You can ask shellcheck why - it made me do it 😄

Copy link
Contributor

Choose a reason for hiding this comment

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

hmm might be whitespace safe 🤔

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah apparently this is for whitespace safety, TIL https://unix.stackexchange.com/questions/174016/how-do-i-use-null-bytes-in-bash

while IFS= read -r -d '' file
do
echo "Rendering graph ${file} into ${file}.png"
dot -Tpng -o "$file.png" "$file"
Copy link
Contributor

@mcovarr mcovarr May 21, 2019

Choose a reason for hiding this comment

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

To avoid blah.dot.png:

...
  png="${dot%.dot}.png"
  echo "Rendering graph ${dot} into ${png}"
...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The .dot.png is preexisting so I'm reluctant to change that as well in this PR - could that happen as a follow up maybe?

Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose 😞

@gemmalam gemmalam requested a review from rsasch May 22, 2019 14:36
@@ -0,0 +1,18 @@
# Documented Processes
Copy link
Contributor

Choose a reason for hiding this comment

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

No just TOLing.

@@ -0,0 +1,7 @@
#!/usr/bin/env bash

while IFS= read -r -d '' file
Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah apparently this is for whitespace safety, TIL https://unix.stackexchange.com/questions/174016/how-do-i-use-null-bytes-in-bash

while IFS= read -r -d '' file
do
echo "Rendering graph ${file} into ${file}.png"
dot -Tpng -o "$file.png" "$file"
Copy link
Contributor

Choose a reason for hiding this comment

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

I suppose 😞

Copy link
Contributor

@rsasch rsasch left a comment

Choose a reason for hiding this comment

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

LGTM – always happy to see more 📉 in the world!

@cjllanwarne cjllanwarne merged commit 937cb05 into develop May 23, 2019
@cjllanwarne cjllanwarne deleted the cjl_all_purpose_mess_remover branch May 23, 2019 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants