class-generator: update schema and add PodMetrics
#2315
Merged
Conversation
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
WalkthroughThis pull request updates the cluster version file and introduces a new class in the pod metrics module. The version number in Changes
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
🔇 Additional comments (2)
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
|
Report bugs in Issues The following are automatically added:
Available user actions:
Supported /retest check runs
Supported labels
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
ocp_resources/pod_metrics.py (2)
10-13: Enhance the docstring with more details.Consider expanding the docstring to provide more context about pod metrics, such as what metrics are collected, their purpose, and how they are used.
class PodMetrics(NamespacedResource): """ - PodMetrics sets resource usage metrics of a pod. + PodMetrics represents resource usage metrics of a pod, including CPU and memory + consumption of its containers. These metrics are collected within a specified + time window and are used for monitoring, autoscaling, and resource optimization. """
17-42: Enhance the constructor docstring.The docstring could be improved by:
- Adding return type documentation
- Including type information in parameter descriptions
- Adding examples of valid values
def __init__( self, containers: list[Any] | None = None, timestamp: str | None = None, window: str | None = None, **kwargs: Any, ) -> None: """ + Initialize a PodMetrics instance. + Args: - containers (list[Any]): Metrics for all containers are collected within the same time window. + containers (list[Any] | None): List of container metrics objects. Each object contains + resource usage data (CPU, memory) for a container. + Example: [{"name": "container1", "usage": {"cpu": "100m", "memory": "256Mi"}}] - timestamp (str): Time is a wrapper around time.Time which supports correct marshaling - to YAML and JSON. Wrappers are provided for many of the factory - methods that the time package offers. + timestamp (str | None): RFC3339 timestamp when metrics were collected. + Example: "2024-02-15T10:30:00Z" - window (str): Duration is a wrapper around time.Duration which supports correct - marshaling to YAML and JSON. In particular, it marshals into - strings, which can be used as map keys in json. + window (str | None): Duration over which metrics were collected. + Example: "5m" for 5 minutes + **kwargs (Any): Additional arguments passed to the parent class. + + Returns: + None """
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (205)
class_generator/schema/__not-kind.txtis excluded by!class_generator/schema/**class_generator/schema/__resources-mappings.jsonis excluded by!class_generator/schema/**class_generator/schema/_definitions.jsonis excluded by!class_generator/schema/**class_generator/schema/aaq.jsonis excluded by!class_generator/schema/**class_generator/schema/aaqlist.jsonis excluded by!class_generator/schema/**class_generator/schema/all.jsonis excluded by!class_generator/schema/**class_generator/schema/apiresource.jsonis excluded by!class_generator/schema/**class_generator/schema/apiresourcelist.jsonis excluded by!class_generator/schema/**class_generator/schema/backingstore.jsonis excluded by!class_generator/schema/**class_generator/schema/backingstorelist.jsonis excluded by!class_generator/schema/**class_generator/schema/bucketclass.jsonis excluded by!class_generator/schema/**class_generator/schema/bucketclasslist.jsonis excluded by!class_generator/schema/**class_generator/schema/cdi.jsonis excluded by!class_generator/schema/**class_generator/schema/cdiconfig.jsonis excluded by!class_generator/schema/**class_generator/schema/cdiconfiglist.jsonis excluded by!class_generator/schema/**class_generator/schema/cdilist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephblockpool.jsonis excluded by!class_generator/schema/**class_generator/schema/cephblockpoollist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephblockpoolradosnamespace.jsonis excluded by!class_generator/schema/**class_generator/schema/cephblockpoolradosnamespacelist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephbucketnotification.jsonis excluded by!class_generator/schema/**class_generator/schema/cephbucketnotificationlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephbuckettopic.jsonis excluded by!class_generator/schema/**class_generator/schema/cephbuckettopiclist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephclient.jsonis excluded by!class_generator/schema/**class_generator/schema/cephclientlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephcluster.jsonis excluded by!class_generator/schema/**class_generator/schema/cephclusterlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephconnection.jsonis excluded by!class_generator/schema/**class_generator/schema/cephconnectionlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephcosidriver.jsonis excluded by!class_generator/schema/**class_generator/schema/cephcosidriverlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephfilesystem.jsonis excluded by!class_generator/schema/**class_generator/schema/cephfilesystemlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephfilesystemmirror.jsonis excluded by!class_generator/schema/**class_generator/schema/cephfilesystemmirrorlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephfilesystemsubvolumegroup.jsonis excluded by!class_generator/schema/**class_generator/schema/cephfilesystemsubvolumegrouplist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephnfs.jsonis excluded by!class_generator/schema/**class_generator/schema/cephnfslist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectrealm.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectrealmlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectstore.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectstorelist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectstoreuser.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectstoreuserlist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectzone.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectzonegroup.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectzonegrouplist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephobjectzonelist.jsonis excluded by!class_generator/schema/**class_generator/schema/cephrbdmirror.jsonis excluded by!class_generator/schema/**class_generator/schema/cephrbdmirrorlist.jsonis excluded by!class_generator/schema/**class_generator/schema/clientprofile.jsonis excluded by!class_generator/schema/**class_generator/schema/clientprofilelist.jsonis excluded by!class_generator/schema/**class_generator/schema/clientprofilemapping.jsonis excluded by!class_generator/schema/**class_generator/schema/clientprofilemappinglist.jsonis excluded by!class_generator/schema/**class_generator/schema/clustercatalog.jsonis excluded by!class_generator/schema/**class_generator/schema/clustercataloglist.jsonis excluded by!class_generator/schema/**class_generator/schema/clusterextension.jsonis excluded by!class_generator/schema/**class_generator/schema/clusterextensionlist.jsonis excluded by!class_generator/schema/**class_generator/schema/csiaddonsnode.jsonis excluded by!class_generator/schema/**class_generator/schema/csiaddonsnodelist.jsonis excluded by!class_generator/schema/**class_generator/schema/dataimportcron.jsonis excluded by!class_generator/schema/**class_generator/schema/dataimportcronlist.jsonis excluded by!class_generator/schema/**class_generator/schema/datasource.jsonis excluded by!class_generator/schema/**class_generator/schema/datasourcelist.jsonis excluded by!class_generator/schema/**class_generator/schema/datavolume.jsonis excluded by!class_generator/schema/**class_generator/schema/datavolumelist.jsonis excluded by!class_generator/schema/**class_generator/schema/driver.jsonis excluded by!class_generator/schema/**class_generator/schema/driverlist.jsonis excluded by!class_generator/schema/**class_generator/schema/encryptionkeyrotationcronjob.jsonis excluded by!class_generator/schema/**class_generator/schema/encryptionkeyrotationcronjoblist.jsonis excluded by!class_generator/schema/**class_generator/schema/encryptionkeyrotationjob.jsonis excluded by!class_generator/schema/**class_generator/schema/encryptionkeyrotationjoblist.jsonis excluded by!class_generator/schema/**class_generator/schema/hostpathprovisioner.jsonis excluded by!class_generator/schema/**class_generator/schema/hostpathprovisionerlist.jsonis excluded by!class_generator/schema/**class_generator/schema/hyperconverged.jsonis excluded by!class_generator/schema/**class_generator/schema/hyperconvergedlist.jsonis excluded by!class_generator/schema/**class_generator/schema/imagepruner.jsonis excluded by!class_generator/schema/**class_generator/schema/infrastructure.jsonis excluded by!class_generator/schema/**class_generator/schema/kubestorageversionmigrator.jsonis excluded by!class_generator/schema/**class_generator/schema/kubevirt.jsonis excluded by!class_generator/schema/**class_generator/schema/kubevirtlist.jsonis excluded by!class_generator/schema/**class_generator/schema/localvolume.jsonis excluded by!class_generator/schema/**class_generator/schema/localvolumediscovery.jsonis excluded by!class_generator/schema/**class_generator/schema/localvolumediscoverylist.jsonis excluded by!class_generator/schema/**class_generator/schema/localvolumediscoveryresult.jsonis excluded by!class_generator/schema/**class_generator/schema/localvolumediscoveryresultlist.jsonis excluded by!class_generator/schema/**class_generator/schema/localvolumelist.jsonis excluded by!class_generator/schema/**class_generator/schema/localvolumeset.jsonis excluded by!class_generator/schema/**class_generator/schema/localvolumesetlist.jsonis excluded by!class_generator/schema/**class_generator/schema/machine.jsonis excluded by!class_generator/schema/**class_generator/schema/machinehealthcheck.jsonis excluded by!class_generator/schema/**class_generator/schema/machineset.jsonis excluded by!class_generator/schema/**class_generator/schema/migrationpolicy.jsonis excluded by!class_generator/schema/**class_generator/schema/migrationpolicylist.jsonis excluded by!class_generator/schema/**class_generator/schema/namespacestore.jsonis excluded by!class_generator/schema/**class_generator/schema/namespacestorelist.jsonis excluded by!class_generator/schema/**class_generator/schema/networkaddonsconfig.jsonis excluded by!class_generator/schema/**class_generator/schema/networkaddonsconfiglist.jsonis excluded by!class_generator/schema/**class_generator/schema/networkfence.jsonis excluded by!class_generator/schema/**class_generator/schema/networkfenceclass.jsonis excluded by!class_generator/schema/**class_generator/schema/networkfenceclasslist.jsonis excluded by!class_generator/schema/**class_generator/schema/networkfencelist.jsonis excluded by!class_generator/schema/**class_generator/schema/nmstate.jsonis excluded by!class_generator/schema/**class_generator/schema/nmstatelist.jsonis excluded by!class_generator/schema/**class_generator/schema/nodenetworkconfigurationenactment.jsonis excluded by!class_generator/schema/**class_generator/schema/nodenetworkconfigurationenactmentlist.jsonis excluded by!class_generator/schema/**class_generator/schema/nodenetworkconfigurationpolicy.jsonis excluded by!class_generator/schema/**class_generator/schema/nodenetworkconfigurationpolicylist.jsonis excluded by!class_generator/schema/**class_generator/schema/nodenetworkstate.jsonis excluded by!class_generator/schema/**class_generator/schema/nodenetworkstatelist.jsonis excluded by!class_generator/schema/**class_generator/schema/noobaa.jsonis excluded by!class_generator/schema/**class_generator/schema/noobaaaccount.jsonis excluded by!class_generator/schema/**class_generator/schema/noobaaaccountlist.jsonis excluded by!class_generator/schema/**class_generator/schema/noobaalist.jsonis excluded by!class_generator/schema/**class_generator/schema/objectbucket.jsonis excluded by!class_generator/schema/**class_generator/schema/objectbucketclaim.jsonis excluded by!class_generator/schema/**class_generator/schema/objectbucketclaimlist.jsonis excluded by!class_generator/schema/**class_generator/schema/objectbucketlist.jsonis excluded by!class_generator/schema/**class_generator/schema/objecttransfer.jsonis excluded by!class_generator/schema/**class_generator/schema/objecttransferlist.jsonis excluded by!class_generator/schema/**class_generator/schema/ocsinitialization.jsonis excluded by!class_generator/schema/**class_generator/schema/ocsinitializationlist.jsonis excluded by!class_generator/schema/**class_generator/schema/olm.jsonis excluded by!class_generator/schema/**class_generator/schema/olmlist.jsonis excluded by!class_generator/schema/**class_generator/schema/openstackvolumepopulator.jsonis excluded by!class_generator/schema/**class_generator/schema/openstackvolumepopulatorlist.jsonis excluded by!class_generator/schema/**class_generator/schema/operatorconfig.jsonis excluded by!class_generator/schema/**class_generator/schema/operatorconfiglist.jsonis excluded by!class_generator/schema/**class_generator/schema/ovirtvolumepopulator.jsonis excluded by!class_generator/schema/**class_generator/schema/ovirtvolumepopulatorlist.jsonis excluded by!class_generator/schema/**class_generator/schema/persistentvolumeclaimvolumesource.jsonis excluded by!class_generator/schema/**class_generator/schema/recipe.jsonis excluded by!class_generator/schema/**class_generator/schema/recipelist.jsonis excluded by!class_generator/schema/**class_generator/schema/reclaimspacecronjob.jsonis excluded by!class_generator/schema/**class_generator/schema/reclaimspacecronjoblist.jsonis excluded by!class_generator/schema/**class_generator/schema/reclaimspacejob.jsonis excluded by!class_generator/schema/**class_generator/schema/reclaimspacejoblist.jsonis excluded by!class_generator/schema/**class_generator/schema/route.jsonis excluded by!class_generator/schema/**class_generator/schema/routelist.jsonis excluded by!class_generator/schema/**class_generator/schema/ssp.jsonis excluded by!class_generator/schema/**class_generator/schema/ssplist.jsonis excluded by!class_generator/schema/**class_generator/schema/storageclaim.jsonis excluded by!class_generator/schema/**class_generator/schema/storageclaimlist.jsonis excluded by!class_generator/schema/**class_generator/schema/storageclient.jsonis excluded by!class_generator/schema/**class_generator/schema/storageclientlist.jsonis excluded by!class_generator/schema/**class_generator/schema/storagecluster.jsonis excluded by!class_generator/schema/**class_generator/schema/storageclusterlist.jsonis excluded by!class_generator/schema/**class_generator/schema/storageclusterpeer.jsonis excluded by!class_generator/schema/**class_generator/schema/storageclusterpeerlist.jsonis excluded by!class_generator/schema/**class_generator/schema/storageconsumer.jsonis excluded by!class_generator/schema/**class_generator/schema/storageconsumerlist.jsonis excluded by!class_generator/schema/**class_generator/schema/storageprofile.jsonis excluded by!class_generator/schema/**class_generator/schema/storageprofilelist.jsonis excluded by!class_generator/schema/**class_generator/schema/storagerequest.jsonis excluded by!class_generator/schema/**class_generator/schema/storagerequestlist.jsonis excluded by!class_generator/schema/**class_generator/schema/storagesystem.jsonis excluded by!class_generator/schema/**class_generator/schema/storagesystemlist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachine.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineclone.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineclonelist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineclusterinstancetype.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineclusterinstancetypelist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineclusterpreference.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineclusterpreferencelist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineexport.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineexportlist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstance.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancelist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancemigration.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancemigrationlist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancepreset.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancepresetlist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancereplicaset.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancereplicasetlist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancetype.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachineinstancetypelist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinelist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinepool.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinepoollist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinepreference.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinepreferencelist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinerestore.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinerestorelist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinesnapshot.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinesnapshotcontent.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinesnapshotcontentlist.jsonis excluded by!class_generator/schema/**class_generator/schema/virtualmachinesnapshotlist.jsonis excluded by!class_generator/schema/**class_generator/schema/volumeclonesource.jsonis excluded by!class_generator/schema/**class_generator/schema/volumeclonesourcelist.jsonis excluded by!class_generator/schema/**class_generator/schema/volumegroupreplication.jsonis excluded by!class_generator/schema/**class_generator/schema/volumegroupreplicationclass.jsonis excluded by!class_generator/schema/**class_generator/schema/volumegroupreplicationclasslist.jsonis excluded by!class_generator/schema/**class_generator/schema/volumegroupreplicationcontent.jsonis excluded by!class_generator/schema/**class_generator/schema/volumegroupreplicationcontentlist.jsonis excluded by!class_generator/schema/**class_generator/schema/volumegroupreplicationlist.jsonis excluded by!class_generator/schema/**class_generator/schema/volumeimportsource.jsonis excluded by!class_generator/schema/**class_generator/schema/volumeimportsourcelist.jsonis excluded by!class_generator/schema/**class_generator/schema/volumereplication.jsonis excluded by!class_generator/schema/**class_generator/schema/volumereplicationclass.jsonis excluded by!class_generator/schema/**class_generator/schema/volumereplicationclasslist.jsonis excluded by!class_generator/schema/**class_generator/schema/volumereplicationlist.jsonis excluded by!class_generator/schema/**class_generator/schema/volumeuploadsource.jsonis excluded by!class_generator/schema/**class_generator/schema/volumeuploadsourcelist.jsonis excluded by!class_generator/schema/**
📒 Files selected for processing (2)
class_generator/__cluster_version__.txt(1 hunks)ocp_resources/pod_metrics.py(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- class_generator/cluster_version.txt
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: python-module-install
- GitHub Check: tox
🔇 Additional comments (2)
ocp_resources/pod_metrics.py (2)
1-8: LGTM!The imports are appropriate for the functionality being implemented, and the header comment provides useful information about code generation.
15-15: LGTM!The explicit typing of
api_groupand its value fromNamespacedResource.ApiGroup.METRICS_K8S_IOare appropriate.
|
/verified |
dbasunag
approved these changes
Feb 10, 2025
rnetser
approved these changes
Feb 12, 2025
|
/verified |
|
/verified |
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary by CodeRabbit
New Features
Chores
Documentation
Machineclass.