Skip to content

Commit f568984

Browse files
authored
Adds more cluster settings descriptions (#1332)
adds more cluster settings descriptions
1 parent 028c41a commit f568984

File tree

1 file changed

+32
-10
lines changed

1 file changed

+32
-10
lines changed

content/docs/reference/reference.json

+32-10
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"id": "access-log-fields",
44
"title": "Access Log Fields",
55
"path": "/access-log-fields",
6-
"description": "Use Access Log Fields to display HTTP request logs from the proxy service.",
6+
"description": "Displays HTTP request logs from the Pomerium Proxy service.",
77
"short_description": "",
88
"type": "string",
99
"services": ["proxy"]
@@ -21,7 +21,7 @@
2121
"id": "address",
2222
"title": "Address",
2323
"path": "/address",
24-
"description": "Address specifies the host and port to serve HTTP requests from.",
24+
"description": "Specifies the Host and Port to serve HTTP requests from.",
2525
"short_description": "Specify host and port to serve HTTP requests from",
2626
"type": "string",
2727
"services": ["proxy"]
@@ -129,6 +129,14 @@
129129
"short_description": "Certificate relative file location string",
130130
"services": []
131131
},
132+
"certificate-authority": {
133+
"id": "certificate-authority",
134+
"title": "Certificates Authority",
135+
"path": "/certificates#certificate-authority",
136+
"type": "string",
137+
"description": "Defines a set of root certificate authorities that Pomerium uses when communicating with other TLS-protected services.",
138+
"services": []
139+
},
132140
"downstream-mtls-client-certificate-authority": {
133141
"id": "downstream-mtls-client-certificate-authority",
134142
"title": "Downstream mTLS Certificate Authority",
@@ -279,7 +287,7 @@
279287
"id": "javascript-security",
280288
"title": "Javascript Security",
281289
"path": "/cookies#cookie-http-only",
282-
"description": "If true, prevents javascript in browsers from reading user session cookies.",
290+
"description": "If applied, prevents JavaScript in browsers from reading user session cookies.",
283291
"short_description": "Prevent JavaScript in browsers from reading user session cookies",
284292
"services": [],
285293
"type": "bool"
@@ -373,7 +381,7 @@
373381
"id": "read-timeout",
374382
"title": "Read Timeout",
375383
"path": "/global-timeouts#read-timeout",
376-
"description": "The amount of time for the client to receive the entire request stream.",
384+
"description": "Sets the amount of time for the client to receive the entire request stream.",
377385
"short_description": "Amount of time for client to receive entire request stream.",
378386
"services": [],
379387
"type": ""
@@ -382,7 +390,7 @@
382390
"id": "write-timeout",
383391
"title": "Write Timeout",
384392
"path": "/global-timeouts#write-timeout",
385-
"description": "The max stream duration is the maximum time that a stream’s lifetime will span. An HTTP request/response exchange fully consumes a single stream. Therefore, this value must be greater than read_timeout as it covers both request and response time.",
393+
"description": "Sets max stream duration of an HTTP request/response exchange. Must be greater than read timeout.",
386394
"short_description": "Sets maximum stream duration of an HTTP request/response exchange. Must be greater than read_timeout.",
387395
"services": [],
388396
"type": ""
@@ -391,7 +399,7 @@
391399
"id": "idle-timeout",
392400
"title": "Idle Timeout",
393401
"path": "/global-timeouts#idle-timeout",
394-
"description": "Sets the time at which a downstream or upstream connection will be terminated if there are no active streams.",
402+
"description": "Sets the time at which a downstream or upstream connection will be terminated if no active streams.",
395403
"short_description": "Sets the time to terminate a connection if there are no active streams.",
396404
"services": [],
397405
"type": ""
@@ -438,7 +446,7 @@
438446
"id": "http-redirect-address",
439447
"title": "HTTP Redirect Address",
440448
"path": "/http-redirect-address",
441-
"description": "If set, the HTTP Redirect Address specifies the host and port to redirect http to https traffic on.",
449+
"description": "If set, HTTP Redirect Address specifies the Host and Port to redirect HTTP to HTTPS traffic on.",
442450
"services": [],
443451
"type": "string"
444452
},
@@ -462,7 +470,7 @@
462470
"id": "log-level",
463471
"title": "Log Level",
464472
"path": "/log-level",
465-
"description": "Log level sets the global logging level for pomerium.",
473+
"description": "Sets the global logging level for this cluster.",
466474
"services": [],
467475
"type": "string"
468476
},
@@ -509,7 +517,7 @@
509517
"id": "proxy-log-level",
510518
"title": "Proxy Log Level",
511519
"path": "/proxy-log-level",
512-
"description": "Log level sets the logging level for the Pomerium Proxy service.",
520+
"description": "Sets the logging level for the Pomerium Proxy service.",
513521
"services": [],
514522
"type": "string"
515523
},
@@ -545,6 +553,20 @@
545553
"path": "/tracing",
546554
"services": []
547555
},
556+
"tracing-provider": {
557+
"id": "tracing-provider",
558+
"title": "Tracing Provider",
559+
"description": "The name of the tracing provider. For example, Jaeger or Zipkin. Required.",
560+
"path": "/tracing",
561+
"services": []
562+
},
563+
"tracing-sample-rate": {
564+
"id": "tracing-sample-rate",
565+
"title": "Tracing Sample Rate",
566+
"description": "The percentage of requests to sample in decimal notation. Default is 0.0001, or .01%. Optional.",
567+
"path": "/tracing",
568+
"services": []
569+
},
548570
"use-proxy-protocol": {
549571
"id": "use-proxy-protocol",
550572
"title": "Use Proxy Protocol",
@@ -658,7 +680,7 @@
658680
"id": "default-upstream-timeout",
659681
"title": "Default Upstream Timeout",
660682
"path": "/default-upstream-timeout",
661-
"description": "Default Upstream Timeout is the default timeout applied to a proxied route when no timeout key is specified by the policy.",
683+
"description": "Sets the default timeout applied to a proxied route when no timeout key is specified by the policy.",
662684
"services": [],
663685
"type": ""
664686
},

0 commit comments

Comments
 (0)