From 77ef75213d7e8a7031f718983d293174c0a99a7e Mon Sep 17 00:00:00 2001 From: Ric Szopa Date: Sun, 6 Mar 2016 14:13:16 +0100 Subject: [PATCH] Update all documentation to use YAML for the config file. --- doc/loadtest/README.md | 4 ++-- doc/loadtest/docker/server/Dockerfile | 2 +- doc/loadtest/docker/server/config.prototext | 3 --- doc/loadtest/docker/server/config.yml | 25 +++++++++++++++++++++ doc/loadtest/k8s/doorman-server.yaml | 2 +- doc/simplecluster/Procfile | 2 +- doc/simplecluster/README.md | 2 +- doc/simplecluster/config.prototext | 3 --- doc/simplecluster/config.yml | 25 +++++++++++++++++++++ go/configuration/configuration_test.go | 16 ++++++------- 10 files changed, 64 insertions(+), 20 deletions(-) delete mode 100644 doc/loadtest/docker/server/config.prototext create mode 100644 doc/loadtest/docker/server/config.yml delete mode 100644 doc/simplecluster/config.prototext create mode 100644 doc/simplecluster/config.yml diff --git a/doc/loadtest/README.md b/doc/loadtest/README.md index 5acc85b..f0079ca 100644 --- a/doc/loadtest/README.md +++ b/doc/loadtest/README.md @@ -229,7 +229,7 @@ doorman-server-le54r 1/1 Running 0 15s This is running the Doorman server with a command line like this: ```console -doorman -logtostderr -port=3667 -debug_port=3668 -config=./config.prototext +doorman -logtostderr -port=3667 -debug_port=3668 -config=./config.yml ``` Let's take a look at its logs to verify everything is fine: @@ -362,7 +362,7 @@ What happens with the number of requests the server is doing? How about the QPS ### Different Algorithms -Experiment with different capacity distribution algorithms. Edit [`config.protext`](docker/server/config.prototext) to use the [FAIR_SHARE](../algorithms.md#fair_share) algorithm. Does it have any effect on the metrics? +Experiment with different capacity distribution algorithms. Edit [`config.yml`](docker/server/config.yml) to use the [FAIR_SHARE](../algorithms.md#fair_share) algorithm. Does it have any effect on the metrics? ### High Availability diff --git a/doc/loadtest/docker/server/Dockerfile b/doc/loadtest/docker/server/Dockerfile index a5ec00c..bbd7772 100644 --- a/doc/loadtest/docker/server/Dockerfile +++ b/doc/loadtest/docker/server/Dockerfile @@ -1,3 +1,3 @@ FROM golang:1.5 -ADD config.prototext . +ADD config.yml . RUN go get github.com/youtube/doorman/go/cmd/doorman \ No newline at end of file diff --git a/doc/loadtest/docker/server/config.prototext b/doc/loadtest/docker/server/config.prototext deleted file mode 100644 index de0138a..0000000 --- a/doc/loadtest/docker/server/config.prototext +++ /dev/null @@ -1,3 +0,0 @@ -resources: > -resources: > -resources: > diff --git a/doc/loadtest/docker/server/config.yml b/doc/loadtest/docker/server/config.yml new file mode 100644 index 0000000..4b08032 --- /dev/null +++ b/doc/loadtest/docker/server/config.yml @@ -0,0 +1,25 @@ +resources: + - identifier_glob: "proportional" + capacity: 5000 + safe_capacity: 10 + description: "proportional example" + algorithm: + kind: PROPORTIONAL_SHARE + lease_length: 60 + refresh_interval: 15 + - identifier_glob: "fair" + capacity: 5000 + safe_capacity: 10 + description: "fair share example" + algorithm: + kind: FAIR_SHARE + lease_length: 60 + refresh_interval: 15 + - identifier_glob: "*" + capacity: 1000 + safe_capacity: 10 + description: "test" + algorithm: + kind: FAIR_SHARE + lease_length: 60 + refresh_interval: 15 diff --git a/doc/loadtest/k8s/doorman-server.yaml b/doc/loadtest/k8s/doorman-server.yaml index f4fd23d..8a52b8f 100644 --- a/doc/loadtest/k8s/doorman-server.yaml +++ b/doc/loadtest/k8s/doorman-server.yaml @@ -38,7 +38,7 @@ spec: containers: - name: doorman-server image: gcr.io/google.com/doorman/doorman-server:v0.1.7 - command: ["doorman", "-logtostderr", "-port=3667", "-debug_port=3668", "-config=./config.prototext"] + command: ["doorman", "-logtostderr", "-port=3667", "-debug_port=3668", "-config=./config.yml"] resources: limits: cpu: 0.8 diff --git a/doc/simplecluster/Procfile b/doc/simplecluster/Procfile index 3c7dfb6..68eb8f8 100644 --- a/doc/simplecluster/Procfile +++ b/doc/simplecluster/Procfile @@ -1,3 +1,3 @@ etcd: etcd --data-dir /tmp/etcd.data$PORT -doorman: $GOPATH/bin/doorman -logtostderr -config=./config.prototext -port=$PORT -debug_port=$(expr $PORT + 50) -etcd_endpoints=http://localhost:2379 -master_election_lock=/doorman.master -hostname=localhost +doorman: $GOPATH/bin/doorman -logtostderr -config=./config.yml -port=$PORT -debug_port=$(expr $PORT + 50) -etcd_endpoints=http://localhost:2379 -master_election_lock=/doorman.master -hostname=localhost diff --git a/doc/simplecluster/README.md b/doc/simplecluster/README.md index 40cc586..fd4abd3 100644 --- a/doc/simplecluster/README.md +++ b/doc/simplecluster/README.md @@ -35,7 +35,7 @@ go get github.com/youtube/doorman/go/cmd/doorman ## Preparing the configuration -Doorman's configuration file uses the protobuf text format. [config.prototext](config.prototext) sets up 2 resources: +Doorman's configuration file uses the YAML format. [config.yml](config.yml) sets up 2 resources: + `proportional`, which uses the [PROPORTIONAL_SHARE](../algorithms.md#proportional_share) algorithm, with capacity 100. + `fair`, which uses the [FAIR_SHARE](../algorithms.md#fair_share) algorithm, with capacity 400. diff --git a/doc/simplecluster/config.prototext b/doc/simplecluster/config.prototext deleted file mode 100644 index e6841ee..0000000 --- a/doc/simplecluster/config.prototext +++ /dev/null @@ -1,3 +0,0 @@ -resources: > -resources: > -resources: > diff --git a/doc/simplecluster/config.yml b/doc/simplecluster/config.yml new file mode 100644 index 0000000..f3485ac --- /dev/null +++ b/doc/simplecluster/config.yml @@ -0,0 +1,25 @@ +resources: + - identifier_glob: proportional + capacity: 100 + safe_capacity: 10 + description: proportional example + algorithm: + kind: PROPORTIONAL_SHARE + lease_length: 15 + refresh_interval: 5 + - identifier_glob: fair + capacity: 1000 + safe_capacity: 10 + description: fair share example + algorithm: + kind: FAIR_SHARE + lease_length: 15 + refresh_interval: 5 + - identifier_glob: "*" + capacity: 1000 + safe_capacity: 10 + description: default + algorithm: + kind: FAIR_SHARE + lease_length: 60 + refresh_interval: 15 diff --git a/go/configuration/configuration_test.go b/go/configuration/configuration_test.go index 4ceb8a8..2e41446 100644 --- a/go/configuration/configuration_test.go +++ b/go/configuration/configuration_test.go @@ -7,24 +7,24 @@ func TestParseSource(t *testing.T) { text, path, kind string }{ { - text: "config.prototext", + text: "config.yml", kind: "file", - path: "config.prototext", + path: "config.yml", }, { - text: "file:config.prototext", + text: "file:config.yml", kind: "file", - path: "config.prototext", + path: "config.yml", }, { - text: "colons:in:name:good:idea:config.prototext", + text: "colons:in:name:good:idea:config.yml", kind: "file", - path: "colons:in:name:good:idea:config.prototext", + path: "colons:in:name:good:idea:config.yml", }, { - text: "etcd:/config.prototext", + text: "etcd:/config.yml", kind: "etcd", - path: "/config.prototext", + path: "/config.yml", }, } { kind, path := ParseSource(c.text)