Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmoney/fastly-websocket-poc
POC project demonstrating a fastly vcl service using websockets
https://github.com/jmoney/fastly-websocket-poc
fastly github-site license-management mkdocs
Last synced: about 1 month ago
JSON representation
POC project demonstrating a fastly vcl service using websockets
- Host: GitHub
- URL: https://github.com/jmoney/fastly-websocket-poc
- Owner: jmoney
- License: apache-2.0
- Created: 2023-08-04T15:51:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-01T03:03:06.000Z (about 1 year ago)
- Last Synced: 2024-11-24T20:07:26.698Z (about 2 months ago)
- Topics: fastly, github-site, license-management, mkdocs
- Language: HCL
- Homepage: https://www.jmoney.dev/fastly-websocket-poc
- Size: 1.18 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fastly-websocket-poc
## Deploy
First run the following commands
```bash
brew bundle --file Brewfile
ngrok start --all --config ngrok.yml
```
This will start ngrok and expose `localhost:9001` and `localhost:9002` to the internet. Then you need to update the local variables in `main.tf` to the outputted ngrok urls.
Now in two separate tabs of your terminal run the following commands:
```bash
echo-server --port 9001 --type http
echo-server --port 9002 --type websocket
```
This starts two echo servers on addresses `localhost:9001` and `localhost:9002`. The first is a simple http server that returns the request headers. The second is a websocket server that echos back the message sent to it.
The fastly service is deployed using terraform. The terraform script is `main.tf`. The main decision is which type of fastly service to deploy: vcl or compute. If vcl is chose, then a deliver service managed by vcl will be deployed. If compute is chose, then a compute serivice written in golang is to be deployed. To deploy the service, run the following commands:
```bash
# vcl based service
tfenv use
terraform init
make apply-vcl
```
```bash
# compute based service
tfenv use
terraform init
make apply-compute
```
This does a terraform apply with the state generated locally. This is currently using cloudflare as the DNS provider. Please set the `tld` terraform variable to tld you own and have access too in cloudflare. Cloudflare was used for demo purposes it can be replaced with any DNS provider supported by terraform such as AWS Route53.
### Providers used
* [Cloudflare](https://registry.terraform.io/providers/cloudflare/cloudflare/4.11.0/docs)
* [Fastly](https://registry.terraform.io/providers/fastly/fastly/5.2.2/docs)
## Test
Once deployed you can run the following test to see this in action:
```bash
curl --silent "https://echo.jmoney.dev/http"
websocat "wss://echo.jmoney.dev/websocket"
```
After the first command you'll see an echoed response as well as some logging in the echo-server terminal tab. After the second command, you'll need to type some text and hit enter and then you'll see the an echoed response as well as some logging in the echo-server terminal tab. This shows that the websocket connection is being upgraded and the websocket server is receiving the message.
## Cleanup
When testing is complete do not forget to tear it all down. To do so run the following command:
```bash
# cleanup vcl based service
tfenv use
terraform init
make destroy-vcl
```
```bash
# cleanup compute based service
tfenv use
terraform init
make destroy-compute
```