-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Docs] Document how to build and deploy tunnelbroker
Summary: After testing the deployment, document how it was able to be built and ran. Part of https://linear.app/comm/issue/ENG-4104 Test Plan: N/A. Documentation Reviewers: varun, ashoat, bartek Reviewed By: ashoat, bartek Subscribers: tomek Differential Revision: https://phab.comm.dev/D8312
- Loading branch information
1 parent
84958a8
commit 64b6154
Showing
3 changed files
with
34 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Services Deployment | ||
|
||
## Tunnelbroker | ||
|
||
Deploying Tunnelbroker consists of building its Docker image and deploying that image as a Docker container. | ||
|
||
### Building Tunnelbroker Image | ||
|
||
The Docker image for Tunnelbroker can be built using the following command from the project root: | ||
|
||
``` | ||
docker build -f services/tunnelbroker -t commapp/tunnelbroker:<tag> . | ||
# Alternatively, there's a script which creates a very small docker context before building | ||
services/tunnelbroker/make_docker_image.sh -t commapp/tunnelbroker:<tag> . | ||
``` | ||
|
||
### Running the container | ||
|
||
Tunnelbroker can be run in production using the following command: | ||
|
||
``` | ||
docker run -d commapp/tunnelbroker:<tag> \ | ||
-p 50051:50051 \ | ||
-p 80:51001 \ | ||
-v $HOME/.aws:/home/comm/.aws:ro \ | ||
tunnelbroker \ | ||
--amqp-uri=<amqp-uri> \ | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters