Skip to content

Add tool to regenerate .mdx files #1866

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

Merged
merged 6 commits into from
Sep 16, 2021
Merged

Add tool to regenerate .mdx files #1866

merged 6 commits into from
Sep 16, 2021

Conversation

lava
Copy link
Member

@lava lava commented Aug 25, 2021

📔 Description

On a large DB, it can take a lot of time to regenerate the .mdx synopsis files on startup if the previous version somehow got corrupted or outdated. VAST never accesses these files during operation, so this can safely be done before restarting VAST to ensure minimal downtime. This tool provides just that functionality, ie. a way to bulk-update all .mdx files of a database that does not interfere with the running VAST process.

📝 Checklist

  • All user-facing changes have changelog entries.
  • The changes are reflected on docs.tenzir.com/vast, if necessary.
  • The PR description contains instructions for the reviewer, if necessary.

🎯 Review Instructions

Copy link
Member

@dominiklohmann dominiklohmann left a comment

Choose a reason for hiding this comment

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

Can you add a README to the tool, and a changelog entry that describes what this tool does?

Also, this needs to be enabled in CI.

@lava lava force-pushed the topic/midx-regenerate branch from e6b3004 to 5cac181 Compare August 26, 2021 15:57
@dominiklohmann dominiklohmann added the feature New functionality label Aug 27, 2021
@lava lava force-pushed the topic/midx-regenerate branch from 36cd8f3 to 577670c Compare September 10, 2021 14:39
@lava lava force-pushed the topic/midx-regenerate branch from 577670c to 06fd867 Compare September 10, 2021 14:43
@lava lava force-pushed the topic/midx-regenerate branch from 06fd867 to ca5b7e7 Compare September 10, 2021 14:59
Copy link
Member

@dominiklohmann dominiklohmann left a comment

Choose a reason for hiding this comment

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

Just some smaller comments on the README.

The tool itself seems to work as expected. I tested this by using an older version of VAST to create a database, and then using this tool on the database before running a recent version of VAST. Everything started up as expected.

@lava lava enabled auto-merge September 16, 2021 15:32
@lava lava merged commit e46dfbd into master Sep 16, 2021
@lava lava deleted the topic/midx-regenerate branch September 16, 2021 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants