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

1. Add CRDs for MetadataProfile #1434

Merged
merged 8 commits into from
Jan 24, 2025

Conversation

shreyabiradar07
Copy link
Contributor

Description

This PR includes:

  1. CRDs for MetadataProfile both in YAML and JSON format.
  2. Template YAML file for the same

Fixes # (issue)

Type of change

  • Bug fix
  • New feature
  • Docs update
  • Breaking change (What changes might users need to make in their application due to this PR?)
  • Requires DB changes

How has this been tested?

Please describe the tests that were run to verify your changes and steps to reproduce. Please specify any test configuration required.

  • New Test X
  • Functional testsuite

Test Configuration

  • Kubernetes clusters tested on:

Checklist 🎯

  • Followed coding guidelines
  • Comments added
  • Dependent changes merged
  • Documentation updated
  • Tests added or updated

Additional information

.

@shreyabiradar07 shreyabiradar07 self-assigned this Dec 19, 2024
@shreyabiradar07 shreyabiradar07 added this to the Kruize 0.4 Release milestone Dec 19, 2024
@shreyabiradar07 shreyabiradar07 changed the title Add CRDs for MetadataProfile 1. Add CRDs for MetadataProfile Dec 27, 2024
@msvinaykumar
Copy link
Contributor

msvinaykumar commented Jan 8, 2025

Which file is currently being used for ROS and the general use case?
Are these queries being executed manually to verify they run successfully and return the required data in both Thanos and Prometheus? Additionally, have you tested these queries on the ROS Stage server? Although this is outside the scope of this PR, I'm just checking if it works.

@msvinaykumar
Copy link
Contributor

Can you please include MD file with this PR

@shreyabiradar07
Copy link
Contributor Author

shreyabiradar07 commented Jan 10, 2025

Which file is currently being used for ROS and the general use case? Are these queries being executed manually to verify they run successfully and return the required data in both Thanos and Prometheus? Additionally, have you tested these queries on the ROS Stage server? Although this is outside the scope of this PR, I'm just checking if it works.

  • Which file is currently being used for ROS and the general use case?
    Default metadataProfile - cluster_metadata_local_monitoring.json has the currently used namespace, workload and container queries without any filter labels.

  • Are these queries being executed manually to verify they run successfully and return the required data in both Thanos and Prometheus?
    Have verified the queries on Prometheus and on Thanos - all the queries runs as expected and the measurement duration depends on the time at which the TSBD blocks are uploaded.

  • Additionally, have you tested these queries on the ROS Stage server? Although this is outside the scope of this PR, I'm just checking if it works.
    These queries are not tested on to ROS stage server, I do not have access for stage env.

@shreyabiradar07
Copy link
Contributor Author

Can you please include MD file with this PR

Added MetadataProfile.md file with basic details and will continue to develop along with the subsequent PRs

@shreyabiradar07
Copy link
Contributor Author

Hi @msvinaykumar, I have incorporated review changes suggested. Can you please review the PR again?
Thanks in advance!

@@ -0,0 +1,81 @@
# Metadata Profile

The metadata profile contains a list of queries used to retrieve datasource metadata such as list of namespaces, workloads
Copy link
Contributor

Choose a reason for hiding this comment

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

Also, describe the user flow for modifying queries and utilizing API requests and responses, or provide a reference link if this information is documented elsewhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for pointing this out. MetadataProfile.md readme aims to explain what the profile is about and different fields and metadata queries supported. I'll be adding a new readme MetadataProfileAPI.md as and when the REST APIs are merged which will cover user flow for modifying queries and API requests and responses.

Copy link
Contributor

@msvinaykumar msvinaykumar left a comment

Choose a reason for hiding this comment

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

LGTM

@shreyabiradar07
Copy link
Contributor Author

@dinogun As per the feedback updated the measurement duration unit to minutes.

design/MetadataProfile.md Outdated Show resolved Hide resolved
Copy link
Contributor

@dinogun dinogun left a comment

Choose a reason for hiding this comment

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

LGTM

@dinogun dinogun merged commit d372d5b into kruize:mvp_demo Jan 24, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request local_monitoring
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants