Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-23 12:31:07 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity
9,522 Commits 153 Branches 748 Tags 384 MiB
master
Commit Graph

195 Commits

Author SHA1 Message Date
hagen1778
0a5ffb3bc1
docs: remove slug from Grafana dashboard URLs 
Each Grafana dashboard has unique ID which can be used to fetch the dashboard
from grafana.com: https://grafana.com/grafana/dashboards/11176
The same dashboard can be accessed via URL with slug: https://grafana.com/grafana/dashboards/11176-victoriametrics-cluster/
But using slug implies that any change to dashboard name will break the link.
So it is better to just use ID, so the dashboard URL will never break.

This is follow-up for ff33e60a3d

Signed-off-by: hagen1778 <roman@victoriametrics.com>
 2024-01-18 11:19:53 +01:00
hagen1778
8ba483eca3
docs: fix unauthorizedAccessConfig filed names for operator 
See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/5520

Signed-off-by: hagen1778 <roman@victoriametrics.com>
 2023-12-22 10:50:21 +01:00
Github Actions
7ca783dee9
Automatic update operator docs from VictoriaMetrics/operator@f628bee (#5407) 2023-11-28 16:50:24 +01:00
Github Actions
255bede1f2
Automatic update operator docs from VictoriaMetrics/operator@e737115 (#5394) 2023-11-27 13:05:01 +04:00
Github Actions
93b8bf66aa
Automatic update operator docs from VictoriaMetrics/operator@fec3f9d (#5381) 2023-11-23 21:06:03 +02:00
Github Actions
e1fb9d9230
Automatic update operator docs from VictoriaMetrics/operator@45bfa36 (#5373) 2023-11-22 20:24:50 +02:00
Github Actions
0715b4e121
Automatic update operator docs from VictoriaMetrics/operator@b96131b (#5371) 2023-11-22 03:59:07 -08:00
Github Actions
75059f3feb
Automatic update operator docs from VictoriaMetrics/operator@388745c (#5340) 2023-11-17 15:45:25 +01:00
Github Actions
8924fea33a
Automatic update operator docs from VictoriaMetrics/operator@bc8b02f (#5331) 2023-11-16 16:29:37 +01:00
Github Actions
4d2b98b755
Automatic update operator docs from VictoriaMetrics/operator@b4b79da (#5291) 2023-11-06 16:04:12 +08:00
Github Actions
b44b74d118
Automatic update operator docs from VictoriaMetrics/operator@49826be (#5270) 
Co-authored-by: Alexander Marshalov <_@marshalov.org>
 2023-11-01 17:45:56 +01:00
Github Actions
3e76c3bd50
Automatic update operator docs from VictoriaMetrics/operator@57c1bf6 (#5266) 2023-11-01 16:33:25 +08:00
Github Actions
0a6932acfe
Automatic update operator docs from VictoriaMetrics/operator@2c826bb (#5188) 2023-10-17 15:57:11 +02:00
Github Actions
7abdbbc8e2
Automatic update operator docs from VictoriaMetrics/operator@79298bf (#5177) 2023-10-16 10:45:46 +08:00
Artem Navoiev
8dff1c696f
docs fix broken links 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-10-14 15:39:49 +02:00
Artem Navoiev
a200aaf0ef
docs fix broken links in operator 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-10-14 15:17:17 +02:00
Aliaksandr Valialkin
3f5a41e35e
lib/license: cleanups and prettifications for log messages and docs related to licensing 
- Make more clear the docs at docs/enterprise.md, so readers could figure out faster
  on how to obtain enterprise key and how to pass it to VictoriaMetrics Enterprise components.

- Fix examples at docs/enterprise.md, which were referring to non-existing `-license-file` command-line flag.
  The `-licenseFile` command-line flag must be used instead.

- Improve the description of `-license*` command-line flags, so users could understand
  faster how to use them.

- Improve the warning message, which is emitted when the deprecated -eula command-line flag is passed,
  so the user could figure out how to switch faster to -license* command-line flags.

- Disallow running VictoriaMetrics components with both -license and -licenseFile command-line flags.

- Disallow running VictoriaMetrics components when -licensFile points to an empty file.

- Consistently use the phrase "This flag is available only in Enterprise binaries" across
  all the enterprise-specific command-line flags.

- Remove unneeded level of indirection for `noLicenseMessage` and `expiredMessage` string contants
  in order to improve code readability and maintainability.

- Remove unneded `return` statements after `logger.Fatalf()` calls, since these calls exit the app and never return.

- Make sure that the info log message about successful license verification is emitted
  when the license is verified successfully. Previously the error message could be logged
  when the license payload is invalid or if it misses some required features.
 2023-10-13 14:56:09 +02:00
Github Actions
b576acff5e
Automatic update operator docs from VictoriaMetrics/operator@26d1b3b (#5130) 2023-10-05 12:43:28 +02:00
Github Actions
590bd50df4
Automatic update operator docs from VictoriaMetrics/operator@5da4bf6 (#5127) 2023-10-04 18:51:53 +02:00
Github Actions
cd0683a3af
Automatic update operator docs from VictoriaMetrics/operator@9fb79f4 (#5124) 2023-10-04 17:03:50 +02:00
Artem Navoiev
ce17f81b00
docs: remove id clashes for pages, properly cover victorialogs changelog page (#5123) 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-10-04 15:46:28 +02:00
Artem Navoiev
c21863a956
add hugo front matter for operator docs (#5122) 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-10-04 15:27:40 +02:00
Alexander Marshalov
7b35eaa853
hide deprecated docs from menu (#5095) 2023-10-03 14:28:33 +02:00
Github Actions
256d800200
Automatic update operator docs from VictoriaMetrics/operator@44bdc27 (#5104) 2023-10-02 15:50:18 +02:00
Github Actions
62de314510
Automatic update operator docs from VictoriaMetrics/operator@c7125bd (#5102) 2023-10-02 14:50:08 +02:00
Github Actions
af53799332
Automatic update operator docs from VictoriaMetrics/operator@958ce2b (#5070) 2023-09-27 09:04:33 +08:00
Github Actions
33c17a5a2b
Automatic update operator docs from VictoriaMetrics/operator@587ea54 (#5054) 2023-09-25 12:42:05 +02:00
Github Actions
71a17dfcbe
Automatic update operator docs from VictoriaMetrics/operator@9d65e09 (#5040) 2023-09-21 13:20:55 +02:00
Github Actions
9f3f085d7f
Automatic update operator docs from VictoriaMetrics/operator@49d245d (#5002) 2023-09-13 22:33:00 +08:00
Github Actions
d6cdfd231a
Automatic update operator docs from VictoriaMetrics/operator@a9c54f4 (#4998) 2023-09-13 06:03:46 +08:00
Github Actions
9902418524
Automatic update operator docs from VictoriaMetrics/operator@21f7203 (#4988) 2023-09-11 09:40:46 +02:00
Github Actions
78dfbe1622
Automatic update operator docs from VictoriaMetrics/operator@83c07ed (#4970) 2023-09-07 15:09:28 +02:00
Github Actions
72d3063bef
Automatic update operator docs from VictoriaMetrics/operator@9c461d2 (#4968) 2023-09-07 12:26:02 +02:00
Artem Navoiev
7be3848ee6
use correct abbriviation for ESA legal doc 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-09-05 11:01:45 +02:00
Artem Navoiev
42baf5fe3f change link to the enterprise legal doc 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-09-05 01:53:36 -07:00
Github Actions
e04c435875
Automatic update operator docs from VictoriaMetrics/operator@b63f6e9 (#4946) 2023-09-04 18:19:38 +02:00
Github Actions
26cee36499
Automatic update operator docs from VictoriaMetrics/operator@add9045 (#4941) 2023-09-02 17:19:32 +02:00
Github Actions
ff4bc9d18e
Automatic update operator docs from VictoriaMetrics/operator@c32931b (#4940) 2023-09-02 16:20:46 +02:00
Github Actions
3222780707
Automatic update operator docs from VictoriaMetrics/operator@18e080e (#4921) 
Co-authored-by: Alexander Marshalov <_@marshalov.org>
 2023-08-30 15:09:18 +02:00
Github Actions
3f7bde5bac
Automatic update operator docs from VictoriaMetrics/operator@d0c3ec7 (#4909) 2023-08-29 22:20:31 +02:00
Github Actions
501d8e1978
Automatic update operator docs from VictoriaMetrics/operator@d40882c (#4894) 
Co-authored-by: Alexander Marshalov <_@marshalov.org>
 2023-08-25 19:58:31 +02:00
Github Actions
ef6468584c
Automatic update operator docs from VictoriaMetrics/operator@e00fe21 (#4891) 2023-08-25 15:49:00 +02:00
Github Actions
2122eb18fe
Automatic update operator docs from VictoriaMetrics/operator@8a25794 (#4883) 2023-08-23 19:29:46 +02:00
Github Actions
7d8b6fbe20
Automatic update operator docs from VictoriaMetrics/operator@76d5956 (#4854) 2023-08-18 09:34:37 +02:00
Github Actions
c884311cf5
Automatic update operator docs from VictoriaMetrics/operator@9f41076 (#4840) 2023-08-15 10:55:20 +02:00
Github Actions
7602b95bcb
Automatic update operator docs from VictoriaMetrics/operator@9ea59e2 (#4813) 
Co-authored-by: Alexander Marshalov <_@marshalov.org>
 2023-08-10 16:36:10 +02:00
Github Actions
6411191158
Automatic update operator docs from VictoriaMetrics/operator@2a03bde (#4812) 2023-08-10 16:33:30 +02:00
Github Actions
0a93abfeed
Automatic update operator docs from VictoriaMetrics/operator@ca27728 (#4802) 2023-08-10 10:38:19 +02:00
Github Actions
fc01167962
Automatic update operator docs from VictoriaMetrics/operator@7e12a16 (#4783) 2023-08-03 18:53:47 +02:00
Github Actions
8895fb1d5f
Automatic update operator docs from VictoriaMetrics/operator@29a7495 (#4770) 2023-08-03 09:56:18 +02:00
Github Actions
837445b81b
Automatic update operator docs from VictoriaMetrics/operator@dd980c8 (#4751) 2023-07-31 20:59:39 +02:00
Aliaksandr Valialkin
cc8427f11b
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:39:44 -07:00
Zakhar Bessarab
d12548d925
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-06-29 17:16:47 +02:00
Artem Navoiev
88993f3124
change title of the operator doc to match title frontmatter 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-06-20 13:40:35 +02:00
greynix
36bc1bb8ff
docs/oprator/api.md: corrected broken links to Kubernetes documentation (#4433) 2023-06-12 12:07:56 +02:00
Artem Navoiev
434358b551 remove absolute links, fix aliase 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-05-25 14:35:21 -07:00
Artem Navoiev
478258bc4d
fix link in operator quick start docs.2 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-05-14 21:20:57 +02:00
Artem Navoiev
c19fc52676
fix link in operator quick start docs 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-05-14 19:54:08 +02:00
Alexander Marshalov
2e494e2375
fixed typos in documentation and commandline flags descriptions (#4275) 2023-05-10 09:50:41 +02:00
Alexander Marshalov
c0cb3e4f98
update generated docs for operator (#4267) 
Signed-off-by: Alexander Marshalov <_@marshalov.org>
 2023-05-08 12:39:44 +02:00
Timur Bakeyev
37a7627254
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 11:02:12 +04:00
Timur Bakeyev
d87a700528
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:56:28 -07:00
Eliran Barnoy
9199c23720 Fix operator links to include VMPrometheusConverter for added visibility 2023-03-29 11:44:49 +02:00
Alexander Marshalov
57b00bafc9
updated api doc for operator (#3972) 
Signed-off-by: Alexander Marshalov <_@marshalov.org>
 2023-03-17 10:42:30 +01:00
Alexander Marshalov
55afae8641
updated vars doc for operator (#3960) 
Signed-off-by: Alexander Marshalov <_@marshalov.org>
 2023-03-15 17:28:01 +01:00
Alexander Marshalov
ccb08fc28b
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-07 17:51:26 +01:00
Nikolay
02f13d5681
docs: updates operator api.md (#3922) 2023-03-07 09:09:05 +01:00
Alexander Marshalov
75977a4d02
added doc for placeholder support in vmagent specification for operator (https://github.com/VictoriaMetrics/operator/issues/592) (#3916) 2023-03-06 11:58:31 +01:00
Artem Navoiev
13a1a7f826
fix operator docs hugo schema 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-01-11 17:28:34 +01:00
Artem Navoiev
83c87f822a docs: prepare operator docs to migration 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-01-11 18:19:40 +02:00
Artem Navoiev
54aec2b1ba
docs: operator *.MD -> *.md 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2023-01-11 16:29:29 +01:00
Roman Khavronenko
8122191368
docs: fix link typo in operator docs (#3508) 2022-12-20 14:52:47 +01:00
Aliaksandr Valialkin
a8b8e23d68
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:09:44 -08:00
Zakhar Bessarab
2f837c1b23
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 19:19:46 +01:00
Zakhar Bessarab
91dd79f40f
docs/operator: fix description for SA at VMClusterSpec (#3313) 2022-11-07 16:51:01 +01:00
Dmytro Kozlov
99d8fcb332
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-04 01:12:57 +01:00
Aliaksandr Valialkin
3af24a5b7c
docs: consistently use docs.victoriametrics.com instead of victoriametrics.github.io in all the links 2022-09-13 16:50:13 +03:00
Aliaksandr Valialkin
421aca7b2f
docs: fix ordering after adding the docs/relabeling.md 2022-08-18 01:17:27 +03:00
Aliaksandr Valialkin
f36de0ecc9
docs: add docs for scrape_configs section 2022-08-07 00:04:31 +03:00
Aliaksandr Valialkin
0c95d87abd
docs: fixes after 83a4abda3f 2022-08-05 10:15:00 +03:00
Artem Navoiev
9c763490b7
Docs: Operator Additional Scrape Configuration - update docs (#2826) 
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
 2022-07-05 11:06:23 +02:00
Aliaksandr Valialkin
56622bff73
docs: add Troubleshooting doc 
This doc contains troubleshooting guides for typical problems with VictoriaMetrics.
 2022-06-30 13:53:59 +03:00
Artem Navoiev
954a7a6fc6
docs: replace bash code block type with console (#2746) 2022-06-19 22:57:53 +03:00
Nikolay
ce644e9942
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 07:46:53 +02:00
Roman Khavronenko
284bda8746
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-16 09:27:19 +02:00
Ross Dougherty
0fd4c48568
fix object selectors link (#2391) 
* fix object selectors link

* update kustomize url
 2022-04-01 12:40:41 +03:00
Dima Lazerka
1fa0f3ec89
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:08:17 +02:00
Roman Khavronenko
0fa7effc4b
docs: fix broken links (#2303) 
Signed-off-by: hagen1778 <roman@victoriametrics.com>
 2022-03-13 15:56:01 +02:00
nemobis
df088dd78a
Fix typo, sentence flow in operator description (#2251) 2022-03-03 18:27:12 +02:00
Pablo Ley
affaf373ea Added missing inlineScrapeConfig field to the VMAgentSpec docs 2022-02-18 19:46:17 +03:00
Pablo Ley
a6587ded51 Added missing links in EmbeddedHPA API docs 2022-02-02 18:59:42 +03:00
jaysony
2e59b17108
correct VMAgentStatus description (#2109) 
correct VMAgentStatus description from VMAlert to VMAgent.
 2022-01-27 20:18:05 +02:00
Aliaksandr Valialkin
a41c34705e
docs/operator: fix links to Operator API docs 2022-01-25 17:38:16 +02:00
f41gh7
ceb1376267
updates operator docs 2022-01-21 19:03:19 +03:00
Yurii Kravets
3ea054a52c
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:05:58 +02:00