Set up the IO tools to access runbooks

This page describes how to set up and configure the IO tool service. This service sets up a local web page to access service manuals that include runbooks, alerts, and error message descriptions which are useful for troubleshooting the deployment. Google support might ask you to follow one of these runbooks when troubleshooting. The service also includes tools and scripts mentioned in the runbooks. You can use this method to set up IO tools outside the appliance on any of your devices which has docker installed.

Download the GDC tar

  1. Verify your service account's access to the private-cloud-release bucket.

  2. On your laptop or workstation, authenticate with gcloud and follow the instructions:

     gcloud auth login
    
  3. Download the GDC tar to the laptop or workstation. If the following command fails, run Step 2 and try the current step again.

    gsutil cp gs://private-cloud-release-partner/${GDCH_VERSION}/prod_te_gdch.tar.gz ~/
    

Configure the IO tool

  1. Create a directory on the device and transfer the prod_te_gdch.tar.gz from the DTO machine to the that directory. Refer to this directory as $GDCH_ROOT in the following steps.

  2. Extract the downloaded tar to $GDCH_ROOT:

    tar -I pigz -xvf gdch.tar.gz -C $GDCH_ROOT
    
  3. Navigate to the $GDCH_ROOT/release/ directory and use this command to extract the IO tool: docker image.

    gdcloud artifacts extract oci/ $GDCH_ROOT/io_tool/ --image-name gpc-system-container-images/private-cloud-devel/operation-tools:latest --docker-executable
    
  4. Use docker commands to load and then run the image:

    docker load $GDCH_ROOT/io_tool/gpc-system-container-images/private-cloud-devel/operation-tools.tar
    docker run -v ~/log:/var/log --net=host -it gpc-system-container-images/private-cloud-devel/operation-tools
    
  5. Wait for the document to load and then use http://127.0.0.1:7001 to access documents.