@mxenabled/groot

GROOT ( v2 )

Welcome to Groot V2. This is the MXaccess tool for management of our MXaccess instances that live in our Kubernetes clusters.

Table of contents

Installation Commands Skipping DNS Opening in browser Editing Environment Variables Troubleshooting

Installation

Pre-requisites

• You must have node and npm installed on your machine. Version >= 16
• You must have authenticated with the review instance cluster via gcloud / kubernetes

npm i --location=global mx-groot
groot --install

the installation command will make sure you have all of the dependencies required to use groot correctly. Namely python, gcloud, kubectl, brew

once this command has run you should be able to just run groot and see the prompts appear.

If you have already used groot before version 2 you will need to delete your old groot files, and remove the function in your .zshrc or .bashrc

After deleting these you should no longer see the old groot. If you see WELCOME TO THE GROOT CLI you know you are using Groot V2

Commands

With this utility you have the ability to run a few common commands on the rails pods. This includes

• rails console
• bin/sh

Skip DNS

While deploying a review application it takes a few minutes (~20) to have the Fully qualified dns to propagate correctly. (review-....access.mx.com). If you need to bypass this restriction and access the instance before this is available you can by choosing the review cluster, choosing the correct instance, and select skip dns

This will port-forward the pod and allow you to access it directly. Via localhost:8080/admin. This also allows you to access the instances without being on the VPN.

Open in browser

This will just open the review application via it's fully qualified dns and show it in the browser.

Edit environment variables

If you need to update your specific instance to use different environment variables you can choose the edit environment variables option. This will allow you to update the variables and then kubernetes will handle the restart after they have been updated. This will spin up new pods that reflect your new environment.

Troubleshooting

No Active Cluster If you receive the no active cluster error you will need to make sure your gcloud project is set correctly

gcloud config set project portal-sand-70daa1
gcloud container clusters get-credentials portal-sand-demo-west --region=us-west1
gcloud container clusters get-credentials portal-sand-west --region=us-west1

after doing this you should no longer receive the no active cluster error