Merge pull request #14 from uber/config

Cosmetic changes to readme, config and some files

README.md

@@ -6,7 +6,6 @@ This repo contains the source code of Cherami server, cross-zone replicator serv
 
 Getting started
 ---------------
-
 To get cherami-server:
 
 ```
@@ -15,29 +14,37 @@ git clone git@github.com:uber/cherami-server.git $GOPATH/src/github.com/uber/che
 
 Build
 -----
-We use [`glide`](https://glide.sh) to manage Go dependencies. Additionally, we need a Cassandra running locally in order to run the integration tests. Please make sure `glide` and `cqlsh` are in your PATH, and `cqlsh` can connect to the local Cassandra server.
+We use [`glide`](https://glide.sh) to manage Go dependencies. Please make sure `glide` is in your PATH before you attempt to build.
 
-* Build the `cherami-server` and other binaries:
+* Build the `cherami-server` and other binaries (will not run test):
 ```
 make bins
 ```
 
+Local Test
+----------
+We need a Cassandra running locally in order to run the integration tests. Please make sure `cqlsh` is in `/usr/local/bin`, and it can connect to the local Cassandra server.
+```
+make test
+```
+
 Run Cherami locally
 -------------------
-
 * Setup the cherami keyspace for metadata:
 ```
 ./scripts/cherami-setup-schema
 ```
 
 * The service can be started as follows:
 ```
-CHERAMI_ENVIRONMENT=laptop CHERAMI_CONFIG_DIR=`pwd`/config CHERAMI_STORE=/tmp/store ./cherami-server start all
+CHERAMI_ENVIRONMENT=local ./cherami-server start all
 ```
 
+Note: `cherami-server` is configured via `config/base.yaml` with some parameters overriden by `config/local.yaml`.
+
 One can use the CLI to verify if Cherami is running properly:
 ```
-./cherami-cli --hostport=<localIP>:4922 create destination /test/cherami
+./cherami-cli --env=prod --hostport=<localIP>:4922 create destination /test/cherami
 ```
 
 Deploy Cherami as a cluster

clients/metadata/util.go

@@ -144,7 +144,7 @@ func (s *TestCluster) SetupTestCluster() {
 	ip := `127.0.0.1`
 	s.createCluster(ip, gocql.Consistency(1), generateRandomKeyspace(10))
 	s.createKeyspace(1)
-	s.loadSchema("schema/metadata_test.cql")
+	s.loadSchema("schema/metadata.cql")
 
 	var err error
 	s.client, err = NewCassandraMetadataService(&configure.MetadataConfig{

common/util.go

@@ -57,7 +57,6 @@ var ringpopBootstrapFile string
 const hyperbahnPort int16 = 21300
 const rpAppNamePrefix string = "cherami"
 const maxRpJoinTimeout = 30 * time.Second
-const defaultNumReplicas = 3
 const maxRateExtrapolationTime = 120.0
 
 // MaxDuration is maximum time duration

config/base.yaml

@@ -17,13 +17,14 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
+
+# DefaultServiceConfig stores the default service config for each service
 DefaultServiceConfig:
-  HostUUID: ""
   HyperbahnBootstrapFile: ""
   RingHosts: ""
-  EnableLimits: true # by default we have limits enabled
-  ListenAddress: ""
+  EnableLimits: true
 
+# ServiceConfig overrides default config with service-specific config such as ports
 ServiceConfig:
   cherami-inputhost:
     Port: 4240
@@ -72,21 +73,30 @@ ServiceConfig:
       logLevel: warn
       disableLogging: true
 
+# MetadataConfig specifies location of the Cassandra and ketspace
 MetadataConfig:
   CassandraHosts: ""
   Keyspace: "cherami"
   Consistency: "one"
   ClusterName: "base"
 
+# ReplicatorConfig specifies 
 ReplicatorConfig:
   DefaultAuthoritativeZone: "zone1"
   ReplicatorHosts:
     zone1: 192.168.0.1
     zone2: 192.168.0.2
 
+# Logging configuration
 logging:
   level: error
   stdout: false
 
+# DefaultDestinationConfig right now configures how many replicas you want
 DefaultDestinationConfig:
   Replicas: 3
+
+# StorageConfig specfies location of the message storage, and the UUID of the storage host. The UUID should be different in each host.
+# StorageConfig:
+#   BaseDir: ""
+#   HostUUID: ""

config/laptop.yaml → config/local.yaml

@@ -17,5 +17,17 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
+
 DefaultDestinationConfig:
   Replicas: 1
+
+MetadataConfig:
+  CassandraHosts: "127.0.0.1"
+
+StorageConfig:
+  BaseDir: /tmp/cherami-store
+  HostUUID: "11111111-1111-1111-1111-111111111111"
+
+logging:
+  level: debug
+  stdout: true

scripts/cherami-setup-schema

@@ -11,5 +11,5 @@ keyspace="cherami"
 CHERAMI_CQLSH_DIR="/usr/local/bin"
 CHERAMI_SCHEMA_DIR="clients/metadata/schema"
 
-$CHERAMI_CQLSH_DIR/cqlsh -f $CHERAMI_SCHEMA_DIR/metadata_keyspace_test.cql
-$CHERAMI_CQLSH_DIR/cqlsh -k $keyspace -f $CHERAMI_SCHEMA_DIR/metadata_test.cql
+$CHERAMI_CQLSH_DIR/cqlsh -f $CHERAMI_SCHEMA_DIR/metadata_keyspace.cql
+$CHERAMI_CQLSH_DIR/cqlsh -k $keyspace -f $CHERAMI_SCHEMA_DIR/metadata.cql

test/integration/base.go

@@ -173,7 +173,7 @@ func (tb *testBase) setupSuiteImpl(t *testing.T) {
 	err = metadata.CreateKeyspace(tb.mClient.GetSession(), tb.keyspace, 1, true)
 	tb.NoError(err)
 
-	err = metadata.LoadSchema("/usr/local/bin/cqlsh", "../../clients/metadata/schema/metadata_test.cql", tb.keyspace)
+	err = metadata.LoadSchema("/usr/local/bin/cqlsh", "../../clients/metadata/schema/metadata.cql", tb.keyspace)
 	tb.NoError(err)
 
 	// Adjust the controller and storehost scan intervals