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

Increase resource limit comments/hints #430

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

gnyahay
Copy link
Contributor

@gnyahay gnyahay commented Jan 13, 2025

Provide more accurate comments/hints for resource requests & limits.

@gnyahay gnyahay requested a review from lwade January 13, 2025 19:54
@gnyahay gnyahay requested a review from a team as a code owner January 13, 2025 19:54
@gnyahay gnyahay force-pushed the gn/bugfix/increase-resource-limits branch 3 times, most recently from 1abe4fd to 9eaf182 Compare January 13, 2025 19:58
@gnyahay gnyahay requested a review from nurmi January 13, 2025 19:59
@gnyahay gnyahay force-pushed the gn/bugfix/increase-resource-limits branch from 9eaf182 to 813c110 Compare January 13, 2025 20:00
lwade
lwade previously approved these changes Jan 15, 2025
Copy link

@lwade lwade left a comment

Choose a reason for hiding this comment

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

LGTM

@gnyahay gnyahay force-pushed the gn/bugfix/increase-resource-limits branch from 813c110 to 00f0819 Compare January 15, 2025 15:53
@gnyahay gnyahay force-pushed the gn/bugfix/increase-resource-limits branch from 00f0819 to 30878e8 Compare January 24, 2025 19:49
Daren-42
Daren-42 previously approved these changes Jan 24, 2025
Copy link

@Daren-42 Daren-42 left a comment

Choose a reason for hiding this comment

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

Looks good

Copy link
Member

@zhill zhill left a comment

Choose a reason for hiding this comment

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

I appreciate the work here and like the intent of this, but I think our general approach for documenting best practices etc needs discussion around what is the right level of info in the values.yaml itself compared to other documentation that covers how to use the chart to achieve specific goals.

I agree the comments should be correct and any guidance we give shouldn't be inconsistent. I think there is more discussion on the specific values chosen, and the intent of those specific settings so we can review in that context.

# memory: 8G
# limits:
# cpu: 2
Copy link
Member

Choose a reason for hiding this comment

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

It seems that if we don't suggest setting CPU limits, then we shouldn't have them in here at all, just the requests.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

In cases where they are going to set them anyway I want to make sure they don't set it too low.
I am also hoping the BB chart follows our example: https://repo1.dso.mil/big-bang/product/packages/anchore-enterprise/-/blob/main/chart/values.yaml?ref_type=heads#L1444

@@ -1012,6 +1019,7 @@ catalog:
#########################################################
dataSyncer:
## @param dataSyncer.replicaCount Number of replicas for the Anchore DataSyncer deployment
## Please note that we do not suggest more than 1 instance of dataSyncer.
Copy link
Member

Choose a reason for hiding this comment

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

If we don't suggest this, should we remove this as a configurable option? I think we have to assume that while our comments should be correct, they won't be read nor followed.

Copy link

Choose a reason for hiding this comment

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

Yes please! @gnyahay @InfraInnovator @zhill - lets just remove the option

@gnyahay gnyahay force-pushed the gn/bugfix/increase-resource-limits branch from 30878e8 to b5c26f4 Compare January 28, 2025 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants