Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated chart docs #1524

Merged
merged 4 commits into from
Sep 23, 2024
Merged

Updated chart docs #1524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d18aaac
fixed docs images and links
AndrewChubatiuk Sep 20, 2024
c023011
fixed style
AndrewChubatiuk Sep 21, 2024
fe2d7c6
added more docs
AndrewChubatiuk Sep 22, 2024
1931f24
added more docs
AndrewChubatiuk Sep 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions charts/victoria-logs-single/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,18 @@ resources: {}
</pre>
</td>
<td><p>Enable deployment of fluent-bit</p>
</td>
</tr>
<tr>
<td>global.compatibility</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">openshift:
adaptSecurityContext: auto
</code>
</pre>
</td>
<td><p>Openshift security context compatibility configuration</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -323,10 +335,11 @@ resources: {}
</td>
</tr>
<tr>
<td>podDisruptionBudget.enabled</td>
<td>bool</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">false
<td>podDisruptionBudget</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">enabled: false
extraLabels: {}
</code>
</pre>
</td>
Expand Down Expand Up @@ -464,7 +477,7 @@ loggerFormat: json
</code>
</pre>
</td>
<td><p>Sts/Deploy additional labels</p>
<td><p>StatefulSet/Deployment additional labels</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -596,7 +609,19 @@ loggerFormat: json
</code>
</pre>
</td>
<td></td>
<td><p>Array of host objects</p>
</td>
</tr>
<tr>
<td>server.ingress.ingressClassName</td>
<td>string</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="">
<code class="language-yaml">""
</code>
</pre>
</td>
<td><p>Ingress controller class name</p>
</td>
</tr>
<tr>
<td>server.ingress.pathType</td>
Expand All @@ -606,7 +631,8 @@ loggerFormat: json
</code>
</pre>
</td>
<td></td>
<td><p>Ingress path type</p>
</td>
</tr>
<tr>
<td>server.ingress.tls</td>
Expand Down
9 changes: 6 additions & 3 deletions charts/victoria-metrics-agent/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,8 @@ loggerFormat: json
</code>
</pre>
</td>
<td></td>
<td><p>Overrides the fullname prefix</p>
</td>
</tr>
<tr>
<td>global.compatibility</td>
Expand Down Expand Up @@ -891,7 +892,8 @@ name: ""
</code>
</pre>
</td>
<td></td>
<td><p>Destination multitenant endpoint for scraped/received metrics</p>
</td>
</tr>
<tr>
<td>nameOverride</td>
Expand All @@ -901,7 +903,8 @@ name: ""
</code>
</pre>
</td>
<td></td>
<td><p>Overrides fullname suffix</p>
</td>
</tr>
<tr>
<td>nodeSelector</td>
Expand Down
5 changes: 4 additions & 1 deletion charts/victoria-metrics-agent/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,10 @@ image:
# -- Image pull secrets
imagePullSecrets: []

# -- Overrides fullname suffix
nameOverride: ""

# -- Overrides the fullname prefix
fullnameOverride: ""

# -- Container working directory
Expand Down Expand Up @@ -94,8 +97,8 @@ remoteWriteUrls: []
# - http://vm-insert:8480/insert/0/prometheus
# - http://prometheus:8480/insert/0/prometheus

# -- Destination multitenant endpoint for scraped/received metrics
multiTenantUrls: []
# multiTenantUrls:
# - http://vm-insert-az1:8480
# - http://vm-insert-az2:8480

