Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The following is the usage help for the onos-diagnostics-k8s tool:

Code Block
languagetext
usage: onos-diagnostics-k8s [-x] [-j] [-n name] [-k karaf_home] [pod1 pod2...]
Environment Variables:
    DIAGS_PROFILE     Profile to be used to collect diags.
                      Availables profiles in onos-diagnostics-profile
    KARAF_HOME        KARAF_HOME inside the ONOS pod (path from the mount point)
    ONOS_PODS         ONOS pods composing the cluster
Example Usages:
    # Collect compressed diagnostics for the cluster.
    # Karaf home is drawn from environment variable.
    # Collection archive will be named /tmp/onos-diags.tar.gz
    # ONOS pods names will be drawn from ONOS_PODS variable.
    # Diags profile is drawn from environment variable.
    $ onos-diagnostics-k8s 
    # Collect diagnostics for the cluster and leave them extracted. 
    # Collection directory will be named /tmp/prague-diags/
    # Collection archive will be named /tmp/prague-diags.tar.gz.
    # Karaf home is '/root/foo/karaf'.
    # ONOS pods names will be drawn from ONOS_PODS variable.
    $ onos-diagnostics-k8s -x -n prague -k karaf
    # Collect diagnostics for the cluster and store them in JSON files.
    # JSON_CLI_COMMANDS below lists JSON-supported diagnostics commands.
    # Collection archive will be named /tmp/onos-diags.tar.gz
    $ onos-diagnostics-k8s -j
    # Collect compressed diagnostics for a cluster.
    # Karaf home is 'karaf'.
    # Collection archive will be named /tmp/onos-diags.tar.gz
    # The pods names are listed explicitly.
    $ onos-diagnostics-k8s -k karaf onos-0 onos-1 onos-2

...