cleanup pull request before merge

Author: witoff

examples/deployment/README.md

@@ -10,30 +10,30 @@ Want to deploy/use the Trillian General Transparency project in the cloud?  Here
 Both build and example deployment files are stored within this repo.  For any of the below deployment methods, start here:
 
 ```shell
-git clone git@github.com:google/trillian.git
+git clone https://github.com/google/trillian.git/
 cd trillian
 ```
 
 ## Local Deployments
 
 **Run With Docker Compose**
 
-For simple deployments running in a container is an easy way to get up and running with a local database.  To use Docker to run and interact with Trillian, start here:
+For simple deployments, running in a container is an easy way to get up and running with a local database.  To use Docker to run and interact with Trillian, start here:
 
-Set a random password and bring up the services defined in the provided compose file.  This includes a local mysql database database, a one-shot container to create the schema and the trillian server:
+Set a random password and bring up the services defined in the provided compose file.  This includes a local MySQL database, a one-shot container to create the schema and the trillian server:
 
 ```shell
 # Set a random password
 export DB_PASSWORD="$(openssl rand -hex 16)"
 
 # Bring up services defined in this compose file.  This includes:
-# - local MySQL databse
-# - container to seed the database
+# - local MySQL database
+# - container to initialize the database
 # - the trillian server
 docker-compose -f examples/deployment/docker-compose.yml up
 ```
 
-Verify that your local installation by checking the metrics endpoint:
+Verify that your local installation is working by checking the metrics endpoint:
 
 ```shell
 curl localhost:8091/metrics
@@ -52,13 +52,14 @@ TODO
 With a pair of AWS keys [accessible to Terraform](https://www.terraform.io/docs/providers/aws/), this template deploys a simple Trillian setup in AWS using EC2 and RDS MySQL.
 
 ```shell
+cd examples/deployment/aws/
+
 # Set a random password
 export TF_VAR_DB_PASSWORD="$(openssl rand -hex 16)"
-export TF_VAR_ingress_cidr="0.0.0.0/0"
-# Create Resources
-cd examples/deployment/aws/
+# Substitute this variable with a block you'll be accessing from
+export TF_VAR_WHITELIST_CIDR="0.0.0.0/0"
 
