Pinniped Documentation
Debugging Pinniped
Debugging on the Client
The PINNIPED_DEBUG=true
environment variable can be set to enable additional CLI logging.
Debugging on the Server
To adjust the log level of either the Pinniped Supervisor or the Pinniped Concierge the log level value must be updated in the appropriate configmap associated with each deployment.
The log level
options are as follows:
info
(“nice to know” information)debug
(developer information)trace
(timing information)all
(kitchen sink)
Do not use trace
or all
on production systems, as credentials may get logged. When this value is left unset,
only warnings and errors are printed. There is no way to suppress warning and error logs.
Choose an update method that corresponds with the original installation method you chose for your cluster. Consult Install Supervisor or Install Concierge for more information.
Using ytt and kapp for Supervisor
Refer to the Install Supervisor page for instructions for installing
kapp
andytt
. These instructions assume that the Supervisor was previously installed on your cluster in a way that conforms to the Using kapp heading and that theytt
andkapp
command-line tools have been installed using the instructions from the Carvel documentation.Clone the Pinniped GitHub repository and visit the
deploy/supervisor
directorygit clone git@github.com:vmware-tanzu/pinniped.git
cd pinniped/deploy/supervisor
Assess which release version is installed on your cluster. All release versions are listed on GitHub.
Checkout the version that corresponds to the version tag installed on your cluster, e.g.
v0.33.0
.git checkout v0.33.0
Run the following command to render the templates and redeploy the Supervisor with the adjusted
log level
:ytt --file . --data-value log_level=trace | kapp deploy --app pinniped-supervisor --yes --file -
Restart the Supervisor pods:
kubectl delete --all pods -n pinniped-supervisor
Reset the log level when debugging is finished.
Using ytt and kapp for Concierge
Refer to the Install Concierge page for instructions for installing
kapp
andytt
. These instructions assume that the Concierge was previously installed on your cluster in a way that conforms to the Using kapp heading and that theytt
andkapp
command-line tools have been installed using the instructions from the Carvel documentation.Clone the Pinniped GitHub repository and visit the
deploy/concierge
directorygit clone git@github.com:vmware-tanzu/pinniped.git
cd pinniped/deploy/concierge
Assess which release version is installed on your cluster. All release versions are listed on GitHub.
Checkout the version that corresponds to the version tag installed on your cluster, e.g.
v0.33.0
.git checkout v0.33.0
Run the following command to render the templates and redeploy the Concierge with the adjusted
log level
:ytt --file . --data-value log_level=trace | kapp deploy --app pinniped-concierge --yes --file -
Restart the Concierge pods:
kubectl delete --all pods -n pinniped-concierge
Reset the log level when debugging is finished.
Using kubectl for Supervisor
These instructions assume that the Supervisor was previously installed on your cluster in a way that conforms to the Using kubectl heading on the Install Supervisor page.
To adjust the log level of the Pinniped Supervisor using
kubectl
, find the Supervisor’s configuration configmap:kubectl get cm pinniped-supervisor-static-config --namespace pinniped-supervisor --output yaml > supervisor-cm.yaml
Edit this configmap to change the
log level
:kind: ConfigMap apiVersion: v1 metadata: name: pinniped-supervisor-static-config namespace: pinniped-supervisor data: pinniped.yaml: | apiGroupSuffix: pinniped.dev log: level: trace # ...
Apply the new configuration:
kubectl apply -f supervisor-cm.yaml
Restart the Supervisor pods:
kubectl delete --all pods -n pinniped-supervisor
Reset the log level when debugging is finished.
Using kubectl for Concierge
These instructions assume that the Concierge was previously installed on your cluster in a way that conforms to the Using kubectl heading on the Install Concierge page.
To adjust the log level of the Pinniped Concierge using
kubectl
, find the Concierge’s configuration configmap:kubectl get cm pinniped-concierge-config --namespace pinniped-concierge --output yaml > concierge-cm.yaml
Edit this configmap to change the
log level
:kind: ConfigMap apiVersion: v1 metadata: name: pinniped-concierge-config namespace: pinniped-concierge data: pinniped.yaml: | apiGroupSuffix: pinniped.dev log: level: trace # ...
Apply the new configuration:
kubectl apply -f concierge-cm.yaml
Restart the Concierge pods:
kubectl delete --all pods -n pinniped-concierge
Reset the log level when debugging is finished.
Clearing session and credential caching by the CLI
Temporary session credentials such as ID, access, and refresh tokens are stored in:
$HOME/.config/pinniped/sessions.yaml
(macOS/Linux)%USERPROFILE%/.config/pinniped/sessions.yaml
(Windows).
Temporary cluster credentials such mTLS client certificates are stored in:
$HOME/.config/pinniped/credentials.yaml
(macOS/Linux)%USERPROFILE%/.config/pinniped/credentials.yaml
(Windows).
Deleting the contents of these directories (rm -rf $HOME/.config/pinniped
) is equivalent to performing a client-side logout.