Documentation

Platform
v1
The upmeter module: Custom Resources

The upmeter module: Custom Resources

You are viewing the documentation for an unreleased version of Deckhouse. You may choose the appropriate release channel from the versions menu or go to the latest stable Deckhouse version.

Downtime

Scope: Cluster
Version: v1alpha1

Downtime incident records

spec
array of objects
Required value
- spec.affected
  array of strings
  A list of affected groups.
- spec.description
  string
  Human readable incident information.
- spec.endDate
  string
  End of downtime (Unix time or RFC3339 date 2020-09-07T17:24:55Z).
- spec.startDate
  string
  Start of downtime (Unix time or RFC3339 date 2020-09-07T17:24:55Z).
- spec.type
  string
  Type of downtime incident.
  
  Allowed values: Accident, Maintenance, InfrastructureMaintenance, InfrastructureAccident

UpmeterHookProbe

Scope: Cluster
Version: v1

Upmeter CRD for deckhouse-configuration probe.

spec
object
Required value
- spec.inited
  string
  Required value
  The initial value set by upmeter agent
- spec.mirror
  string
  Required value
  The mirrored value set by hook

UpmeterRemoteWrite

Scope: Cluster

Upmeter remote_write configuration.

spec
object
Required value
- spec.additionalLabels
  object
  Additional labels to add to all metrics.
- spec.config
  object
  Required value
  Config defines the remote_write configuration for Prometheus.
  - spec.config.basicAuth
    object
    BasicAuth for the URL.
    - spec.config.basicAuth.password
      string
      Required value
      The password for authentication.
    - spec.config.basicAuth.username
      string
      Required value
      The username for authentication.
  - spec.config.bearerToken
    string
    Bearer token.
  - spec.config.tlsConfig
    object
    TLS Config to use for remote write.
    - spec.config.tlsConfig.ca
      string
      The CA certificate used when verifying the API server certificate.
      
      Default: ""
    - spec.config.tlsConfig.insecureSkipVerify
      boolean
      Disable target certificate validation.
      
      Default: false
  - spec.config.url
    string
    Required value
    The URL of the endpoint to send samples to.
- spec.intervalSeconds
  number
  The size of timeslot to send.
  
  Default: 300
  Allowed values: 30, 300

Upmeter remote_write configuration.

spec
object
Required value
- spec.additionalLabels
  object
  Additional labels to add to all metrics.
- spec.config
  object
  Required value
  Config defines the remote_write configuration for Prometheus.
  - spec.config.basicAuth
    object
    BasicAuth for the URL.
    - spec.config.basicAuth.password
      string
      Required value
      The password for authentication.
    - spec.config.basicAuth.username
      string
      Required value
      The username for authentication.
  - spec.config.bearerToken
    string
    Bearer token.
  - spec.config.tlsConfig
    object
    TLS Config to use for remote write.
    - spec.config.tlsConfig.ca
      string
      The CA certificate used when verifying the API server certificate.
      
      Default: ""
    - spec.config.tlsConfig.insecureSkipVerify
      boolean
      Disable target certificate validation.
      
      Default: false
  - spec.config.url
    string
    Required value
    The URL of the endpoint to send samples to.
- spec.intervalSeconds
  number
  The size of timeslot to send.
  
  Default: 300
  Allowed values: 30, 300