Github Actions
9d5f77cca0
Automatic update operator docs from VictoriaMetrics/operator@dd980c8 ( #4751 )
2023-08-11 03:13:14 -07:00
Aliaksandr Valialkin
1b7d97787a
docs: use 1. instead of N. in numbered bullets, so they are automatically adjusted by Github Markdown engine
...
See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists
2023-07-26 14:40:06 -07:00
Zakhar Bessarab
7eeb2d553f
docs/operator: add note about selectors for VMProbe ( #4541 )
...
Added a line for `probeSelector` and links to objects selectors section to make it easier to find more details about selectors.
Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com>
2023-07-06 21:57:21 -07:00
Artem Navoiev
28bef227c8
change title of the operator doc to match title frontmatter
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-07-06 21:18:21 -07:00
greynix
82a2d6aba5
docs/oprator/api.md: corrected broken links to Kubernetes documentation ( #4433 )
2023-07-06 16:47:44 -07:00
Artem Navoiev
ec97b851bb
remove absolute links, fix aliase
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
(cherry picked from commit 434358b551
2023-06-02 13:19:33 +02:00
Artem Navoiev
b4aaeda72f
fix link in operator quick start docs.2
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-16 10:06:52 -07:00
Artem Navoiev
c771f4eccf
fix link in operator quick start docs
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-05-16 10:05:36 -07:00
Alexander Marshalov
d321ea91f2
fixed typos in documentation and commandline flags descriptions ( #4275 )
2023-05-10 02:22:06 -07:00
Alexander Marshalov
65f4590403
update generated docs for operator ( #4267 )
...
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-05-09 22:06:28 -07:00
Timur Bakeyev
f21ea62ae1
Fix cut-n-paste error ( #4079 )
...
It seems that VMServiceScrape description was c-n-p from vmselect one into all other resources.
2023-04-06 00:44:29 -07:00
Timur Bakeyev
210216a1e2
Fix reference to the imagepullsecrets description ( #4080 )
...
Looks like the original document has moved to the https://kubernetes.io/docs/concepts/containers/images/#referring-to-an-imagepullsecrets-on-a-pod .
Alternatively, it could be that https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ describes the meaning of the parameter in more detail.
2023-04-05 19:57:22 -07:00
Eliran Barnoy
7c70fb0fb9
Fix operator links to include VMPrometheusConverter for added visibility
2023-03-30 12:33:04 -07:00
Alexander Marshalov
31005f4980
updated api doc for operator ( #3972 )
...
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-03-17 16:17:17 -07:00
Alexander Marshalov
3f10f19842
updated vars doc for operator ( #3960 )
...
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-03-15 12:19:53 -07:00
Alexander Marshalov
0b7f83c846
added documentation about new templates field of vmalertmanager specification in operator ( https://github.com/VictoriaMetrics/operator/issues/592 ) ( #3924 )
...
Signed-off-by: Alexander Marshalov <_@marshalov.org>
2023-03-08 01:33:42 -08:00
Nikolay
77e0e847a8
docs: updates operator api.md ( #3922 )
2023-03-08 01:12:16 -08:00
Alexander Marshalov
c682609fc4
added doc for placeholder support in vmagent specification for operator ( https://github.com/VictoriaMetrics/operator/issues/592 ) ( #3916 )
2023-03-08 01:07:14 -08:00
Artem Navoiev
efec0f150f
fix operator docs hugo schema
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-01-11 17:00:14 -08:00
Artem Navoiev
8d238f1bc2
docs: prepare operator docs to migration
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-01-11 16:59:52 -08:00
Artem Navoiev
3991c977af
docs: operator *.MD -> *.md
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2023-01-11 16:59:24 -08:00
Roman Khavronenko
f2e7e11382
docs: fix link typo in operator docs ( #3508 )
2022-12-20 10:22:40 -08:00
Aliaksandr Valialkin
97b41e727c
lib/promscrape: implement target-level and metric-level relabel debugging
...
Target-level debugging is performed by clicking the 'debug' link at the corresponding target
on either http://vmagent:8429/targets page or on http://vmagent:8428/service-discovery page.
Metric-level debugging is perfromed at http://vmagent:8429/metric-relabel-debug page.
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/3407
See https://docs.victoriametrics.com/vmagent.html#relabel-debug
2022-12-10 02:25:56 -08:00
Zakhar Bessarab
5edaff5165
doc/operator: update formatting for backup section, add FAQ section ( #3416 )
...
* doc/operator: update formatting for backup section, add FAQ section
* doc/operator: address review feedback
* doc/operator: add note about difference between `VMRestore` and `VMBackupmanager` as init containers
* Update docs/operator/backups.MD
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2022-11-29 20:28:50 -08:00
Zakhar Bessarab
e188b59382
docs/operator: fix description for SA at VMClusterSpec ( #3313 )
2022-11-09 11:51:47 +02:00
Dmytro Kozlov
ae05b475d0
docs/operator: change VMAgentRemoteWriteSettings.MaxDiskUsagePerURL type from int32 to int64 ( #3307 )
...
* docs/operator: change VMAgentRemoteWriteSettings.MaxDiskUsagePerURL type from int32 to int64
* docs: operator updates api description
Co-authored-by: f41gh7 <nik@victoriametrics.com>
2022-11-05 10:09:38 +02:00
Aliaksandr Valialkin
961e986ca9
docs: consistently use docs.victoriametrics.com instead of victoriametrics.github.io in all the links
2022-09-13 16:50:36 +03:00
Aliaksandr Valialkin
a6970e3052
docs: fix ordering after adding the docs/relabeling.md
2022-08-18 01:17:55 +03:00
Aliaksandr Valialkin
5e43145031
docs: add docs for scrape_configs section
2022-08-07 00:04:55 +03:00
Aliaksandr Valialkin
df34f8c5b8
docs: fixes after 83a4abda3f
2022-08-05 10:15:28 +03:00
Artem Navoiev
82581ab728
Docs: Operator Additional Scrape Configuration - update docs ( #2826 )
...
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
2022-07-05 13:20:41 +03:00
Aliaksandr Valialkin
92e6c55b75
docs: add Troubleshooting doc
...
This doc contains troubleshooting guides for typical problems with VictoriaMetrics.
2022-06-30 13:52:44 +03:00
Artem Navoiev
42c69ae74e
docs: replace bash code block type with console ( #2746 )
2022-06-19 23:02:00 +03:00
Nikolay
754d3b1f93
Updates operator docs ( #2622 )
...
* docs/operator: adds information about VMAgent statefulMode
* docs/operator: adds description for alertmanager configuration
* docs/operator: adds description for configuration syncronization
https://github.com/VictoriaMetrics/operator/issues/124
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2022-05-23 10:55:42 +03:00
Roman Khavronenko
ee1f8bae2e
docs: fix liquid syntax errors ( #2592 )
...
For liquid text processor double braces `{{` `}}`
are special chars for templating.
Since we use them in some of our docs with different purpose,
we must escape them to avoid syntax errors from liquid.
For escaping curly braces we use bult-in plugin which helps
to enclose sections of text via `{% raw %}` and `{% endraw %}`.
This approach prevents liquid syntax errors and makes render correct.
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-05-20 13:42:47 +03:00
Ross Dougherty
4df09074d3
fix object selectors link ( #2391 )
...
* fix object selectors link
* update kustomize url
2022-04-01 12:41:28 +03:00
Dima Lazerka
6e8e385375
VMAnomaly docs fixes ( #2361 )
...
* Added docs for vmanomaly
* Add example images
* Stylistic fixes
* Move images to root
* Update docs/vmanomaly.md
* Update docs/vmanomaly.md
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
* Squeeze vmanomaly after vmbackupmanager before Case Studies
Co-authored-by: Aliaksandr Valialkin <valyala@victoriametrics.com>
Co-authored-by: Roman Khavronenko <roman@victoriametrics.com>
2022-03-25 12:09:05 +02:00
Roman Khavronenko
ec48d022df
docs: fix broken links ( #2303 )
...
Signed-off-by: hagen1778 <roman@victoriametrics.com>
2022-03-16 13:01:46 +02:00
nemobis
cd522dee14
Fix typo, sentence flow in operator description ( #2251 )
2022-03-03 18:37:07 +02:00
Pablo Ley
4606d00d7d
Added missing inlineScrapeConfig field to the VMAgentSpec docs
2022-02-21 13:55:50 +02:00
Pablo Ley
66271bfeee
Added missing links in EmbeddedHPA API docs
2022-02-02 23:42:25 +02:00
jaysony
3e22537248
correct VMAgentStatus description ( #2109 )
...
correct VMAgentStatus description from VMAlert to VMAgent.
2022-01-27 20:18:37 +02:00
Aliaksandr Valialkin
4911c0c045
docs/operator: fix links to Operator API docs
2022-01-25 17:38:41 +02:00
f41gh7
2f56f484af
updates operator docs
2022-01-23 13:15:37 +02:00
Yurii Kravets
4b7650832e
Created Operator folder in docs ( #2034 )
...
* Created Operator folder in docs
Transferred Operator documentation
* Removed Contributing and Release
* Changed sort numbering
* Renamed folder
Operator -> operator
* 1
1
* Name change
Operator -> operator
* Removed colon symbol
* Useful links transformed to links style
* "updated at..." is no longer a header
* delete manager patch.yaml
* delete kustomization.yaml
* removed part with links
* community and contributions part removed
* Delete readme
* Docs navigation removed
2022-01-21 12:06:41 +02:00
