Support Bundles

This page describes how to gather the information required by R3 to assist you with troubleshooting in the event of an issue with a Corda deployment on Kubernetes.

  1. Set the Kubernetes context to use the namespace where Corda is installed by default.

    kubectl config set-context --current --namespace=$CORDA_NAMESPACE
    

    Where $CORDA_NAMESPACE is the name of the namespace into which Corda is deployed.

  2. Gather the required information either:

Creating a Support Bundle Using Scripts

  1. Obtain the bundle creation script support_bundle.sh(Bash) or support_bundle.ps1(PowerShell) from GitHub, or from Customer Hub.

  2. Execute the script to generate a .tar or a .zip file containing the support information in the current directory:

    ./support_bundle.sh
    
    .\support_bundle.ps1
    

Manually Gathering Information for Support

  1. Collect the Corda Helm chart release name, version, and app version:

    helm ls
    
  2. Collect custom values and the manifest for the Helm release for Corda:

    helm get values $RELEASE_NAME
    helm get manifest $RELEASE_NAME
    

    Where $RELEASE_NAME is the name of the Helm release for Corda.

  3. Collect information from all Corda pods:

    kubectl describe pods --selector app.kubernetes.io/name=corda
    
  4. Collect information from all Corda services:

    kubectl describe services --selector app.kubernetes.io/name=corda
    
  5. Collect Kubernetes events:

    kubectl get events
    
  6. Collect logs and status for the Corda pods:

    1. Get the list of Corda pods:

      kubectl get pods --selector app.kubernetes.io/name=corda
      
    2. For each pod in the list, collect logs, previous logs, and worker status:

      kubectl logs $POD_NAME
      kubectl logs -p $POD_NAME
      kubectl port-forward $POD_NAME 7000 &
      curl localhost:7000/status
      

      Where $POD_NAME is a Corda pod name from the list.

Modifying the Log Level

You may be directed by R3 to increase the level of logging to aid problem determination. This is achieved by modifying the deployment configuration YAML. The logging level can be modified for all workers, for example:

logging:
  level: "debug"

Or the logging level can be modified for one type of worker, for example:

workers:
  db:
    logging:
      level: "trace"

Apply the modified configuration by upgrading the Helm release. For example:

helm upgrade corda --namespace corda -f updated-values.yaml

Was this page helpful?

Thanks for your feedback!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.

We're sorry this page wasn't helpful. Let us know how we can make it better!

Chat with us

Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.

Create an issue

Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.

Propose documentation improvements directly

Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.