feat: pushgateway extra parameters #320
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
weakcamel
changed the title
weakcamel
force-pushed
the
weakcamel/pushgateway_extra_cli_params
branch
from
a0b982e
to
55d9898
Compare
github-actions
bot
added
enhancement
weakcamel
force-pushed
the
weakcamel/pushgateway_extra_cli_params
branch
from
55d9898
to
dceb0ca
Compare
github-actions
bot
added
enhancement
weakcamel
force-pushed
the
weakcamel/pushgateway_extra_cli_params
branch
from
dceb0ca
to
24b74c8
Compare
github-actions
bot
added
enhancement
Allow passing in additional parameters for the pushgateway binary * pushgateway_web_external_url - useful when running behind a reverse proxy * pushgateway_cli_extra_flags - additional extra flags for flexibility Signed-off-by: Waldek Maleska <waldekm@speechmatics.com>
weakcamel
force-pushed
the
weakcamel/pushgateway_extra_cli_params
branch
from
24b74c8
to
b63a01a
Compare
github-actions
bot
added
enhancement
gardar
requested changes
Apr 9, 2024
github-actions
bot
added
enhancement
Docs Build 📝Thank you for contribution!✨ The docs for this PR have been published here: You can compare to the docs for the The docsite for this PR is also available for download as an artifact from this run: File changes: Click to see the diff comparison.NOTE: only file modifications are shown here. New and deleted files are excluded. diff --git a/home/runner/work/ansible/ansible/docsbuild/base/pushgateway_role.html b/home/runner/work/ansible/ansible/docsbuild/head/pushgateway_role.html
index 73eeb40..ffe88cf 100644
--- a/home/runner/work/ansible/ansible/docsbuild/base/pushgateway_role.html
+++ b/home/runner/work/ansible/ansible/docsbuild/head/pushgateway_role.html
@@ -224,6 +224,14 @@ To check whether it is installed, run <code class="code docutils literal notrans
</div></td>
</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_cli_extra_flags"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-cli-extra-flags"><strong>pushgateway_cli_extra_flags</strong></p>
+<a class="ansibleOptionLink" href="#parameter-main--pushgateway_cli_extra_flags" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>Optional extra flags to be passed to pushgateway binary, e.g. [’–log.level=debug’, ‘–log.format=json’, ‘–web.enable-admin-api’]</p>
+<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[]</span></code></p>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_http_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-http-server-config"><strong>pushgateway_http_server_config</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--pushgateway_http_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
@@ -231,7 +239,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/pushgateway/blob/master/https/README.md#sample-config">pushgateway docs</a>.</p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-skip-install"><strong>pushgateway_skip_install</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--pushgateway_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
</div></td>
@@ -243,7 +251,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
</ul>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_system_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-system-group"><strong>pushgateway_system_group</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--pushgateway_system_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@@ -252,7 +260,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"pushgateway"</span></code></p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_system_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-system-user"><strong>pushgateway_system_user</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--pushgateway_system_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@@ -261,7 +269,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"pushgateway"</span></code></p>
</div></td>
</tr>
-<tr class="row-even"><td><div class="ansible-option-cell">
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_tls_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-tls-server-config"><strong>pushgateway_tls_server_config</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--pushgateway_tls_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
</div></td>
@@ -269,7 +277,7 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/pushgateway/blob/master/https/README.md#sample-config">pushgateway docs</a>.</p>
</div></td>
</tr>
-<tr class="row-odd"><td><div class="ansible-option-cell">
+<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-version"><strong>pushgateway_version</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--pushgateway_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
@@ -277,6 +285,14 @@ To check whether it is installed, run <code class="code docutils literal notrans
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"1.8.0"</span></code></p>
</div></td>
</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_web_external_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-web-external-url"><strong>pushgateway_web_external_url</strong></p>
+<a class="ansibleOptionLink" href="#parameter-main--pushgateway_web_external_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>External address on which pushgateway is available. Useful when behind reverse proxy, e.g.: <a class="reference external" href="https://example.org/pushgateway">https://example.org/pushgateway</a></p>
+<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">""</span></code></p>
+</div></td>
+</tr>
<tr class="row-even"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-main--pushgateway_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-pushgateway-role-parameter-main-pushgateway-web-listen-address"><strong>pushgateway_web_listen_address</strong></p>
<a class="ansibleOptionLink" href="#parameter-main--pushgateway_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
Sure thing, done. PTAL |
gardar
reviewed
Apr 10, 2024
Signed-off-by: Waldek Maleska <waldekm@speechmatics.com>
weakcamel
force-pushed
the
weakcamel/pushgateway_extra_cli_params
branch
from
3731594
to
57572f9
Compare
github-actions
bot
added
enhancement
Silly me! of course, done. |
SuperQ
requested changes
Apr 10, 2024
|
|
||
| # Optional extra flags to be passed to pushgateway binary, e.g. | ||
| # ['--log.level=debug', '--log.format=json', '--web.enable-admin-api'] | ||
| pushgateway_cli_extra_flags: [] |
There was a problem hiding this comment.
Let's follow the naming convention used in other roles. <role>_config_flags_extra.
Suggested change
| pushgateway_cli_extra_flags: [] | |
| pushgateway_config_flags_extra: [] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allow passing in additional parameters for the pushgateway binary
pushgateway_web_external_url- useful when running behind a reverse proxypushgateway_cli_extra_flags- additional extra flags for flexibilityResolves #288