brc

brc

BubbleRAN Commandline

Synopsis

BubbleRAN CLI (brc) is a Command Line Interface (CLI) to interact with the Trirematics platform.

Configuration Files

For accessing to your cluster, Trirematics CLI needs to know the Kubernetes configuration file. By default, Trirematics CLI looks for the file in the following locations:

• $HOME/snap/br-t9s/current/.kube/config
• where the variable $KUBECONFIG is pointing to

danger

Please note that if you are using Snap package, then you need to make sure your provided path is accessible to the Snap. This limits the paths to only directories and subdirectories of the home directory that are not hidden (they do not start with a dot).

tip

You could find a copy of your Kubernetes configuration file in the USB drive provided to you beside BubbleRAN package. You could always recover this file from your master by running:

kubectl config view --raw

or by copying it from /etc/kubernetes/admin.conf.

Environment Variables

This CLI is built using Cobra and Viper libraries in Golang. You could use environment variables in the format of BRC_PARAM=value to set value for a certain input parameter. For example, BRC_NAMESPACE will set the value of namespace parameter in the whole environment and becomes the default value for all commands. You could have these variables set into your shell environment or use the export command to set them in the current shell session.

Examples

brc --version

Options

  -h, --help               help for brc
  -n, --namespace string   namespace to perform the operations (default "trirematics")
  -v, --verbose            debug output

SEE ALSO

• brc cic - CLI-in-CLI
• brc diag - Perform diagnostics against the cluster
• brc disrupt - Create chaos in the deployment.
• brc extract - Extract logs, configuration, PCAPs, or infrastructure details
• brc install - Install a component on Trirematics
• brc list - List all instances of a component on Trirematics
• brc login - Authenticate to BubbleRAN Hub OCI registry
• brc observe - Open up the observation toolbox
• brc power - Manage and observe the power state
• brc remove - Remove a component on Trirematics
• brc test - Perform a test to evaluate the network performance

Auto generated by spf13/cobra on 23-Apr-2025