Skip to content

feat: add templates for debugging purposes#25

Merged
mariajgrimaldi merged 10 commits into
mainfrom
MJG/debug
Nov 30, 2022
Merged

feat: add templates for debugging purposes#25
mariajgrimaldi merged 10 commits into
mainfrom
MJG/debug

Conversation

@mariajgrimaldi
Copy link
Copy Markdown
Contributor

@mariajgrimaldi mariajgrimaldi commented Nov 28, 2022

Description

This PR adds k8s templates for debug pods, i.e pods running with non-production setup (root user, container entrypoint/command changed, ...), which allow developers to debug services like LMS/CMS in a production-like environment.

How to test

  1. Configure debugging capabilities:
# config.yml
OPENEDX_DEBUG_COOKIE: ednx_enable_debug # or anything else
DRYDOCK_DEBUG: False
  1. Generate new manifests
  2. Sync in argoCD
  3. Increase replicas for debug services
    k scale --replicas=1 deployment/lms-debug
    or
    k scale --replicas=1 deployment/cms-debug
  4. Go to the LMS/Studio page. Then, add your cookie:
    ednx_enable_debug: always
  5. Check the traffic is being redirected to your debugging pod.

You can test this in yamato using any namespace defined.

@mariajgrimaldi mariajgrimaldi changed the title Mjg/debug feat: add templates for debugging purposes Nov 28, 2022
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review November 28, 2022 20:42
@mariajgrimaldi mariajgrimaldi requested a review from a team November 28, 2022 20:42
Comment thread drydock/templates/kustomized/tutor14/extensions/hpa.yml Outdated
Comment thread drydock/templates/kustomized/tutor14/extensions/overrides.yml Outdated
Comment thread drydock/templates/kustomized/tutor13/extensions/debug/deployments.yml Outdated
Comment thread drydock/templates/kustomized/tutor13/extensions/debug/ingress.yml Outdated
Comment thread drydock/templates/kustomized/tutor13/extensions/debug/ingress.yml
Copy link
Copy Markdown
Member

@MoisesGSalas MoisesGSalas left a comment

Choose a reason for hiding this comment

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

LGTM

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.

2 participants