netbird/plugins
0
0
Fork 0
mirror of https://github.com/netbirdio/plugins.git synced 2026-05-22 18:44:07 -07:00
Code Issues Packages Projects Releases Wiki Activity

net/haproxy: improve wording & style, refs #330

Browse Source
This commit is contained in:
Frank Wall
2017-10-24 00:57:32 +02:00
parent 7b72d448fd
commit 9329177fbb
8 changed files with 36 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
net/haproxy/src/opnsense/mvc/app/controllers/OPNsense/HAProxy/forms/dialogAcl.xml
+1 -1
View File
@@ -268,6 +268,6 @@
<id>acl.custom_acl</id>
<label>Option pass-through</label>
<type>textbox</type>
<help><![CDATA[Specify a HAProxy condition/ACL that is currently not supported by the GUI.<br/><div class="text-info"><b>NOTE:</b> This is strongly discouraged! The syntax will not be checked, use at your own risk!</div>]]></help>
<help><![CDATA[Specify a HAProxy condition/ACL that is currently not supported by the GUI.]]></help>
</field>
</form>
net/haproxy/src/opnsense/mvc/app/controllers/OPNsense/HAProxy/forms/dialogAction.xml
+12 -12
View File
@@ -26,13 +26,13 @@
<label>Select conditions</label>
<type>select_multiple</type>
<style>tokenize</style>
<help><![CDATA[Select one ore more conditions to be used for this action.]]></help>
<help><![CDATA[Select one or more conditions to be used for this rule.]]></help>
</field>
<field>
<id>action.operator</id>
<label>Logical operator for conditions</label>
<type>dropdown</type>
<help><![CDATA[Choose an logical operator.]]></help>
<help><![CDATA[Choose a logical operator.]]></help>
</field>
<field>
<label>HAProxy function</label>
@@ -40,9 +40,9 @@
</field>
<field>
<id>action.type</id>
<label>Run function</label>
<label>Execute function</label>
<type>dropdown</type>
<help><![CDATA[Choose an HAProxy function that should be executed if the condition evaluates to true.]]></help>
<help><![CDATA[Choose a HAProxy function that should be executed if the condition evaluates to true.]]></help>
</field>
<field>
<label>Parameters</label>
@@ -86,7 +86,7 @@
<id>action.http-request_redirect</id>
<label>HTTP Redirect</label>
<type>text</type>
<help><![CDATA[Use HAProxy's powerful redirect function to return a HTTP redirection. See <a href="http://cbonte.github.io/haproxy-dconv/1.7/configuration.html#redirect">HAProxy's documentation</a> for further details and examples.]]></help>
<help><![CDATA[Use HAProxy's redirect function to return a HTTP redirection. See <a href="http://cbonte.github.io/haproxy-dconv/1.7/configuration.html#redirect">HAProxy's documentation</a> for further details and examples.]]></help>
</field>
<field>
<label>Parameters</label>
@@ -97,7 +97,7 @@
<id>action.http-request_lua</id>
<label>Lua function</label>
<type>text</type>
<help><![CDATA[Run the specified Lua function. You will most likely need to include/load your Lua code first.]]></help>
<help><![CDATA[Execute the specified Lua function. You will most likely need to include/load your Lua code first.]]></help>
</field>
<field>
<label>Parameters</label>
@@ -125,7 +125,7 @@
<id>action.http-request_add-header_content</id>
<label>Header Content</label>
<type>text</type>
<help><![CDATA[The value that should be set for the specified HTTP header. Note that it's possible to use pre-defined variables, see <a href="http://cbonte.github.io/haproxy-dconv/1.7/configuration.html#8.2.4">HAProxy's documentation</a> for further details and examples.]]></help>
<help><![CDATA[The value that should be set for the specified HTTP header. Note that it is possible to use pre-defined variables, see <a href="http://cbonte.github.io/haproxy-dconv/1.7/configuration.html#8.2.4">HAProxy's documentation</a> for further details and examples.]]></help>
</field>
<field>
<label>Parameters</label>
@@ -170,7 +170,7 @@
<id>action.http-request_replace-header_regex</id>
<label>Regular Expression</label>
<type>text</type>
<help><![CDATA[Matches the specified regular expression in all occurrences of header field.]]></help>
<help><![CDATA[Matches the specified regular expression in all occurrences of the header field.]]></help>
</field>
<field>
<label>Parameters</label>
@@ -198,7 +198,7 @@
<id>action.http-response_lua</id>
<label>Lua function</label>
<type>text</type>
<help><![CDATA[Run the specified Lua function. You will most likely need to include/load your Lua code first.]]></help>
<help><![CDATA[Execute the specified Lua function. You will most likely need to include/load your Lua code first.]]></help>
</field>
<field>
<label>Parameters</label>
@@ -288,7 +288,7 @@
<id>action.tcp-request_content_lua</id>
<label>Lua function</label>
<type>text</type>
<help><![CDATA[Run the specified Lua function. You will most likely need to include/load your Lua code first.]]></help>
<help><![CDATA[Execute the specified Lua function. You will most likely need to include/load your Lua code first.]]></help>
</field>
<field>
<label>Parameters</label>
@@ -310,7 +310,7 @@
<id>action.tcp-response_content_lua</id>
<label>Lua function</label>
<type>text</type>
<help><![CDATA[Run the specified Lua function. You will most likely need to include/load your Lua code first.]]></help>
<help><![CDATA[Execute the specified Lua function. You will most likely need to include/load your Lua code first.]]></help>
</field>
<field>
<label>Parameters</label>
@@ -321,6 +321,6 @@
<id>action.custom</id>
<label>Option pass-through</label>
<type>textbox</type>
<help><![CDATA[Specify a HAProxy rule/ACL that is currently not supported by the GUI.<br/><div class="text-info"><b>NOTE:</b> This is strongly discouraged! The syntax will not be checked, use at your own risk!</div>]]></help>
<help><![CDATA[Specify a HAProxy rule/ACL that is currently not supported by the GUI.]]></help>
</field>
</form>
net/haproxy/src/opnsense/mvc/app/controllers/OPNsense/HAProxy/forms/dialogBackend.xml
+2 -2
View File
@@ -78,7 +78,7 @@
<id>backend.stickiness_pattern</id>
<label>Table type</label>
<type>dropdown</type>
<help><![CDATA[Choose a request pattern to associate a user to a server. See the <a target="_blank" href="http://cbonte.github.io/haproxy-dconv/configuration-1.6.html#stick on">HAProxy documentation</a> for a full description.<br/><div class="text-info"><b>NOTE:</b> Consider not using this feature in multi-process mode, it can result in random behaviours.</div>]]></help>
<help><![CDATA[Choose a request pattern to associate a user to a server. See the <a target="_blank" href="http://cbonte.github.io/haproxy-dconv/configuration-1.7.html#stick on">HAProxy documentation</a> for a full description.<br/><div class="text-info"><b>NOTE:</b> Consider not using this feature in multi-process mode, it can result in random behaviours.</div>]]></help>
<hint>Choose a persistence type.</hint>
</field>
<field>
@@ -142,7 +142,7 @@
<id>backend.customOptions</id>
<label>Option pass-through</label>
<type>textbox</type>
<help><![CDATA[These lines will be added to the HAProxy backend configuration.<br/><div class="text-info"><b>NOTE:</b> The syntax will not be checked, use at your own risk!</div>]]></help>
<help><![CDATA[These lines will be added to the HAProxy backend configuration.]]></help>
<advanced>true</advanced>
</field>
<field>
net/haproxy/src/opnsense/mvc/app/controllers/OPNsense/HAProxy/forms/dialogFrontend.xml
+4 -4
View File
@@ -28,9 +28,9 @@
</field>
<field>
<id>frontend.bindOptions</id>
<label>Advanced Bind Options</label>
<label>Bind option pass-through</label>
<type>text</type>
<help><![CDATA[A list of parameters that will be appended to every Listen Address line.<br/>Example: accept-proxy npn http/1.1<br/><div class="text-info"><b>NOTE:</b> The syntax will not be checked, use at your own risk!</div>]]></help>
<help><![CDATA[A list of parameters that will be appended to every Listen Address line.<br/>Example: accept-proxy npn http/1.1<br/>]]></help>
<advanced>true</advanced>
</field>
<field>
@@ -76,7 +76,7 @@
<id>frontend.ssl_customOptions</id>
<label>Advanced SSL options</label>
<type>text</type>
<help><![CDATA[Specify additional SSL parameters such as force-sslv3, force-tlsv10, force-tlsv11, force-tlsv12, no-sslv3, no-tlsv10, no-tlsv11, no-tlsv12, no-tls-tickets or customize the list of SSL ciphers.<br/>Example: no-sslv3 ciphers HIGH:!DSS:!aNULL@STRENGTH<br/><div class="text-info"><b>NOTE:</b> The syntax will not be checked, use at your own risk!</div>]]></help>
<help><![CDATA[Specify additional SSL parameters such as force-sslv3, force-tlsv10, force-tlsv11, force-tlsv12, no-sslv3, no-tlsv10, no-tlsv11, no-tlsv12, no-tls-tickets or customize the list of SSL ciphers.<br/>Example: no-sslv3 ciphers HIGH:!DSS:!aNULL@STRENGTH<br/>]]></help>
<advanced>true</advanced>
</field>
<field>
@@ -160,7 +160,7 @@
<id>frontend.customOptions</id>
<label>Option pass-through</label>
<type>textbox</type>
<help><![CDATA[These lines will be added to the HAProxy frontend configuration.<br/><div class="text-info"><b>NOTE:</b> This is strongly discouraged! The syntax will not be checked, use at your own risk!</div>]]></help>
<help><![CDATA[These lines will be added to the HAProxy frontend configuration.]]></help>
<advanced>true</advanced>
</field>
<field>
net/haproxy/src/opnsense/mvc/app/controllers/OPNsense/HAProxy/forms/dialogServer.xml
+2 -2
View File
@@ -103,9 +103,9 @@
</field>
<field>
<id>server.advanced</id>
<label>Advanced options</label>
<label>Option pass-through</label>
<type>text</type>
<help><![CDATA[A list of parameters that will be appended to the server line in every backend where this is will be used.<br/>Example: send-proxy<br/><div class="text-info"><b>NOTE:</b> The syntax will not be checked, use at your own risk!</div>.]]></help>
<help><![CDATA[A list of parameters that will be appended to the server line in every backend where this server will be used.<br/>Example: send-proxy<br/>.]]></help>
<advanced>true</advanced>
</field>
</form>
net/haproxy/src/opnsense/mvc/app/models/OPNsense/HAProxy/HAProxy.xml
+2 -2
View File
@@ -834,7 +834,7 @@
<ssl_sni_beg>SNI TLS extension starts with</ssl_sni_beg>
<ssl_sni_end>SNI TLS extension ends with</ssl_sni_end>
<ssl_sni_reg>SNI TLS extension regex</ssl_sni_reg>
<custom_acl>Specify a custom ACL</custom_acl>
<custom_acl>Custom condition (option pass-through)</custom_acl>
</OptionValues>
</expression>
<negate type="BooleanField">
@@ -1056,7 +1056,7 @@
<tcp-response_content_close>tcp-response content close</tcp-response_content_close>
<tcp-response_content_reject>tcp-response content reject</tcp-response_content_reject>
<tcp-response_content_lua>tcp-response content lua script</tcp-response_content_lua>
<custom>Custom Action (HAProxy syntax)</custom>
<custom>Custom rule (option pass-through)</custom>
</OptionValues>
</type>
<use_backend type="ModelRelationField">
net/haproxy/src/opnsense/mvc/app/models/OPNsense/HAProxy/Migrations/M2_0_0.php
-6
View File
@@ -141,8 +141,6 @@ class M2_0_0 extends BaseModelMigration
$acl->custom_acl = (string)$acl->value;
$acl->value = NULL;
break;
default:
// echo "DEBUG: no ACL migration required: " . (string)$acl->name . "\n";
}
}
@@ -253,8 +251,6 @@ class M2_0_0 extends BaseModelMigration
$action->custom = (string)$action->actionValue;
$action->actionValue = NULL;
break;
default:
// echo "DEBUG: no Action migration required: " . (string)$action->name . "\n";
}
}
@@ -281,8 +277,6 @@ class M2_0_0 extends BaseModelMigration
$hc->esmtp_domain = (string)$hc->smtpDomain;
$hc->smtpDomain = NULL;
break;
default:
// echo "DEBUG: no Healthcheck migration required: " . (string)$hc->name . "\n";
}
}
net/haproxy/src/opnsense/mvc/app/views/OPNsense/HAProxy/index.volt
+13 -10
View File
@@ -371,7 +371,7 @@ POSSIBILITY OF SUCH DAMAGE.
<a data-toggle="tab" href="#subtab_haproxy-real-servers-introduction" class="visible-lg-inline-block visible-md-inline-block visible-xs-inline-block visible-sm-inline-block" style="border-right:0px;"><b>{{ lang._('Real Servers') }}</b></a>
<ul class="dropdown-menu" role="menu">
<li><a data-toggle="tab" href="#subtab_haproxy-real-servers-introduction"><i class="fa fa-check-square"></i> {{ lang._('Introduction') }}</a></li>
<li><a data-toggle="tab" href="#servers"><i class="fa fa-check-square"></i> {{ lang._('Servers') }}</a></li>
<li><a data-toggle="tab" href="#servers"><i class="fa fa-check-square"></i> {{ lang._('Real Servers') }}</a></li>
</ul>
</li>
@@ -443,12 +443,12 @@ POSSIBILITY OF SUCH DAMAGE.
<div class="col-md-12">
<h1>Quick Start Guide</h1>
<p>{{ lang._('Welcome to the HAProxy plugin! This plugin is designed to offer all the features and flexibility HAProxy is famous for. If you are using HAProxy for the first time, please take some time to get familiar with it. The following information should help you to get started.')}}</p>
<p>{{ lang._('Note that you should configure everything in the following order:') }}</p>
<p>{{ lang._('Note that you should configure HAProxy in the following order:') }}</p>
<ul>
<li>{{ lang._('Add %sReal Servers:%s All physical or virtual servers that you want HAProxy to use should be added here.') | format('<b>', '</b>') }}</li>
<li>{{ lang._('Add %sBackend Pools:%s Group the previously added servers to build a server farm. All servers in a group usually deliver the same content. The Backend Pool cares for health monitoring and load distribution. A Backend Pool must also be configured if you only have a single server.') | format('<b>', '</b>')}}</li>
<li>{{ lang._('Add %sPublic Services:%s The Public Service listens for client connections, optionally applies rules and forwards client request data to the selected Backend Pool for load balancing (or proxying).') | format('<b>', '</b>') }}</li>
<li>{{ lang._('Finally enable HAProxy using the %sService Settings%s.') | format('<b>', '</b>') }}</li>
<li>{{ lang._('Add %sReal Servers:%s All physical or virtual servers that HAProxy should use to load balance between or proxy to.') | format('<b>', '</b>') }}</li>
<li>{{ lang._('Add %sBackend Pools:%s Group the previously added servers to build a server farm. All servers in a group usually deliver the same content. The Backend Pool takes care of health monitoring and load distribution. A Backend Pool must be configured even if you only have a single server.') | format('<b>', '</b>')}}</li>
<li>{{ lang._('Add %sPublic Services:%s The Public Service listens for client connections, optionally applies rules and forwards client request data to the selected Backend Pool for load balancing or proxying.') | format('<b>', '</b>') }}</li>
<li>{{ lang._('Lastly, enable HAProxy using the %sService Settings%s.') | format('<b>', '</b>') }}</li>
</ul>
<p>{{ lang._('Please be aware that you need to %smanually%s add the required firewall rules for all configured services.') | format('<b>', '</b>') }}</p>
<p>{{ lang._('Further information is available in our %sHAProxy plugin documentation%s and of course in the %sofficial HAProxy documentation%s. Be sure to report bugs and request features on our %sGitHub issue page%s. Code contributions are also very welcome!') | format('<a href="https://docs.opnsense.org/manual/how-tos/haproxy.html" target="_blank">', '</a>', '<a href="http://cbonte.github.io/haproxy-dconv/1.7/configuration.html" target="_blank">', '</a>', '<a href="https://github.com/opnsense/plugins/issues/" target="_blank">', '</a>') }}</p>
@@ -465,6 +465,7 @@ POSSIBILITY OF SUCH DAMAGE.
<li>{{ lang._('%sPort:%s The TCP or TCP port that should be used.') | format('<b>', '</b>') }}</li>
</ul>
<p>{{ lang._("Please note that advanced mode settings allow you to disable a certain server or to configure it as a backup server in a Backend Pool. Another neat option is the possibility to adjust a server's weight relative to other servers in the same Backend Pool.") }}</p>
<p>{{ lang._('Note that it is possible to directly add options to the HAProxy configuration by using the "option pass-through", a setting that is available for several configuration items. It allows you to implement configurations that are currently not officially supported by this plugin. It is strongly discouraged to rely on this feature. Please report missing features on our GitHub page!') | format('<b>', '</b>') }}</p>
<br/>
</div>
</div>
@@ -472,12 +473,13 @@ POSSIBILITY OF SUCH DAMAGE.
<div id="subtab_haproxy-virtual-services-introduction" class="tab-pane fade">
<div class="col-md-12">
<h1>Virtual Services</h1>
<p>{{ lang._("HAProxy requires two virtual services for it's loadbalancing and proxying features. The following virtual services must be configured for everything that should be served by HAProxy:") }}</p>
<p>{{ lang._("HAProxy requires two virtual services for its load balancing and proxying features. The following virtual services must be configured for everything that should be served by HAProxy:") }}</p>
<ul>
<li>{{ lang._('%sBackend Pools:%s The HAProxy backend. Group the %spreviously added servers%s to build a server farm. All servers in a group usually deliver the same content. The Backend Pool cares for health monitoring and load distribution. A Backend Pool must also be configured if you only have a single server. The same Backend Pool may be used for multiple Public Services.') | format('<b>', '</b>', '<b>', '</b>') }}</li>
<li>{{ lang._('%sPublic Services:%s The HAProxy frontend. The Public Service listens for client connections, optionally applies rules and forwards client request data to the selected Backend Pool for load balancing (or proxying). Every Public Service needs to be connected to a %spreviously created Backend Pool%s.') | format('<b>', '</b>', '<b>', '</b>') }}</li>
<li>{{ lang._('%sPublic Services:%s The HAProxy frontend. The Public Service listens for client connections, optionally applies rules and forwards client request data to the selected Backend Pool for load balancing or proxying. Every Public Service needs to be connected to a %spreviously created Backend Pool%s.') | format('<b>', '</b>', '<b>', '</b>') }}</li>
</ul>
<p>{{ lang._('Remember to add firewall rules for all configured Public Services.') }}</p>
<p>{{ lang._('Note that it is possible to directly add options to the HAProxy configuration by using the "option pass-through", a setting that is available for several configuration items. It allows you to implement configurations that are currently not officially supported by this plugin. It is strongly discouraged to rely on this feature. Please report missing features on our GitHub page!') | format('<b>', '</b>') }}</p>
<br/>
</div>
</div>
@@ -485,13 +487,14 @@ POSSIBILITY OF SUCH DAMAGE.
<div id="subtab_haproxy-rules-checks-introduction" class="tab-pane fade">
<div class="col-md-12">
<h1>Rules &amp; Checks</h1>
<p>{{ lang._("These are all optional features, HAProxy can be used without them. After getting used to HAProxy you'll find these optional features pretty useful:") }}</p>
<p>{{ lang._("After getting acquainted with HAProxy the following optional features may prove useful:") }}</p>
<ul>
<li>{{ lang._('%sHealth Monitors:%s The HAProxy "health checks". Health Monitors are used by %sBackend Pools%s to determine if a server is still able to respond to client requests. If a server fails a health check it will automatically be removed from a Backend Pool and healthy servers are automatically re-added.') | format('<b>', '</b>', '<b>', '</b>') }}</li>
<li>{{ lang._('%sConditions:%s HAProxy is capable of extracting data from requests, responses and other connection data and match it against predefined patterns. Use these powerful patterns to compose a condition that may be used in (multiple) Rules.') | format('<b>', '</b>') }}</li>
<li>{{ lang._('%sConditions:%s HAProxy is capable of extracting data from requests, responses and other connection data and match it against predefined patterns. Use these powerful patterns to compose a condition that may be used in multiple Rules.') | format('<b>', '</b>') }}</li>
<li>{{ lang._('%sRules:%s Perform a large set of actions if one or more %sConditions%s match. These Rules may be used in %sBackend Pools%s as well as %sPublic Services%s.') | format('<b>', '</b>', '<b>', '</b>', '<b>', '</b>', '<b>', '</b>') }}</li>
</ul>
<p>{{ lang._("For more information on HAProxy's %sACL feature%s see the %sofficial documentation%s.") | format('<b>', '</b>', '<a href="http://cbonte.github.io/haproxy-dconv/1.7/configuration.html#7" target="_blank">', '</a>') }}</p>
<p>{{ lang._('Note that it is possible to directly add options to the HAProxy configuration by using the "option pass-through", a setting that is available for several configuration items. It allows you to implement configurations that are currently not officially supported by this plugin. It is strongly discouraged to rely on this feature. Please report missing features on our GitHub page!') | format('<b>', '</b>') }}</p>
<br/>
</div>
</div>