Custom Kube API target Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/prometheusBlackboxExporter/properties/customKubeapiTargets/items
Custom Kube API target Prometheus Blackbox Exporter should probe.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (Custom Kube API target)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| name | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| domain | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
name¶
name
-
is optional
-
Type:
string(Custom Kube API Target Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Custom Kube API Target Name)
domain¶
domain
-
is optional
-
Type:
string(Custom Kube API Target Domain) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Custom Kube API Target Domain)
CONSTRAINTS:
hostname: the string must be a hostname, according to RFC 1123, section 2.1
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main