Mirantis Support Console

Use the Mirantis Support Console to obtain an MSR support bundle, using either the Support Console UI or the API.

Install the Support Console

You can install the Support Console on online and offline clusters.

Install the Support Console online

Use a Helm chart to install the Support Console:

helm repo add support-console-official https://registry.mirantis.com/charts/support/console
helm repo update
helm install support-console support-console-official/support-console --version 1.0.0 --set env.PRODUCT=msr

Once the Support Console is successfully installed, the system returns the commands needed to access the Support Console UI:

Get the application URL by running these commands:
export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=support-console,app.kubernetes.io/instance=support-console" -o jsonpath="{.items[0].metadata.name}")
export CONTAINER_PORT=$(kubectl get pod --namespace default $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
echo "Visit http://127.0.0.1:8000 to use your application"
kubectl --namespace default port-forward $POD_NAME 8000:$CONTAINER_PORT

Install the Support Console offline

An Internet-connected system is required for offline installation of the Support Console, for the purpose of downloading and transferring the necessary files to the offline host.

  1. Download the Support Console image package from https://s3-us-east-2.amazonaws.com/packages-mirantis.com/caas/msc_image_1.0.0.tar.gz.

  2. Download the Helm chart package:

    helm pull https://registry.mirantis.com/charts/support/console/support-console/support-console-1.0.0.tgz
    
  3. Copy the image and Helm chart packages to the offline host machine:

    scp support-console-1.0.0.tgz msc_image_1.0.0.tar.gz
    
  4. Install the Support Console:

    helm install support-console support-console-1.0.0.tgz --version 1.0.0 --set env.PRODUCT=msr
    

Once the Support Console is successfully installed, the system returns the commands needed to access the Support Console UI:

Get the application URL by running these commands:
export POD_NAME=$(kubectl get pods --namespace default -l "app.kubernetes.io/name=support-console,app.kubernetes.io/instance=support-console" -o jsonpath="{.items[0].metadata.name}")
export CONTAINER_PORT=$(kubectl get pod --namespace default $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
echo "Visit http://127.0.0.1:8000 to use your application"
kubectl --namespace default port-forward $POD_NAME 8000:$CONTAINER_PORT

Obtain the support bundle

You can use the Support Console UI or API to obtain the MSR support bundle.

Obtain the support bundle using the Support Console UI

  1. Forward the Support Console to port 8000:

    kubectl --namespace default port-forward service/support-console 8000:8000
    
  2. In your web browser, navigate to localhost:8000 to view the Support Console UI.

  3. Click Collect Support Bundle.

  4. In the pop-up window, enter the namespace from which you want to collect support data. By default, the Support Console gathers support data from the default namespace.

  5. Optional. If you no longer require access to the Support Console, click Uninstall in the left-side navigation panel to remove the support-console Pod from your cluster.

Obtain the support bundle using the Support Console API

  1. Forward the Support Console to port 8000:

    kubectl --namespace default port-forward service/support-console 8000:8000
    
  2. Obtain the support bundle, specifying the namespace from which you want to collect support data. By default, the Support Console gathers support data from the default namespace.

    curl localhost:8000/collect?ns=<namespace> -O -J
    
  3. Optional. If you no longer require access to the Support Console, run the following command to remove the support-console Pod from your cluster:

    helm uninstall support-console