-# Review and Apply Changes
+# Review and Create Resources
 terraform plan
 terraform apply
 ```

examples/deployment/aws/terraform.tf

@@ -1,4 +1,4 @@
-variable "ingress_cidr" {
+variable "WHITELIST_CIDR" {
   description="Your IP block to whitelist access from"
 }
 variable "DB_PASSWORD" { }
@@ -40,7 +40,7 @@ resource "aws_security_group" "trillian_db" {
     from_port   = 3306
     to_port     = 3306
     protocol    = "tcp"
-    cidr_blocks = ["${var.ingress_cidr}"]
+    cidr_blocks = ["${var.WHITELIST_CIDR}"]
   }
 
   ingress {
@@ -89,13 +89,13 @@ resource "aws_security_group" "trillian" {
     from_port   = 8090
     to_port     = 8091
     protocol    = "tcp"
-    cidr_blocks = ["${var.ingress_cidr}"]
+    cidr_blocks = ["${var.WHITELIST_CIDR}"]
   }
   ingress {
     from_port   = 22
     to_port     = 22
     protocol    = "tcp"
-    cidr_blocks = ["${var.ingress_cidr}"]
+    cidr_blocks = ["${var.WHITELIST_CIDR}"]
   }
 
   egress {
@@ -128,15 +128,11 @@ yum install -y git mysql
 curl -o /tmp/go.tar.gz https://storage.googleapis.com/golang/go1.8.3.linux-amd64.tar.gz
 tar -C /usr/local -xzf /tmp/go.tar.gz
 export PATH=$PATH:/usr/local/go/bin
-
 mkdir -p /go
 export GOPATH=/go
 
 # Install Trillian
-mkdir -p /go/src/github.com/google/trillian
-git clone https://github.com/google/trillian.git /go/src/github.com/google/trillian
-cd /go/src/github.com/google/trillian
-go get ./server/trillian_map_server
+go get github.com/google/trillian/server/trillian_log_server
 
 # Setup the DB
 cd /go/src/github.com/google/trillian
@@ -149,8 +145,8 @@ export DB_DATABASE=test
 # Startup the Server
 RPC_PORT=8090
 HTTP_PORT=8091
-/go/bin/trillian_map_server \
-	--mysql_uri="$DB_USER:$DB_PASSWORD@tcp($DB_HOST:3306)/$DB_DATABASE" \
+/go/bin/trillian_log_server \
+	--mysql_uri="${DB_USER}:${DB_PASSWORD}@tcp(${DB_HOST})/${DB_DATABASE}" \
 	--rpc_endpoint="$HOST:$RPC_PORT" \
 	--http_endpoint="$HOST:$HTTP_PORT" \
 	--alsologtostderr

examples/deployment/docker/db_client/Dockerfile

@@ -6,12 +6,12 @@ RUN apt-get update && \
 ADD . /go/src/github.com/google/trillian
 WORKDIR /go/src/github.com/google/trillian
 
-RUN go get -v ./server/trillian_log_server
-
 ENV DB_USER=test \
     DB_PASSWORD=zaphod \
     DB_DATABASE=test
 
+# This is used to wait for new MySQL deployments to become ready e.g.
+#  ./wait-for-it.sh localhost:3306 -- mysql
 RUN ./examples/deployment/scripts/download-wait-for-it.sh
 
 CMD [ 'mysql' ]

scripts/resetdb.sh

@@ -14,9 +14,8 @@ collect_vars() {
   # set unset environment variables to defaults
   [ -z ${DB_USER+x} ] && DB_USER="root"
   [ -z ${DB_NAME+x} ] && DB_NAME="test"
-  # format reused supplied environment variables
+  # set defaults
   FLAGS=""
-  [ -z ${DB_PASSWORD+x} ] || FLAGS="${FLAGS} -p$DB_PASSWORD"
 
   # handle flags
   FORCE=false
@@ -29,6 +28,12 @@ collect_vars() {
     esac
     shift 1
   done
+
+  # Optionally print flags (before appending password)
+  [[ ${VERBOSE} = 'true' ]] && echo "- Using MySQL Flags: ${FLAGS}"
+
+  # append password if supplied
+  [ -z ${DB_PASSWORD+x} ] || FLAGS="${FLAGS} -p'${DB_PASSWORD}'"
 }
 
 main() {
@@ -48,10 +53,10 @@ main() {
   if [ -z ${REPLY+x} ] || [[ $REPLY =~ ^[Yy]$ ]]
   then
       echo "Resetting DB..."
-      mysql -u $DB_USER $FLAGS -e "DROP DATABASE IF EXISTS ${DB_NAME};"
-      mysql -u $DB_USER $FLAGS -e "CREATE DATABASE ${DB_NAME};"
-      mysql -u $DB_USER $FLAGS -e "GRANT ALL ON ${DB_NAME}.* TO '${DB_NAME}'@'localhost' IDENTIFIED BY 'zaphod';"
-      mysql -u $DB_USER $FLAGS -D ${DB_NAME} < ${TRILLIAN_PATH}/storage/mysql/storage.sql
+      mysql -u $FLAGS $DB_USER -e "DROP DATABASE IF EXISTS ${DB_NAME};"
+      mysql -u $FLAGS $DB_USER -e "CREATE DATABASE ${DB_NAME};"
+      mysql -u $FLAGS $DB_USER -e "GRANT ALL ON ${DB_NAME}.* TO '${DB_NAME}'@'localhost' IDENTIFIED BY 'zaphod';"
+      mysql -u $FLAGS $DB_USER -D ${DB_NAME} < ${TRILLIAN_PATH}/storage/mysql/storage.sql
       echo "Reset Complete"
   fi
 }