-
Notifications
You must be signed in to change notification settings - Fork 56
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
dinogun
merged 8 commits into
kruize:mvp_demo
from
shreyabiradar07:metadata-profile-crds
Jan 24, 2025
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
654befc
Add MetadataProfile CRDs and template
shreyabiradar07 336b576
Add missing EOF
shreyabiradar07 8e6ba31
Add global datasource field
shreyabiradar07 ff6e50b
Add readme for metadata profile
shreyabiradar07 7dfc703
Update measurement duration unit to hours
shreyabiradar07 5a02914
Add metadata profile for bulk demo
shreyabiradar07 0487fd5
Roll back measurement duration unit to minutes
shreyabiradar07 0e17de9
Update readme
shreyabiradar07 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| and containers. Users can create metadata profiles based on their cluster or datasource provider, such as Prometheus or | ||
| Thanos. These profiles can be tagged to import metadata API, which will then fetch metadata according to the metadata | ||
| profile, which further helps to create experiments followed by generating recommendations. | ||
|
|
||
| This document describes the fields of Metadata Profile and the different set of queries supported by Kruize. | ||
| Documentation still in progress stay tuned. | ||
|
|
||
| ## Attributes | ||
|
|
||
| - **apiVersion** \ | ||
| A string representing version of the Kubernetes API to create metadata profile | ||
| - **kind** \ | ||
| A string representing type of kubernetes object | ||
| - **metadata** \ | ||
| A JSON object containing Data that helps to uniquely identify the metadata profile, including a name string | ||
| - **name** \ | ||
| A unique string name for identifying each metadata profile. | ||
| - **profile_version** \ | ||
| A double value specifying the current version of the profile. | ||
| - **datasource** \ | ||
| A string representing the datasource to import metadata from | ||
| - **query_variables** \ | ||
| Define the query variables to be used | ||
| - **name** \ | ||
| name of the variable | ||
| - **datasource** \ | ||
| datasource of the query | ||
| - **value_type** \ | ||
| can be double or integer | ||
| - **query** \ | ||
| one of the query or _aggregation_functions_ is mandatory. Both can be present. | ||
| - **kubernetes_object** \ | ||
| k8s object that this query is tied to: "_deployment_", "_pod_" or "_container_" | ||
| - **aggregation_functions** \ | ||
| aggregate functions associated with this variable | ||
| - **function** \ | ||
| can be '_avg_', '_sum_', '_min_', '_max_' | ||
| - **query** \ | ||
| corresponding query | ||
| - **version** \ | ||
| Any specific version that this query is tied to | ||
|
|
||
| ### Different set of metadata queries | ||
|
|
||
| #### Queries to import metadata across the cluster | ||
|
|
||
| These set of queries fetch list of all the namespaces, workloads and containers present across the cluster | ||
|
|
||
| | Name | Query | | ||
| |-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | namespacesAcrossCluster | sum by (namespace) (avg_over_time(kube_namespace_status_phase{namespace!=""}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
| | workloadsAcrossCluster | sum by (namespace, workload, workload_type) (avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!=""}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
| | containersAcrossCluster | sum by (container, image, workload, workload_type, namespace) (avg_over_time(kube_pod_container_info{container!=""}[$MEASUREMENT_DURATION_IN_MIN$m])<br/> * on (pod, namespace) group_left(workload, workload_type) avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!=""}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
|
|
||
|
|
||
| <br> | ||
|
|
||
| #### Queries to import metadata for specific org_id and cluster_id | ||
|
|
||
| These set of queries fetch list of namespaces, workloads and containers for specific `org_id` and `cluster_id` | ||
|
|
||
| | Name | Query | | ||
| |------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | namespacesForOrgAndClusterId | sum by (namespace) (avg_over_time(kube_namespace_status_phase{namespace!="", org_id="$ORG_ID$", cluster_id="$CLUSTER_ID$"}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
| | workloadsForOrgAndClusterId | sum by (namespace, workload, workload_type) (avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!="", org_id="$ORG_ID$", cluster_id="$CLUSTER_ID$"}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
| | containersForOrgAndClusterId | sum by (container, image, workload, workload_type, namespace) (avg_over_time(kube_pod_container_info{container!="", org_id="$ORG_ID$", cluster_id="$CLUSTER_ID$"}[$MEASUREMENT_DURATION_IN_MIN$m]) <br/> * on (pod, namespace) group_left(workload, workload_type) avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!="", org_id="$ORG_ID$", cluster_id="$CLUSTER_ID$"}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
|
|
||
| <br> | ||
|
|
||
| #### Queries to import metadata for custom label - ADDITIONAL_LABEL | ||
|
|
||
| These set of queries fetch list of namespaces, workloads and containers for specific `ADDITIONAL_LABEL` - currently used by bulk and thanos demos | ||
|
|
||
| | Name | Query | | ||
| |------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | namespacesForAdditionalLabel | sum by (namespace) (avg_over_time(kube_namespace_status_phase{namespace!="" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
| | workloadsForAdditionalLabel | sum by (namespace, workload, workload_type) (avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!="" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
| | containersForAdditionalLabel | sum by (container, image, workload, workload_type, namespace) (avg_over_time(kube_pod_container_info{container!="" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]) <br/> * on (pod, namespace) group_left(workload, workload_type) avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!="" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m])) | | ||
48 changes: 48 additions & 0 deletions
48
manifests/autotune/metadata-profiles/bulk_cluster_metadata_local_monitoring.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| { | ||
| "apiVersion": "recommender.com/v1", | ||
| "kind": "KruizeMetadataProfile", | ||
| "metadata": { | ||
| "name": "cluster-metadata-local-monitoring" | ||
| }, | ||
| "profile_version": 1, | ||
| "k8s_type": "openshift", | ||
| "datasource": "prometheus", | ||
| "query_variables": [ | ||
| { | ||
| "name": "namespacesForAdditionalLabel", | ||
| "datasource": "prometheus", | ||
| "value_type": "double", | ||
| "kubernetes_object": "container", | ||
| "aggregation_functions": [ | ||
| { | ||
| "function": "sum", | ||
| "query": "sum by (namespace) (avg_over_time(kube_namespace_status_phase{namespace!=\"\" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]))" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "workloadsForAdditionalLabel", | ||
| "datasource": "prometheus", | ||
| "value_type": "double", | ||
| "kubernetes_object": "container", | ||
| "aggregation_functions": [ | ||
| { | ||
| "function": "sum", | ||
| "query": "sum by (namespace, workload, workload_type) (avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!=\"\" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]))" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "containersForAdditionalLabel", | ||
| "datasource": "prometheus", | ||
| "value_type": "double", | ||
| "kubernetes_object": "container", | ||
| "aggregation_functions": [ | ||
| { | ||
| "function": "sum", | ||
| "query": "sum by (container, image, workload, workload_type, namespace) (avg_over_time(kube_pod_container_info{container!=\"\" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]) * on (pod, namespace) group_left(workload, workload_type) avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!=\"\" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]))" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } |
32 changes: 32 additions & 0 deletions
32
manifests/autotune/metadata-profiles/bulk_cluster_metadata_local_monitoring.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| apiVersion: "recommender.com/v1" | ||
| kind: "KruizeMetadataProfile" | ||
| metadata: | ||
| name: "cluster-metadata-local-monitoring" | ||
| profile_version: 1.0 | ||
| k8s_type: openshift | ||
| datasource: prometheus | ||
| query_variables: | ||
|
|
||
| - name: namespacesForAdditionalLabel | ||
| datasource: prometheus | ||
| value_type: "double" | ||
| kubernetes_object: "namespace" | ||
| aggregation_functions: | ||
| - function: sum | ||
| query: 'sum by (namespace) (avg_over_time(kube_namespace_status_phase{namespace!="" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]))' | ||
|
|
||
| - name: workloadsForAdditionalLabel | ||
| datasource: prometheus | ||
| value_type: "double" | ||
| kubernetes_object: "container" | ||
| aggregation_functions: | ||
| - function: sum | ||
| query: 'sum by (namespace, workload, workload_type) (avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!="" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]))' | ||
|
|
||
| - name: containersForAdditionalLabel | ||
| datasource: prometheus | ||
| value_type: "double" | ||
| kubernetes_object: "container" | ||
| aggregation_functions: | ||
| - function: sum | ||
| query: 'sum by (container, image, workload, workload_type, namespace) (avg_over_time(kube_pod_container_info{container!="" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]) * on (pod, namespace) group_left(workload, workload_type) avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!="" ADDITIONAL_LABEL}[$MEASUREMENT_DURATION_IN_MIN$m]))' |
48 changes: 48 additions & 0 deletions
48
manifests/autotune/metadata-profiles/cluster_metadata_local_monitoring.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| { | ||
| "apiVersion": "recommender.com/v1", | ||
| "kind": "KruizeMetadataProfile", | ||
| "metadata": { | ||
| "name": "cluster-metadata-local-monitoring" | ||
| }, | ||
| "profile_version": 1, | ||
| "k8s_type": "openshift", | ||
| "datasource": "prometheus", | ||
| "query_variables": [ | ||
| { | ||
| "name": "namespacesAcrossCluster", | ||
| "datasource": "prometheus", | ||
dinogun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| "value_type": "double", | ||
| "kubernetes_object": "container", | ||
| "aggregation_functions": [ | ||
| { | ||
| "function": "sum", | ||
| "query": "sum by (namespace) (avg_over_time(kube_namespace_status_phase{namespace!=\"\"}[$MEASUREMENT_DURATION_IN_MIN$m]))" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "workloadsAcrossCluster", | ||
| "datasource": "prometheus", | ||
| "value_type": "double", | ||
| "kubernetes_object": "container", | ||
| "aggregation_functions": [ | ||
| { | ||
| "function": "sum", | ||
| "query": "sum by (namespace, workload, workload_type) (avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!=\"\"}[$MEASUREMENT_DURATION_IN_MIN$m]))" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "containersAcrossCluster", | ||
| "datasource": "prometheus", | ||
| "value_type": "double", | ||
| "kubernetes_object": "container", | ||
| "aggregation_functions": [ | ||
| { | ||
| "function": "sum", | ||
| "query": "sum by (container, image, workload, workload_type, namespace) (avg_over_time(kube_pod_container_info{container!=\"\"}[$MEASUREMENT_DURATION_IN_MIN$m]) * on (pod, namespace) group_left(workload, workload_type) avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!=\"\"}[$MEASUREMENT_DURATION_IN_MIN$m]))" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
32 changes: 32 additions & 0 deletions
32
manifests/autotune/metadata-profiles/cluster_metadata_local_monitoring.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| apiVersion: "recommender.com/v1" | ||
| kind: "KruizeMetadataProfile" | ||
| metadata: | ||
| name: "cluster-metadata-local-monitoring" | ||
| profile_version: 1.0 | ||
| k8s_type: openshift | ||
| datasource: prometheus | ||
| query_variables: | ||
|
|
||
| - name: namespacesAcrossCluster | ||
| datasource: prometheus | ||
| value_type: "double" | ||
| kubernetes_object: "namespace" | ||
| aggregation_functions: | ||
| - function: sum | ||
| query: 'sum by (namespace) (avg_over_time(kube_namespace_status_phase{namespace!=""}[$MEASUREMENT_DURATION_IN_MIN$m]))' | ||
|
|
||
| - name: workloadsAcrossCluster | ||
| datasource: prometheus | ||
| value_type: "double" | ||
| kubernetes_object: "container" | ||
| aggregation_functions: | ||
| - function: sum | ||
| query: 'sum by (namespace, workload, workload_type) (avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!=""}[$MEASUREMENT_DURATION_IN_MIN$m]))' | ||
|
|
||
| - name: containersAcrossCluster | ||
| datasource: prometheus | ||
| value_type: "double" | ||
| kubernetes_object: "container" | ||
| aggregation_functions: | ||
| - function: sum | ||
| query: 'sum by (container, image, workload, workload_type, namespace) (avg_over_time(kube_pod_container_info{container!=""}[$MEASUREMENT_DURATION_IN_MIN$m]) * on (pod, namespace) group_left(workload, workload_type) avg_over_time(namespace_workload_pod:kube_pod_owner:relabel{workload!=""}[$MEASUREMENT_DURATION_IN_MIN$m]))' |
88 changes: 88 additions & 0 deletions
88
manifests/autotune/metadata-profiles/kruize-metadata-profile-crd.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| apiVersion: "recommender.com/v1" | ||
| kind: CustomResourceDefinition | ||
| metadata: | ||
| #name must match the spec fields below, and be in the form: <plural>.<group> | ||
| name: kruizemetadataprofiles.recommender.com | ||
| spec: | ||
| # group name to use for REST API: /apis/<group>/<version> | ||
| group: "recommender.com" | ||
| names: | ||
| plural: kruizemetadataprofiles | ||
| singular: kruizemetadataprofile | ||
| #types can be identified with this tag | ||
| kind: KruizeMetadataProfile | ||
| scope: Namespaced | ||
| versions: | ||
| - name: v1 | ||
| served: true | ||
| storage: true | ||
| schema: | ||
| openAPIV3Schema: | ||
| type: object | ||
| properties: | ||
| apiVersion: | ||
| description: 'APIVersion defines the versioned schema of this representation | ||
| of an object. Servers should convert recognized schemas to the latest | ||
| internal value, and may reject unrecognized values. More info: https://git.k8s.io/ | ||
| community/contributors/devel/sig-architecture/api-conventions.md#resources' | ||
| type: string | ||
| kind: | ||
| description: 'Kind is a string value representing the REST resource this | ||
| object represents. Servers may infer this from the endpoint the client | ||
| submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/ | ||
| community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' | ||
| type: string | ||
| profile_version: | ||
| description: 'Version of the profile' | ||
| type: number | ||
| k8s_type: | ||
| description: 'minikube or openshift' | ||
| type: string | ||
| datasource: | ||
| description: 'datasource to import metadata from for eg. Prometheus, Thanos, Datadog etc' | ||
| type: string | ||
| query_variables: | ||
| description: 'Query variables to be used' | ||
| type: array | ||
| items: | ||
| type: object | ||
| properties: | ||
| name: | ||
| description: 'name of the variable' | ||
| type: string | ||
| datasource: | ||
| description: 'datasource of the query' | ||
| type: string | ||
| value_type: | ||
| description: 'can be double or integer' | ||
| type: string | ||
| kubernetes_object: | ||
| description: 'k8s object that this query is tied to: "deployment", "pod", "namespace" or "container"' | ||
| type: string | ||
| query: | ||
| description: 'one of the query or aggregation_functions is mandatory' | ||
| type: string | ||
| aggregation_functions: | ||
| description: 'one of the query or aggregation_functions is mandatory' | ||
| type: array | ||
| items: | ||
| type: object | ||
| properties: | ||
| function: | ||
| description: 'aggregate functions associated with this variable' | ||
| type: string | ||
| query: | ||
| description: 'query' | ||
| type: string | ||
| version: | ||
| description: 'Any specific version that this query is tied to' | ||
| type: string | ||
| required: | ||
| - function | ||
| - query | ||
| required: | ||
| - name | ||
| - datasource | ||
| - value_type | ||
| required: | ||
| - query_variables |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.mdreadme aims to explain what the profile is about and different fields and metadata queries supported. I'll be adding a new readmeMetadataProfileAPI.mdas and when the REST APIs are merged which will cover user flow for modifying queries and API requests and responses.