From 13e2facf2a4f1d4e95ed9dae5d5a18e6f1dd4e3d Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Mon, 31 Aug 2020 12:07:07 -0400 Subject: [PATCH 1/5] updated nb config to include proxyprotocol --- openapi.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index 61390d6bc..b7d7e26ef 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -9437,6 +9437,7 @@ paths: "check_path": "/test", "check_body": "it works", "check_passive": true, + "proxy_protocol": "v1", "cipher_suite": "recommended" }' \ https://api.linode.com/v4/nodebalancers/12345/configs @@ -9454,6 +9455,7 @@ paths: --check_path "/test" \ --check_body "it works" \ --check_passive true \ + --proxy_protocol "v1" \ --cipher_suite recommended /nodebalancers/{nodeBalancerId}/configs/{configId}: parameters: @@ -9548,6 +9550,7 @@ paths: "check_path": "/test", "check_body": "it works", "check_passive": true, + "proxy_protocol": "v1", "cipher_suite": "recommended" }' \ https://api.linode.com/v4/nodebalancers/12345/configs/4567 @@ -9566,6 +9569,7 @@ paths: --check_path "/test" \ --check_body "it works" \ --check_passive true \ + --proxy_protocol "v1" \ --cipher_suite recommended delete: x-linode-grant: read_write @@ -9697,6 +9701,7 @@ paths: "check_path": "/test", "check_body": "it works", "check_passive": true, + "proxy_protocol": "v1", "cipher_suite": "recommended", "nodes": [ { @@ -9730,6 +9735,7 @@ paths: --check_path "/test" \ --check_body "it works" \ --check_passive true \ + --proxy_protocol "v1" \ --cipher_suite recommended /nodebalancers/{nodeBalancerId}/configs/{configId}/nodes: parameters: @@ -17139,6 +17145,13 @@ components: enough for it to be considered unhealthy and taken out of rotation. example: true x-linode-cli-display: 6 + proxy_protocol: + type: string + enum: + - v1 + - v2 + nullable: true + example: v1 cipher_suite: type: string enum: From 996dd5f76848f687403df19e85eaf67c9875f781 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 1 Sep 2020 11:58:22 -0400 Subject: [PATCH 2/5] updated enum --- openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index b7d7e26ef..8f08f3f02 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -17150,7 +17150,7 @@ components: enum: - v1 - v2 - nullable: true + - none example: v1 cipher_suite: type: string From d35b34279cdf11fbdf40ca3617362abe1fe255e9 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 1 Sep 2020 12:44:26 -0400 Subject: [PATCH 3/5] update description --- openapi.yaml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/openapi.yaml b/openapi.yaml index 8f08f3f02..4aa2af38c 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -17146,12 +17146,24 @@ components: example: true x-linode-cli-display: 6 proxy_protocol: + description: > + ProxyProtocol is an internet protocol that sends information as a header on a + TCP connection without losing client data. When used with a NodeBalancer, it + enables the termination of TCP connections. + + + Linode NodeBalancers supports two versions, `v1` and `v2`. `v1` is human readable + text while `v2` makes use of a binary signature. + + + If ommited from the configuration, the default is `none`. type: string enum: - v1 - v2 - none - example: v1 + example: none + default: none cipher_suite: type: string enum: From b593acb46817e6a91938f3088d5f46eec352b7a1 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 1 Sep 2020 14:41:37 -0400 Subject: [PATCH 4/5] updated description --- openapi.yaml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 4aa2af38c..9cfd058ae 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -17147,21 +17147,21 @@ components: x-linode-cli-display: 6 proxy_protocol: description: > - ProxyProtocol is an internet protocol that sends information as a header on a - TCP connection without losing client data. When used with a NodeBalancer, it - enables the termination of TCP connections. + ProxyProtocol is a TCP extension that sends initial TCP connection + information such as source/destination IPs and ports to backend devices. + This information would be lost otherwise. Backend devices must be + configured to work with ProxyProtocol if enabled. - Linode NodeBalancers supports two versions, `v1` and `v2`. `v1` is human readable - text while `v2` makes use of a binary signature. - - - If ommited from the configuration, the default is `none`. + * If ommited, or set to `none`, the NodeBalancer doesn't send any auxilary + data over TCP connections. This is the default. + * If set to `v1`, the human-readable header format (Version 1), is used. + * If set to `v2`, the binary header format (Version 2), is used. type: string enum: + - none - v1 - v2 - - none example: none default: none cipher_suite: From e572184ecd09870d669115528544a579c9650816 Mon Sep 17 00:00:00 2001 From: hzoppetti Date: Tue, 1 Sep 2020 14:52:26 -0400 Subject: [PATCH 5/5] formatting the list --- openapi.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 9cfd058ae..7a6781c44 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -17155,8 +17155,10 @@ components: * If ommited, or set to `none`, the NodeBalancer doesn't send any auxilary data over TCP connections. This is the default. - * If set to `v1`, the human-readable header format (Version 1), is used. - * If set to `v2`, the binary header format (Version 2), is used. + + * If set to `v1`, the human-readable header format (Version 1) is used. + + * If set to `v2`, the binary header format (Version 2) is used. type: string enum: - none