GDCC Site Discovery Tool

This tool is to do a pre-installation network validation for Google Distributed Cloud - Connected (GDCC) It needs to be run on customer's network, to verify the network connectivity to Google services required by GDCC.

• DNS
• NTP
• Switch Management connections
• Google Cloud API endpoints
• VPN Connections

Getting started

This tool can be compiled to a single standalone executable file on Windows or Linux platform. However, if for any security reason the executable file cannot run, user could also install a python virtual environment, and run it as a python script.

Prepare the workspace

clone the code repository

git clone https://gitlab.com/danielxia/site-discovery.git
cd siteDiscovery

create a virtual environment

Assuming python3 is already installed. Now create a python virtual environment under the project directory. If using Pycharm, the IDE probably already did this step. Please skip this step if virtual environment is already created.

• Linux System: create a virtual environment in local .venv folder

python3 -m venv .venv

• Windows System: create a virtual environment in local venv folder

python3 -m venv venv

Build a standalone executables

• Linux System

build.sh

• Windows System

build.bat

binary executable is generated in dist folder

Run as python script

activate virtual environment

• Linux System

source .venv/bin/activate

• Windows System

venv/Scripts/activate.bat

install required python package and run the script

python3 -m pip install -r requirements.txt
python3 main.py

Command line options

# get help info
python3 main.py --help
# use custom playbook
python3 main.py --file your_playbook.yaml

Playbook exmaple is here

Example outputs

The script will generate two text files

• report file - connection validation for each endpoints in the playbook file
• log file - more detailed record of the test steps, e.g. the command sent to endpoints, and the response received back from the endpoints

(.venv) danielxia@danielxia-1:~/PycharmProjects/siteDiscovery/release/alpha$ ./siteDiscovery 
System shell path is /usr/bin/bash
[INFO]log file /usr/local/google/home/danielxia/PycharmProjects/siteDiscovery/release/alpha/site-discovery.log
[INFO]report file /usr/local/google/home/danielxia/PycharmProjects/siteDiscovery/release/alpha/site-discovery-report_20241020-195123.txt
Loading Playbook /tmp/_MEIJ7ql9w/playbook.yaml ...OK
Loading DNS mapping file /tmp/_MEIJ7ql9w/dns_map.csv ...OK
Loading IP Address range (IPRR) file /tmp/_MEIJ7ql9w/iprr.csv ...OK
Getting local network config ... NOK
Verify default gateway ... NOK
Verifying DNS Servers ... OK
Verifying NTP Servers ... OK
Verifying TCP connections ... 29/29
Verifying SSL connections ... 29/29
Verifying QBONE connections ... 40/40
Write report to /usr/local/google/home/danielxia/PycharmProjects/siteDiscovery/release/alpha/site-discovery-report_20241020-195123.txt ... Done

Disclaimer

This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.