How To Access the Terraform Enterprise Rails Console – HashiCorp Help Center

Introduction

In certain cases, it may be necessary to access the Rails console, a form of command-line interface, to debug Terraform Enterprise issues or, even more rarely, make changes to data.

Use Case

It may be necessary to access the Rails console in the following situations.

If using SAML and access to the local non-SSO Site Admin user is lost.
If a user has lost access to the owners team of a given organization.

Procedure

The procedure for accessing the Rails console differs if running Terraform Enterprise or Terraform Enterprise Clustering. Both methods are detailed below.

Please be aware of the following caveats before continuing.

Do not access the application console unless directed by HashiCorp Support.
Only run the commands provided.
If any command returns unexpected output, do not proceed further.

Terraform Enterprise

To access the Rails console in Terraform Enterprise, perform the following.

SSH into the Terraform Enterprise instance.

Execute the following command to access the Rails console.

sudo docker exec -it ptfe_atlas /usr/bin/init.sh /app/scripts/wait-for-token -- bash -i -c 'cd /app && ./bin/rails c'

Terraform Enterprise Clustering

To access the Rails console in Terraform Enterprise Clustering, perform the following.

SSH into one of the primary Terraform Enterprise Clustering instances.
Execute the following command to gather the Kubernetes namespace where the Terraform Enterprise pods are running. Take note of the output of this command as it is needed later. The value will be referred to as ${NAMESPACE} from here on.
```
kubectl get namespaces --no-headers | grep '^replicated' | awk '{print $1}'
```
Execute the following command to gather the name of one of the atlas pods. Take note of the output of this command as it is needed later. The value will be referred to as ${POD} from here on.
```
kubectl get pods --namespace ${NAMESPACE} --selector app=atlas --no-headers | head -n 1 | awk '{print $1}'
```