Skip to content

Unify Queue Name Keys and add SetObjQueue helper#55

Open
yoursanonymous wants to merge 1 commit intovolcano-sh:mainfrom
yoursanonymous:fix/unify-utils
Open

Unify Queue Name Keys and add SetObjQueue helper#55
yoursanonymous wants to merge 1 commit intovolcano-sh:mainfrom
yoursanonymous:fix/unify-utils

Conversation

@yoursanonymous
Copy link
Copy Markdown

Description

Standardize on volcano.sh/queue-name as the primary key for identifying queues across all objects and provide a consistent helper for setting this value.

@volcano-sh-bot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign monokaix for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gemini-code-assist
Copy link
Copy Markdown

Summary of Changes

Hello @yoursanonymous, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the queue management within the Volcano project by standardizing the key used for identifying queues across various Kubernetes objects. It also introduces a new helper function to streamline the process of assigning queues, leading to more consistent and maintainable code.

Highlights

  • Unification of Queue Name Keys: Standardized on 'volcano.sh/queue-name' as the primary key for identifying queues across all objects, replacing previous API-specific constants and improving consistency.
  • New Helper Function: Introduced a new utility function, SetObjQueue, to provide a consistent and simplified way to set the queue name on Kubernetes objects.
  • Dependency Reduction: Removed direct imports of batchv1alpha1 and schedulingv1beta1 from pkg/utils/queue.go, reducing external API dependencies within the utility package.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • pkg/utils/queue.go
    • Standardized queue name keys to volcano.sh/queue-name and scheduling.volcano.sh/queue-name by defining them as package constants.
    • Removed external API imports (batchv1alpha1, schedulingv1beta1) as their queue key definitions are now internal.
    • Updated GetObjQueue function to utilize the newly defined standardized queue name constants.
    • Added a new function SetObjQueue(obj metav1.Object, queue string) to consistently set the volcano.sh/queue-name label on objects.
Activity
  • No human activity has been recorded on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request is a good improvement. It unifies the queue name keys and adds a helpful SetObjQueue function, which will make the code cleaner and more consistent. I have one suggestion to improve the behavior of SetObjQueue for empty queue names.

Comment thread pkg/utils/queue.go
Comment on lines +57 to +58
labels[QueueNameKey] = queue
obj.SetLabels(labels)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The current implementation will set the volcano.sh/queue-name label to an empty string if an empty queue string is provided. This will cause GetObjQueue to return an empty string, instead of falling back to the defaultQueue. This is likely unintended. It would be better to remove the label if the provided queue name is empty, so that GetObjQueue can correctly return the default queue.

	if queue != "" {
		labels[QueueNameKey] = queue
	} else {
		delete(labels, QueueNameKey)
	}
	obj.SetLabels(labels)

Signed-off-by: vinayak sharma <vinayaks0111@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants