Add Debugging page to docs website

[benjaminapetersen]

TODO:

• Lets change this to a dedicated debugging page
  • Move the env var to this page
  • Add the debugging yaml to this page
  • Add the rm -rf ~/.config/pinniped trick to this page, for "logging out", clearing caches, etc.

Release note:

[cfryanr]

Good idea to document this. I think it might make more sense at the bottom of this page https://pinniped.dev/docs/howto/login/ which is where we show how to use the pinniped CLI.

[benjaminapetersen]

I'd even consider an additional "Debugging" page where we document this env var as well as the YAML changes to enable debugging for server side components.

[cfryanr]

I'd even consider an additional "Debugging" page where we document this env var as well as the YAML changes to enable debugging for server side components.

That sounds reasonable to me.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 38.69%. Comparing base (f0a43e0) to head (fbd69ae).

❗ Current head fbd69ae differs from pull request most recent head 6718a32. Consider uploading reports for the commit 6718a32 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1824      +/-   ##
==========================================
+ Coverage   38.56%   38.69%   +0.12%     
==========================================
  Files         350      335      -15     
  Lines       44514    43626     -888     
==========================================
- Hits        17168    16879     -289     
+ Misses      26831    26244     -587     
+ Partials      515      503      -12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[joshuatcasey]

lgtm, just add the note about how to edit the log level inside the configmap

[cfryanr]

I think you meant to say using ytt, not using kapp.

And you don't edit the values.yaml file. See the other docs for instructions.

[benjaminapetersen]

Ah, yeah I see we tell users to create a NEW values.yaml file and add just the config they desire to change:

# ./my-supervisor-values.yaml

#@data/values
---
image_tag: v0.29.0
log_level: debug
replicas: 1

And then something ytt --file /path/to/pinniped/deploy/supervisor --file ./my-supervisor-values.yaml

[cfryanr]

After applying the configuration, you must also restart the pods for the change to get picked up.

This whole section might make more sense if you split it into two sections: one for updating the log level for the Supervisor and another for updating the log level for the Concierge. The commands are slightly different, and the file that you show above would actually not have both configmaps in it if you use the commands that you show above to create the files.