master
json 109 lines 3.27 KB
Raw
1 {
2 "jsonSchema": {
3 "$schema": "http://json-schema.org/draft-07/schema#",
4 "title": "X509Check collector configuration.",
5 "type": "object",
6 "properties": {
7 "update_every": {
8 "title": "Update every",
9 "description": "Data collection interval, measured in seconds.",
10 "type": "integer",
11 "minimum": 1,
12 "default": 1
13 },
14 "source": {
15 "title": "Certificate source",
16 "description": "The source of the certificate. Allowed schemes: https, tcp, tcp4, tcp6, udp, udp4, udp6, file, smtp.",
17 "type": "string"
18 },
19 "timeout": {
20 "title": "Timeout",
21 "description": "The timeout in seconds for the certificate retrieval.",
22 "type": "number",
23 "minimum": 0.5,
24 "default": 1
25 },
26 "check_full_chain": {
27 "title": "Full chain",
28 "description": "Monitor expiration time for all certificates in the SSL/TLS chain, including intermediate and root certificates.",
29 "type": "boolean"
30 },
31 "check_revocation_status": {
32 "title": "Revocation status",
33 "description": "Whether to check the revocation status of the certificate.",
34 "type": "boolean"
35 },
36 "vnode": {
37 "title": "Vnode",
38 "description": "Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes).",
39 "type": "string"
40 },
41 "tls_skip_verify": {
42 "title": "Skip TLS verification",
43 "description": "If set, TLS certificate verification will be skipped.",
44 "type": "boolean"
45 },
46 "tls_ca": {
47 "title": "TLS CA",
48 "description": "The path to the CA certificate file for TLS verification.",
49 "type": "string",
50 "pattern": "^$|^/"
51 },
52 "tls_cert": {
53 "title": "TLS certificate",
54 "description": "The path to the client certificate file for TLS authentication.",
55 "type": "string",
56 "pattern": "^$|^/"
57 },
58 "tls_key": {
59 "title": "TLS key",
60 "description": "The path to the client key file for TLS authentication.",
61 "type": "string",
62 "pattern": "^$|^/"
63 }
64 },
65 "required": [
66 "source"
67 ]
68 },
69 "uiSchema": {
70 "uiOptions": {
71 "fullPage": true
72 },
73 "vnode": {
74 "ui:placeholder": "To use this option, first create a Virtual Node and then reference its name here."
75 },
76 "source": {
77 "ui:placeholder": "https://example.com:443",
78 "ui:help": " Website: `https://domainName:443`. Local file: `file:///path/to/cert.pem`. SMTP: `smtp://smtp.example.com:587`."
79 },
80 "timeout": {
81 "ui:help": "Accepts decimals for precise control (e.g., type 1.5 for 1.5 seconds)."
82 },
83 "ui:flavour": "tabs",
84 "ui:options": {
85 "tabs": [
86 {
87 "title": "Base",
88 "fields": [
89 "update_every",
90 "source",
91 "timeout",
92 "check_full_chain",
93 "check_revocation_status",
94 "vnode"
95 ]
96 },
97 {
98 "title": "TLS",
99 "fields": [
100 "tls_skip_verify",
101 "tls_ca",
102 "tls_cert",
103 "tls_key"
104 ]
105 }
106 ]
107 }
108 }
109 }