Add UsageReportingEnabled missing configuration details (projectcalic…

…o#245) * Add UsageReportingEnabled missing configuration details
dskatz · Nov 19, 2016 · f3f1f1e · f3f1f1e
1 parent ee458dd
commit f3f1f1e
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/v1.5/usage/configuration/index.md b/v1.5/usage/configuration/index.md
@@ -84,6 +84,7 @@ The full list of parameters which can be set is as follows.
 | PrometheusMetricsEnabled    | "false"           | Set to "true" to enable the experimental Prometheus metrics server in Felix. |
 | PrometheusMetricsPort       | 9091              | TCP port that the Prometheus metrics server should bind to.                  |
 | EtcdDriverPrometheusMetricsPort | 9092              | TCP port that the Prometheus metrics server in the etcd driver process should bind to. |
+| UsageReportingEnabled | "true"              | Reports anonymous Calico version number and cluster size to projectcalico.org.  Logs warnings returned by the usage server. For example, if a significant security vulnerability has been discovered in the version of Calico being used. |
 | FailsafeInboundHostPorts    | 22                | Comma-delimited list of TCP ports that   Felix will allow incoming traffic to     host endpoints on irrespective of the    security policy. This is useful to       avoid accidently cutting off a host      with incorrect configuration. The        default value allows ssh access.        |
 | FailsafeOutboundHostPorts   | 2379,2380,4001,7001 | Comma-delimited list of TCP ports that   Felix will allow outgoing from traffic   from host endpoints to irrespective of   the security policy. This is useful to   avoid accidently cutting off a host      with incorrect configuration. The        default value opens etcd's standard      ports to ensure that Felix does not get  cut off from etcd.                     
 

diff --git a/v1.6/usage/configuration/index.md b/v1.6/usage/configuration/index.md
@@ -84,6 +84,7 @@ The full list of parameters which can be set is as follows.
 | PrometheusMetricsEnabled    | "false"           | Set to "true" to enable the experimental Prometheus metrics server in Felix. |
 | PrometheusMetricsPort       | 9091              | TCP port that the Prometheus metrics server should bind to.                  |
 | EtcdDriverPrometheusMetricsPort | 9092              | TCP port that the Prometheus metrics server in the etcd driver process should bind to. |
+| UsageReportingEnabled | "true"              | Reports anonymous Calico version number and cluster size to projectcalico.org.  Logs warnings returned by the usage server. For example, if a significant security vulnerability has been discovered in the version of Calico being used. |
 | FailsafeInboundHostPorts    | 22                | Comma-delimited list of TCP ports that   Felix will allow incoming traffic to     host endpoints on irrespective of the    security policy. This is useful to       avoid accidently cutting off a host      with incorrect configuration. The        default value allows ssh access.        |
 | FailsafeOutboundHostPorts   | 2379,2380,4001,7001 | Comma-delimited list of TCP ports that   Felix will allow outgoing from traffic   from host endpoints to irrespective of   the security policy. This is useful to   avoid accidently cutting off a host      with incorrect configuration. The        default value opens etcd's standard      ports to ensure that Felix does not get  cut off from etcd.                     
 

diff --git a/v2.0/usage/configuration/index.md b/v2.0/usage/configuration/index.md
@@ -57,6 +57,7 @@ The full list of parameters which can be set is as follows.
 | StartupCleanupDelay                     | 30                                   | Delay, in seconds, before felix does its start-of-day cleanup to remove  orphaned iptables chains and ipsets.  Before the first cleanup, felix     operates in "graceful restart" mode,  during which it preserves any      pre-existing chains and ipsets. In a large deployment you may want to  increase this value to give felix more  time to load the initial snapshot from  etcd before cleaning up. |
 | PrometheusMetricsEnabled                | "false"                              | Set to "true" to enable the experimental Prometheus metrics server in Felix. |
 | PrometheusMetricsPort                   | 9091                                 | Experimental: TCP port that the Prometheus metrics server should bind to.                  |
+| UsageReportingEnabled | "true"              | Reports anonymous Calico version number and cluster size to projectcalico.org.  Logs warnings returned by the usage server. For example, if a significant security vulnerability has been discovered in the version of Calico being used. |
 | FailsafeInboundHostPorts                | 22                                   | Comma-delimited list of TCP ports that   Felix will allow incoming traffic to     host endpoints on irrespective of the    security policy. This is useful to       avoid accidently cutting off a host      with incorrect configuration. The        default value allows ssh access.        |
 | FailsafeOutboundHostPorts               | 2379,2380,4001,7001                  | Comma-delimited list of TCP ports that   Felix will allow outgoing from traffic   from host endpoints to irrespective of   the security policy. This is useful to   avoid accidently cutting off a host      with incorrect configuration. The        default value opens etcd's standard      ports to ensure that Felix does not get  cut off from etcd. |
 | ReportingIntervalSecs                   | 30                                   | Interval at which Felix reports its status into the datastore or 0 to disable.  Must be non-zero in OpenStack deployments. |