Expand Down
94 changes: 59 additions & 35 deletions charts/victoria-metrics-alert/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,8 @@ route:
</code>
</pre>
</td>
<td></td>
<td><p>Empty dir configuration if persistence is disabled for Alertmanager</p>
</td>
</tr>
<tr>
<td>alertmanager.enabled</td>
Expand All @@ -205,7 +206,8 @@ route:
</code>
</pre>
</td>
<td></td>
<td><p>Create alertmanager resources</p>
</td>
</tr>
<tr>
<td>alertmanager.envFrom</td>
Expand All @@ -226,7 +228,8 @@ route:
</code>
</pre>
</td>
<td></td>
<td><p>Extra command line arguments for container of component</p>
</td>
</tr>
<tr>
<td>alertmanager.extraContainers</td>
Expand Down Expand Up @@ -392,7 +395,8 @@ tag: v0.25.0
</code>
</pre>
</td>
<td></td>
<td><p>Alertmanager listen address</p>
</td>
</tr>
<tr>
<td>alertmanager.nodeSelector</td>
Expand All @@ -402,7 +406,8 @@ tag: v0.25.0
</code>
</pre>
</td>
<td></td>
<td><p>Pod&rsquo;s node selector. Details are <a href="https://kubernetes.io/docs/user-guide/node-selection/" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>alertmanager.persistentVolume.accessModes</td>
Expand Down Expand Up @@ -493,24 +498,16 @@ tag: v0.25.0
</td>
</tr>
<tr>
<td>alertmanager.podMetadata.annotations</td>
<td>alertmanager.podMetadata</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
<code class="language-yaml">annotations: {}
labels: {}
</code>
</pre>
</td>
<td></td>
</tr>
<tr>
<td>alertmanager.podMetadata.labels</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">{}
</code>
</pre>
<td><p>Alertmanager Pod metadata</p>
</td>
<td></td>
</tr>
<tr>
<td>alertmanager.podSecurityContext</td>
Expand All @@ -531,7 +528,8 @@ tag: v0.25.0
</code>
</pre>
</td>
<td></td>
<td><p>Name of Priority Class</p>
</td>
</tr>
<tr>
<td>alertmanager.probe.liveness</td>
Expand Down Expand Up @@ -591,7 +589,8 @@ tag: v0.25.0
</code>
</pre>
</td>
<td></td>
<td><p>Alertmanager retention</p>
</td>
</tr>
<tr>
<td>alertmanager.securityContext</td>
Expand Down Expand Up @@ -744,7 +743,8 @@ tag: v0.25.0
</code>
</pre>
</td>
<td></td>
<td><p>Alertmanager extra templates</p>
</td>
</tr>
<tr>
<td>alertmanager.tolerations</td>
Expand Down Expand Up @@ -913,7 +913,8 @@ name: ""
</code>
</pre>
</td>
<td></td>
<td><p>Pod affinity</p>
</td>
</tr>
<tr>
<td>server.annotations</td>
Expand All @@ -927,14 +928,16 @@ name: ""
</td>
</tr>
<tr>
<td>server.config.alerts.groups</td>
<td>list</td>
<td>server.config</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">[]
<code class="language-yaml">alerts:
groups: []
</code>
</pre>
</td>
<td></td>
<td><p>VMAlert configuration</p>
</td>
</tr>
<tr>
<td>server.configMap</td>
Expand All @@ -944,7 +947,7 @@ name: ""
</code>
</pre>
</td>
<td><p>VMAlert alert rules configuration configuration: use existing configmap if specified otherwise .config values will be used</p>
<td><p>VMAlert alert rules configuration configuration. Use existing configmap if specified</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1006,7 +1009,8 @@ username: ""
</code>
</pre>
</td>
<td></td>
<td><p>Create vmalert component</p>
</td>
</tr>
<tr>
<td>server.env</td>
Expand Down Expand Up @@ -1095,7 +1099,8 @@ loggerFormat: json
</code>
</pre>
</td>
<td></td>
<td><p>Full name prefix override</p>
</td>
</tr>
<tr>
<td>server.image</td>
Expand Down Expand Up @@ -1241,7 +1246,8 @@ variant: ""
</code>
</pre>
</td>
<td></td>
<td><p>Override fullname suffix</p>
</td>
</tr>
<tr>
<td>server.nameOverride</td>
Expand All @@ -1251,7 +1257,8 @@ variant: ""
</code>
</pre>
</td>
<td></td>
<td><p>Full name suffix override</p>
</td>
</tr>
<tr>
<td>server.nodeSelector</td>
Expand All @@ -1261,7 +1268,8 @@ variant: ""
</code>
</pre>
</td>
<td></td>
<td><p>Pod&rsquo;s node selector. Details are <a href="https://kubernetes.io/docs/user-guide/node-selection/" target="_blank">here</a></p>
</td>
</tr>
<tr>
<td>server.notifier</td>
Expand Down Expand Up @@ -1357,7 +1365,8 @@ labels: {}
</code>
</pre>
</td>
<td></td>
<td><p>Pod&rsquo;s additional labels</p>
</td>
</tr>
<tr>
<td>server.podSecurityContext</td>
Expand All @@ -1378,7 +1387,8 @@ labels: {}
</code>
</pre>
</td>
<td></td>
<td><p>Name of Priority Class</p>
</td>
</tr>
<tr>
<td>server.probe.liveness</td>
Expand Down Expand Up @@ -1431,6 +1441,18 @@ username: ""
</pre>
</td>
<td><p>Basic auth for remote read</p>
</td>
</tr>
<tr>
<td>server.remote.read.bearer</td>
<td>object</td>
<td><pre class="helm-vars-default-value" language-yaml" lang="plaintext">
<code class="language-yaml">token: ""
tokenFile: ""
</code>
</pre>
</td>
<td><p>Auth based on Bearer token for remote read</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1463,7 +1485,8 @@ username: ""
</code>
</pre>
</td>
<td></td>
<td><p>VMAlert remote read URL</p>
</td>
</tr>
<tr>
<td>server.remote.write.basicAuth</td>
Expand Down Expand Up @@ -1519,7 +1542,8 @@ tokenFile: ""
</code>
</pre>
</td>
<td></td>
<td><p>VMAlert remote write URL</p>
</td>
</tr>
<tr>
<td>server.replicaCount</td>
Expand Down
Loading