Update proto.duration to the correct json encoding (#23)

Also uses ` ```yaml ` header so that markdown renders yaml correctly.
This commit is contained in:
mandarjog 2017-04-16 07:15:21 -07:00 committed by Martin Taillefer
parent 04e138b817
commit f90e26dfce
1 changed files with 10 additions and 12 deletions

View File

@ -67,15 +67,14 @@ to know the IP address and port where it's log data should be pumped.
Here's an example showing how to configure an adapter: Here's an example showing how to configure an adapter:
``` ```yaml
adapters: adapters:
- name: myListChecker # user-defined name for this block of config - name: myListChecker # user-defined name for this block of config
kind: lists # kind of aspect this adapter can be used with kind: lists # kind of aspect this adapter can be used with
impl: ipListChecker # name of the particular adapter component to use impl: ipListChecker # name of the particular adapter component to use
params: params:
publisher_url: https://mylistserver:912 publisher_url: https://mylistserver:912
refresh_interval: refresh_interval: 60s
seconds: 60
``` ```
The `name` field gives a name to the chunk of adapter configuration so it can be referenced from elsewhere. The The `name` field gives a name to the chunk of adapter configuration so it can be referenced from elsewhere. The
@ -89,19 +88,18 @@ to be used multiple times within a single deployment. Depending on the situation
block of configuration will be used versus another. For example, here's another block of configuration that can coexist block of configuration will be used versus another. For example, here's another block of configuration that can coexist
with the previous one: with the previous one:
``` ```yaml
adapters: adapters:
- name: mySecondaryListChecker - name: mySecondaryListChecker
kind: lists kind: lists
impl: ipListChecker impl: ipListChecker
params: params:
publisherUrl: https://mySecondarylistserver:912 publisherUrl: https://mySecondarylistserver:912
refreshInterval: refreshInterval: 5s
seconds: 5
``` ```
Here's another example adapter block: Here's another example adapter block:
``` ```yaml
adapters: adapters:
- name: myMetricsCollector - name: myMetricsCollector
kind: metrics kind: metrics
@ -133,7 +131,7 @@ instances of the metric.
Here's an example metric descriptor: Here's an example metric descriptor:
``` ```yaml
metrics: metrics:
- name: request_count - name: request_count
kind: COUNTER kind: COUNTER
@ -174,7 +172,7 @@ and inserted into a deployment's configuration.
Here's part of the manifest for the Istio proxy: Here's part of the manifest for the Istio proxy:
``` ```yaml
manifests: manifests:
- name: istio-proxy - name: istio-proxy
revision: "1" revision: "1"
@ -210,7 +208,7 @@ on *how* to do something, aspects focus on *what* to do.
Let's look at the definition of an aspect: Let's look at the definition of an aspect:
``` ```yaml
aspects: aspects:
- kind: lists # the aspect's kind - kind: lists # the aspect's kind
adapter: myListChecker # the adapter to use to implement this aspect adapter: myListChecker # the adapter to use to implement this aspect
@ -250,7 +248,7 @@ attribute that carries the symbol to check against the associated adapter's list
Here's another metric aspect: Here's another metric aspect:
``` ```yaml
- kind: metrics - kind: metrics
adapter: myMetricsCollector adapter: myMetricsCollector
params: params:
@ -283,7 +281,7 @@ and produce values to compose policy objects.
We've already seen a few simple attribute expressions in the samples above: We've already seen a few simple attribute expressions in the samples above:
``` ```yaml
source: source.name source: source.name
target: target.name target: target.name
service: api.name service: api.name