Database Dictionary Audit for Configure:Configure
Recently the database team has started documenting all database tables in db/doc
. As an MVP, we've assigned
each table to a feature category. We attempted to automate this, and then made rough guesses on the ones that
couldn't be automatically identified either using this spreadsheet
or just by guessing based on their name and code references. In order to make sure these are accurate, I'm
asking every team to take a look at the tables associated with their feature categories assoicated with their
stages.
What we need from your team? Look through the list of tables and fix any mistaken labels and update the description field to help folks know what purpose the table serves.
Process (per table)
- Are the feature categories correct?
- Keep in mind that tables can have multiple categories. Look at the list and if there are any other categories it belongs to, add them.
- If a table has no category that seems to be a perfect match, assign it to the closest match. Tables must have at least one feature category.
- If the table is assigned to a feature category for a different group, open a merge request changing the category and assign it to the EM for the group responsible for that category.
- Update the description of the table to give anybody interacting with it context around the purpose and submit a merge request with the information.
- Double check the
milestone
andintroduced_by_url
to see if they are accurate
Tables
-
project_auto_devops -
auto_devops is the correct feature category or has been updated -
project_auto_devops description has been updated -
project_auto_devops milestone
andintroduced_by_url
seem accurate
-
-
terraform_state_versions -
infrastructure_as_code is the correct feature category or has been updated -
terraform_state_versions description has been updated -
terraform_state_versions milestone
andintroduced_by_url
seem accurate
-
-
terraform_states -
infrastructure_as_code is the correct feature category or has been updated -
terraform_states description has been updated -
terraform_states milestone
andintroduced_by_url
seem accurate
-
-
cluster_agent_tokens -
kubernetes_management is the correct feature category or has been updated -
cluster_agent_tokens description has been updated -
cluster_agent_tokens milestone
andintroduced_by_url
seem accurate
-
-
agent_group_authorizations -
kubernetes_management is the correct feature category or has been updated -
agent_group_authorizations description has been updated -
agent_group_authorizations milestone
andintroduced_by_url
seem accurate
-
-
cluster_platforms_kubernetes -
kubernetes_management is the correct feature category or has been updated -
cluster_platforms_kubernetes description has been updated -
cluster_platforms_kubernetes milestone
andintroduced_by_url
seem accurate
-
-
cluster_groups -
kubernetes_management is the correct feature category or has been updated -
cluster_groups description has been updated -
cluster_groups milestone
andintroduced_by_url
seem accurate
-
-
agent_project_authorizations -
kubernetes_management is the correct feature category or has been updated -
agent_project_authorizations description has been updated -
agent_project_authorizations milestone
andintroduced_by_url
seem accurate
-
-
clusters_applications_helm -
kubernetes_management is the correct feature category or has been updated -
clusters_applications_helm description has been updated -
clusters_applications_helm milestone
andintroduced_by_url
seem accurate
-
-
[-] clusters_applications_cilium Moved to
container_network_security
- [-] kubernetes_management is the correct feature category or has been updated
- [-] clusters_applications_cilium description has been updated
- [-] clusters_applications_cilium
milestone
andintroduced_by_url
seem accurate
-
clusters_applications_jupyter -
kubernetes_management is the correct feature category or has been updated -
clusters_applications_jupyter description has been updated -
clusters_applications_jupyter milestone
andintroduced_by_url
seem accurate
-
-
clusters_applications_elastic_stacks -
kubernetes_management is the correct feature category or has been updated -
clusters_applications_elastic_stacks description has been updated -
clusters_applications_elastic_stacks milestone
andintroduced_by_url
seem accurate
-
-
aws_roles -
kubernetes_management is the correct feature category or has been updated -
aws_roles description has been updated -
aws_roles milestone
andintroduced_by_url
seem accurate
-
-
clusters_applications_cert_managers -
kubernetes_management is the correct feature category or has been updated -
clusters_applications_cert_managers description has been updated -
clusters_applications_cert_managers milestone
andintroduced_by_url
seem accurate
-
-
agent_activity_events -
kubernetes_management is the correct feature category or has been updated -
agent_activity_events description has been updated -
agent_activity_events milestone
andintroduced_by_url
seem accurate
-
-
clusters_kubernetes_namespaces -
kubernetes_management is the correct feature category or has been updated -
clusters_kubernetes_namespaces description has been updated -
clusters_kubernetes_namespaces milestone
andintroduced_by_url
seem accurate
-
-
cluster_agents -
kubernetes_management is the correct feature category or has been updated -
cluster_agents description has been updated -
cluster_agents milestone
andintroduced_by_url
seem accurate
-
-
clusters_applications_runners -
kubernetes_management is the correct feature category or has been updated -
clusters_applications_runners description has been updated -
clusters_applications_runners milestone
andintroduced_by_url
seem accurate
-
-
cluster_projects -
kubernetes_management is the correct feature category or has been updated -
cluster_projects description has been updated -
cluster_projects milestone
andintroduced_by_url
seem accurate
-
-
clusters_applications_ingress -
kubernetes_management is the correct feature category or has been updated -
clusters_applications_ingress description has been updated -
clusters_applications_ingress milestone
andintroduced_by_url
seem accurate
-
-
cluster_providers_aws -
kubernetes_management is the correct feature category or has been updated -
cluster_providers_aws description has been updated -
cluster_providers_aws milestone
andintroduced_by_url
seem accurate
-
-
cluster_providers_gcp -
kubernetes_management is the correct feature category or has been updated -
cluster_providers_gcp description has been updated -
cluster_providers_gcp milestone
andintroduced_by_url
seem accurate
-
-
clusters_applications_knative -
kubernetes_management is the correct feature category or has been updated -
clusters_applications_knative description has been updated -
clusters_applications_knative milestone
andintroduced_by_url
seem accurate
-
-
clusters_applications_crossplane -
kubernetes_management is the correct feature category or has been updated -
clusters_applications_crossplane description has been updated -
clusters_applications_crossplane milestone
andintroduced_by_url
seem accurate
-
-
ci_pipeline_chat_data -
chatops is the correct feature category or has been updated -
ci_pipeline_chat_data description has been updated -
ci_pipeline_chat_data milestone
andintroduced_by_url
seem accurate
-
-
serverless_domain_cluster -
deployment_management is the correct feature category or has been updated -
serverless_domain_cluster description has been updated -
serverless_domain_cluster milestone
andintroduced_by_url
seem accurate
-
-
deployment_clusters -
deployment_management is the correct feature category or has been updated -
deployment_clusters description has been updated -
deployment_clusters milestone
andintroduced_by_url
seem accurate
-
Why is this effort happening?
There have been many times that issues occur in production, but the the infrastructure team doesn't have the information it needs to identify subject matter experts who can help resolve things quickly. This in turn can delay the time it takes to find and fix pressing issues.
How much time should we expect to spend on this?
Depends, if the team has a lot of tables, it may take a little bit to get all of the information together. If not, this could be very fast. The descriptions are as much or little as the team wants to add. More information may help folks self service better.
How urgent is this?
The urgency is up to the team. If the tables have poor information or are misassigned, that may cause more burden on the team when answering questions.