Azure Disk Inspect Service

The Azure Disk Inspect Service is intended to be a service that allows customers, support or third party personnel with privileged access to access an Azure OS Disk for log and configuration files without provisioning a VM and attaching a copy of the disk in order to probe the contents. It is a fast and secure way to retrieve well known contents of an OS disk by the user to aid in system failure diagnosis.

Building (Local):

To build the docker container, ensure you have installed docker.io

apt-get install docker.io

From the azure-diskinspect-service folder that was created after cloning, run the following script to build the docker container.

./build.sh

Building (Remote ACS):

You can also choose to directly build on an Azure Container Service by setting up Docker Port Forwarding. To do this you will need to copy the ssh private key for the Azure Container Service you created by adding the private key into:

~./id_rsa 

Ensure the id_rsa has sufficient permissions

chmod 400 ~./id_rsa

Next, setup port forwarding,

nohup ssh -L 2375:localhost:2375 -N [email protected] -p 2200 &

This will expose the port 2375 on your localhost to map to 2375 on the docker swarm. You can specify any port on the localhost that you desire if you intend to use multiple service mappings.

Export the port forwarding rule for your local Docker instance to be communicate with the remote master.

export DOCKER_HOST=:2375

To check if things went well, run:

docker ps

to ensure that you are now connected to the remote docker swarm.

Follow the local build steps as documented before, but note that the docker container is now built on the remote machine.

Deploying:

First ensure the SSL certificates for the NGINX server are available and placed at:

~/azdis_ssl/

Assuming you have built the docker container, you can deploy it by running from your source folder:

./scripts/run.sh

this sets up a server named "AzureDiskInspectService_US" by default.

Run:

docker ps

to verify the service is up and running.

Manual Testing:

Issue a curl query while logged into the docker container:

docker exec -it AzureDiskInspectSvc_US bash
<Docker Container> curl -k "https://127.0.0.1:8080/<OPERATION_ID>/<MODE>/<STORAGE BLOB NAME>/<CONTAINER BLOB NAME>" --data-urlencode "saskey=<SAS QUERY PARAMETERS>"

Automated Testing

A set of automated tests can be run by executing the following logged into a VM which runs the container or within the container itself

./tests/inspection_tests.py ~ "https://127.0.0.1:8080"

Automated testing is also through travis-ci. Additional information on automated testing found here.

Logs:

To look at real-time logs generated by the service, execute:

./scripts/checklog.sh

To copy the logs over for examination on the host:

./scripts/getlogs.sh

How To Contribute

**Make sure you are a member of this permission group: https://repos.opensource.microsoft.com/Azure/teams/diskinspection-extended

1.	Clone github repo locally
	 $ git clone https://github.com/Azure/azure-diskinspect-service <local_path>

2.	Create a new branch from master
	 $ cd <local_path>
	 $ git checkout -b <new_branch>

4.	Apply your changes in the branch

	-If you are updating/creating new manifest then: Make sure to run "parse_manifest.py"
	 $ python ./parse_manifest.py

5.	Push changes to your remote branch by following below sequesnce of commands
	$ git add <file_changed>
	$ git commit -m "<Commit_message>"
	$ git push --set-upstream origin <new_branch> 

6.	Raise PR to merge into master for review

---

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.