README
¶
Example Go (golang) web app with dependency injection and graceful shutdown. Acts like a mini Twitter clone.
Dependencies
Building requires Go, Godep, Docker, & Make.
Code dependencies are vendored with Godep:
- Facebook's Grace library - graceful shutdown
- Inject - dependency injection
- Humanize - readable units
- Logrus - structured, leveled logging
Compilation
Build a local binary:
make
Build a docker image:
# make the build image first
make build-image
make image
Operation
There are several ways to launch the Tweeter server.
Source
Run from local source code:
go run main.go
(ctrl-c to quit)
Docker
Run in Docker:
docker run -d --name tweeter -p 0.0.0.0:8080:8080 mesosphere/tweeter-go:latest
With Cassandra:
docker run -d --name cassandra cassandra:2.2.3
docker run -d --name tweeter --link cassandra:cassandra -p 0.0.0.0:8080:8080 mesosphere/tweeter-go:latest --cassandra-addr=cassandra
Find Tweeter IP:
docker inspect --format "{{.NetworkSettings.IPAddress}}" tweeter
Marathon
Run in Marathon:
curl -H 'Content-Type: application/json' -X POST -d @"marathon.json" ${MARATHON_URL}/v2/apps
Kubernetes
Run in Kubernetes:
kubectl create -f kubernetes.yaml
By default, kubernetes.yaml assumes you have 3 public slave nodes and want 1 Tweeter instance on each. With this configuration, Tweeter can be reached on the default HTTP port (80) through the public slave DNS URL. On AWS, the DNS should automatically handle round-robin for requests to Tweeter. Load Balancing could also be configured, using AWS Elastic Load Balancing.
Usage
Visit the home page at http://localhost:8080/
Enter handle & message & hit Tweet.
See past tweets on the right-hand side of the home page.
License
Copyright 2015-2017 Mesosphere, Inc.
Licensed under the Apache License Version 2.0 (the "License"); you may not use this project except in compliance with the License.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/cenkalti/backoff
Package backoff implements backoff algorithms for retrying operations.
|
Package backoff implements backoff algorithms for retrying operations. |
|
_workspace/src/github.com/dustin/go-humanize
Package humanize converts boring ugly numbers to human-friendly strings and back.
|
Package humanize converts boring ugly numbers to human-friendly strings and back. |
|
_workspace/src/github.com/facebookgo/grace/gracehttp
Package gracehttp provides easy to use graceful restart functionality for HTTP server.
|
Package gracehttp provides easy to use graceful restart functionality for HTTP server. |
|
_workspace/src/github.com/facebookgo/grace/gracenet
Package gracenet provides a family of Listen functions that either open a fresh connection or provide an inherited connection from when the process was started.
|
Package gracenet provides a family of Listen functions that either open a fresh connection or provide an inherited connection from when the process was started. |
|
_workspace/src/github.com/facebookgo/httpdown
Package httpdown provides http.ConnState enabled graceful termination of http.Server.
|
Package httpdown provides http.ConnState enabled graceful termination of http.Server. |
|
_workspace/src/github.com/facebookgo/stats
Package stats defines a lightweight interface for collecting statistics.
|
Package stats defines a lightweight interface for collecting statistics. |
|
_workspace/src/github.com/gocql/gocql
Package gocql implements a fast and robust Cassandra driver for the Go programming language.
|
Package gocql implements a fast and robust Cassandra driver for the Go programming language. |
|
_workspace/src/github.com/gocql/gocql/internal/lru
Package lru implements an LRU cache.
|
Package lru implements an LRU cache. |
|
_workspace/src/github.com/golang/snappy
Package snappy implements the snappy block-based compression format.
|
Package snappy implements the snappy block-based compression format. |
|
_workspace/src/github.com/hailocab/go-hostpool
A Go package to intelligently and flexibly pool among multiple hosts from your Go application.
|
A Go package to intelligently and flexibly pool among multiple hosts from your Go application. |
|
_workspace/src/github.com/karlkfi/inject
Package inject provides a dependency injection library that uses constructor functions to define dependency relationships.
|
Package inject provides a dependency injection library that uses constructor functions to define dependency relationships. |
|
_workspace/src/github.com/satori/go.uuid
Package uuid provides implementation of Universally Unique Identifier (UUID).
|
Package uuid provides implementation of Universally Unique Identifier (UUID). |
|
_workspace/src/golang.org/x/net/context
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes.
|
Package context defines the Context type, which carries deadlines, cancelation signals, and other request-scoped values across API boundaries and between processes. |
|
_workspace/src/golang.org/x/net/context/ctxhttp
Package ctxhttp provides helper functions for performing context-aware HTTP requests.
|
Package ctxhttp provides helper functions for performing context-aware HTTP requests. |
|
_workspace/src/gopkg.in/inf.v0
Package inf (type inf.Dec) implements "infinite-precision" decimal arithmetic.
|
Package inf (type inf.Dec) implements "infinite-precision" decimal arithmetic. |