Skip to content

docs: update resource entry comments for CPU limits and production recs #4518

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

natemollica-nm
Copy link
Contributor

@natemollica-nm natemollica-nm commented Apr 10, 2025


Changes proposed in this PR

  • Updates the values.yaml comment documentation to recommend setting CPU limits to null in production for service-mesh–related components (e.g., connectInject, meshGateway, terminatingGateway, API Gateway, etc.).
  • Adds references to the recommended CPU and memory guidelines (Small vs. Large clusters) for Consul servers in production, as per the reference architecture.

How I've tested this PR

  • Verified that the values.yaml file retains all original data and keys, with no functional changes besides setting some default CPU limits to null for service mesh components.
  • Ran a local Helm install to ensure the chart still loads successfully and that the comments render as expected in the generated ConfigMap.

How I expect reviewers to test this PR

  1. Check the values.yaml diffs: Confirm that all existing settings are untouched aside from the new doc blocks and null CPU limit changes for mesh components.
  2. Validate resource updates: (Optional) Perform a helm template or local deployment to see the changes in resource definitions, ensuring the new CPU limit settings appear as commented.
  3. Review doc clarity: Make sure the new references to recommended production sizing are clear, and that instructions about using null CPU limits for mesh components are understandable.

Checklist

  • Tests added (N/A or minimal since this is a doc-focused PR, but confirm if any Helm chart lint tests are relevant)
    • Updated the following to cover resource updatescharts/consul/test/unit tests:
      • connect-inject-deployment.bats
      • ingress-gateways-deployment.bats
      • mesh-gateway-deployment.bats
      • server-statefulset.bats
      • terminating-gateways-deployment.bats
  • CHANGELOG entry added

@natemollica-nm natemollica-nm added area/upgrades Related to upgrading the helm chart type/docs Documentation needs to be created/updated/clarified labels Apr 10, 2025
@natemollica-nm natemollica-nm marked this pull request as ready for review April 10, 2025 06:47
@natemollica-nm natemollica-nm requested review from a team as code owners April 10, 2025 06:47
@natemollica-nm natemollica-nm added backport/1.4.x This release branch is no longer active. backport/1.5.x This release branch is no longer active. backport/1.6.x Changes are backported to 1.6 backport/1.7.x Backport to release/1.7.x branch labels Apr 11, 2025
@sriramr98
Copy link

Hey @natemollica-nm . Thanks for the PR

I can see a couple of acceptance tests failing. Since you've added/modified some tests, they might be related to it. Can you look into it and get it to a passing state?

@natemollica-nm
Copy link
Contributor Author

Hey @natemollica-nm . Thanks for the PR

I can see a couple of acceptance tests failing. Since you've added/modified some tests, they might be related to it. Can you look into it and get it to a passing state?

Yes! I'll dig into it more this week 😅

@natemollica-nm natemollica-nm force-pushed the update-resource-comments branch from d2d1792 to 33bcd6e Compare April 28, 2025 21:42
@natemollica-nm
Copy link
Contributor Author

@sriramr98

I'm able to pass all the failing acceptance tests from my local branch for the api-gateway acceptance tests that keep failing:

  • TestAPIGateway_Tenancy (failing for acceptance, acceptance-tproxy, and acceptance-cni)

I haven't touched any of the acceptance test framework for this PR. Only Helm chart unit tests for the values.yaml changes I made.

Is this test flaky at all in your experience? Is there anything I can do on my end to ensure this test passes?

@natemollica-nm natemollica-nm enabled auto-merge (squash) April 30, 2025 16:29
@natemollica-nm natemollica-nm force-pushed the update-resource-comments branch from 33bcd6e to cc635f5 Compare May 29, 2025 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/upgrades Related to upgrading the helm chart backport/1.4.x This release branch is no longer active. backport/1.5.x This release branch is no longer active. backport/1.6.x Changes are backported to 1.6 backport/1.7.x Backport to release/1.7.x branch type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants