Skip to content

Commit d847cfc

Browse files
authored
Adds clusters settings to reference file (#1331)
adds clusters settings to reference file
1 parent 48c92ef commit d847cfc

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

content/docs/reference/reference.json

+26-6
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@
454454
"id": "dns-lookup-family",
455455
"title": "DNS Lookup Family",
456456
"path": "/dns-lookup-family",
457-
"description": "The DNS IP address resolution policy.",
457+
"description": "Sets the DNS IP address resolution policy.",
458458
"services": [],
459459
"type": "string"
460460
},
@@ -666,7 +666,7 @@
666666
"id": "set-response-headers",
667667
"title": "Set Response Headers",
668668
"path": "/set-response-headers",
669-
"description": "Sets static HTTP Response Header values for all managed routes",
669+
"description": "Sets static HTTP Response Header values for all managed routes.",
670670
"services": [],
671671
"type": "map of strings key value pairs"
672672
},
@@ -682,7 +682,7 @@
682682
"id": "jwt-claim-headers",
683683
"title": "JWT Claim Headers",
684684
"path": "/jwt-claim-headers",
685-
"description": "The JWT Claim Headers setting allows you to pass specific user session data to upstream applications as HTTP request headers and additional JWT claims.",
685+
"description": "Passes user session data to upstream applications as HTTP Request Headers and additional JWT claims.",
686686
"services": [],
687687
"type": "slice of string"
688688
},
@@ -705,7 +705,7 @@
705705
"id": "x-forwarded-for-http-header",
706706
"title": "X-Forwarded-For HTTP Header",
707707
"path": "/x-forwarded-for-http-header",
708-
"description": "Do not append proxy IP address to x-forwarded-for (https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_conn_man/headers.html?highlight=skip_xff_append#x-forwarded-for).",
708+
"description": "Indicates which IP addresses a request has flowed through between the client and upstream service.",
709709
"services": [],
710710
"type": "bool"
711711
},
@@ -741,7 +741,7 @@
741741
"data-broker-storage-connection-string": {
742742
"id": "data-broker-storage-connection-string",
743743
"title": "Databroker Storage Connection String",
744-
"description": "Sets Postgres connection string to connect Databroker service to storage backend",
744+
"description": "Sets the database connection string to connect Databroker service to storage backend.",
745745
"path": "/databroker#databroker-storage-connection-string",
746746
"services": [],
747747
"type": "string"
@@ -1042,7 +1042,7 @@
10421042
"pass-identity-headers": {
10431043
"id": "pass-identity-headers",
10441044
"title": "Pass Identity Headers",
1045-
"description": "The global Pass Identity Headers setting passes identity headers to all upstream applications.",
1045+
"description": "If applied, passes X-Pomerium-Jwt-Assertion header and JWT Claims Headers to all upstream applications.",
10461046
"short_description": "Pass identity headers to all upstream applications",
10471047
"path": "/pass-identity-headers",
10481048
"services": ["proxy"],
@@ -1480,5 +1480,25 @@
14801480
"path": "/routes/direct-response",
14811481
"description": "Instructs Pomerium to send a static HTTP response to the downstream client for a managed route.",
14821482
"services": ["proxy"]
1483+
},
1484+
"cluster-settings-name": {
1485+
"id": "cluster-settings-name",
1486+
"title": "Cluster Name",
1487+
"description": "A customizable name that identifies a cluster. Defaults to the cluster's randomly generated starter domain name."
1488+
},
1489+
"detected-ip-address": {
1490+
"id": "detected-ip-address",
1491+
"title": "Detected IP Address",
1492+
"description": "The IP address detected for this cluster server."
1493+
},
1494+
"override-ip-address": {
1495+
"id": "override-ip-address",
1496+
"title": "Override IP Address",
1497+
"description": "Manually sets the IP address of this cluster and overrides the detected IP. Use this setting if Pomerium can't connect to cluster over detected IP."
1498+
},
1499+
"cluster-identity": {
1500+
"id": "cluster-identity",
1501+
"title": "Cluster Identity",
1502+
"description": "The cluster token that associates this cluster with a personal account or organization."
14831503
}
14841504
}

0 commit comments

Comments
 (0)