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

feat: Boost default resources and support configuring healthcheck probes #81

Merged
merged 4 commits into from
Feb 6, 2024

Conversation

jsirianni
Copy link
Member

@jsirianni jsirianni commented Feb 5, 2024

Description of Changes

On slower systems, bindplane can fail to deploy because it takes too long to startup. The default cpu / memory values are too low in general, and fall outside of our recommended sizing.

To combat this, I have boosted the default resources and exposed each healthcheck in the values file.

  • Boosted default CPU request to 1000m (one core)
  • Boosted default memory request to 1000Mi
  • Boosted default memory limit to 1000Mi
  • Exposed startup, readiness, and liveness probes in the values file

Testing

First, deploy the main branch in order to test upgrading to this branch.

minikube start

Create values.yaml file:

config:
  username: bpuser
  password: bppass
  secret_key: 12D8FB6E-1532-4A4C-97AF-95A430BE5E6E
  sessions_secret: 4484766F-5016-4077-B8E0-0DE1D637854B
prometheus:
  enable: true
  enableSideCar: true
dev:
  collector:
    create: true

Deploy with:

helm --values values.yaml template charts/bindplane | k apply -f -

Wait for the pods to startup. kubectl get pod -n default.

Once stabilized, you can checkout this branch and re-run the helm template command. You should see the bindplane pod and the transform pod restarting, with new resource values.

You can view the rendered yaml using helm template without piping to kubectl.

helm --values values.yaml template charts/bindplane

If you inspect the yaml output, you will see that the healthcheck probes have the correct configuration.

You can log into bindplane with:

kubectl port-forward \
  pod/release-name-bindplane-0 3011:3001 \
  --address 0.0.0.0

Navigate to http://localhost:3011 and login with bpuser / bppass.

Please check that the PR fulfills these requirements

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • CI passes

@jsirianni jsirianni marked this pull request as ready for review February 5, 2024 18:10
@jsirianni jsirianni requested a review from a team as a code owner February 5, 2024 18:10
@jsirianni jsirianni requested review from cpheps and dsvanlani February 5, 2024 18:10
@jsirianni jsirianni requested review from antonblock and removed request for dsvanlani February 6, 2024 14:15
@jsirianni jsirianni merged commit 53497d9 into main Feb 6, 2024
16 checks passed
@jsirianni jsirianni deleted the fix/startup-performance branch February 6, 2024 16:09
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.

3 participants