Skip to content

Add a script to analyze Application Settings

Rémy Coutable requested to merge analyze-application_settings into master

What does this MR do and why?

This MR adds a script that does several thing:

  • Extract ApplicationSetting attributes from structure.sql and create individual YAML files under db/docs/application_settings/
  • Cross-check the API documentation at doc/api/settings.md for consistency and extract description from it (this is mostly for ease of understanding the purpose of settings, and also to detect attributes that aren't exposed/documented in the API documentation)
  • Generate statistics and a table for ApplicationSetting attributes based on the data from db/docs/application_settings/ files

The goal of individual YAML files under db/docs/application_settings/ is to populate the clusterwide attribute manually so that each attribute is classified as cell-local or clusterwide.

This is needed for the Phase 7 of Cells 1.0: &13165

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Edited by Rémy Coutable

Merge request reports