README

# DC/OS CLI Tunnel Subcommand

A DC/OS CLI subcommand that provides SOCKS proxy, HTTP proxy, and VPN access
to your DC/OS cluster.

This is **NOT** meant as a standalone but as an _installable subcommand_ through
the _DC/OS Universe_.

## Development Setup
Clone the git repo:
```
git clone git@github.com:dcos/dcos-tunnel.git
```

Change directory to the repo directory:

```
cd dcos-tunnel
```

Make sure that you have python `virtualenv` installed.

Create a virtualenv for the project:

```
make env
```

Try it out with:

```
./env/bin/dcos-tunnel
```

The VPN container lives at [https://github.com/dcos/dcos-cli-vpn](https://github.com/dcos/dcos-cli-vpn)

### Binary

```
make binary
```

Run it with:

```
./dist/dcos-tunnel
```


### Running Tests

Syntax check:

```
make test
```

Syntax check + Integration test:

```
sudo make test-binary
```

Single Integration test:

```
sudo make test-binary-debug test=<test_name>
```