mirrors/prometheus-operator
mirrors/prometheus-operator
1
0
Fork 0
mirror of https://github.com/prometheus-operator/prometheus-operator.git synced 2025-04-21 11:48:53 +00:00
Code Activity

Fixed typos in RemoteReadSpec comments

Browse source
This commit is contained in:
Keyvan Hedayati 2018-04-12 16:44:43 +04:30
parent aae5278218
commit 5a113987f6
4 changed files with 15 additions and 15 deletions
Documentation
api.md
example/prometheus-operator-crd
prometheus.crd.yaml
pkg/client/monitoring/v1
openapi_generated.gotypes.go

8
Documentation/api.md
View file

@ -265,12 +265,12 @@ RemoteReadSpec defines the remote_read configuration for prometheus.
| ----- | ----------- | ------ | -------- |
| url | The URL of the endpoint to send samples to. | string | true |
| requiredMatchers | An optional list of equality matchers which have to be present in a selector to query the remote read endpoint. | map[string]string | false |
| remoteTimeout | Timeout for requests to the remote write endpoint. | string | false |
| remoteTimeout | Timeout for requests to the remote read endpoint. | string | false |
| readRecent | Whether reads should be made for queries for time ranges that the local storage should have complete data for. | bool | false |
| basicAuth | BasicAuth for the URL. | *[BasicAuth](#basicauth) | false |
| bearerToken | bearer token for remote write. | string | false |
| bearerTokenFile | File to read bearer token for remote write. | string | false |
| tlsConfig | TLS Config to use for remote write. | *[TLSConfig](#tlsconfig) | false |
| bearerToken | bearer token for remote read. | string | false |
| bearerTokenFile | File to read bearer token for remote read. | string | false |
| tlsConfig | TLS Config to use for remote read. | *[TLSConfig](#tlsconfig) | false |
| proxyUrl | Optional ProxyURL | string | false |
[Back to TOC](#table-of-contents)

6
example/prometheus-operator-crd/prometheus.crd.yaml
View file

@ -1670,10 +1670,10 @@ spec:
required:
- key
bearerToken:
description: bearer token for remote write.
description: bearer token for remote read.
type: string
bearerTokenFile:
description: File to read bearer token for remote write.
description: File to read bearer token for remote read.
type: string
proxyUrl:
description: Optional ProxyURL
@ -1683,7 +1683,7 @@ spec:
ranges that the local storage should have complete data for.
type: boolean
remoteTimeout:
description: Timeout for requests to the remote write endpoint.
description: Timeout for requests to the remote read endpoint.
type: string
requiredMatchers:
description: An optional list of equality matchers which have

8
pkg/client/monitoring/v1/openapi_generated.go
View file

@ -1063,7 +1063,7 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
},
"remoteTimeout": {
SchemaProps: spec.SchemaProps{
Description: "Timeout for requests to the remote write endpoint.",
Description: "Timeout for requests to the remote read endpoint.",
Type: []string{"string"},
Format: "",
},
@ -1083,21 +1083,21 @@ func GetOpenAPIDefinitions(ref common.ReferenceCallback) map[string]common.OpenA
},
"bearerToken": {
SchemaProps: spec.SchemaProps{
Description: "bearer token for remote write.",
Description: "bearer token for remote read.",
Type: []string{"string"},
Format: "",
},
},
"bearerTokenFile": {
SchemaProps: spec.SchemaProps{
Description: "File to read bearer token for remote write.",
Description: "File to read bearer token for remote read.",
Type: []string{"string"},
Format: "",
},
},
"tlsConfig": {
SchemaProps: spec.SchemaProps{
Description: "TLS Config to use for remote write.",
Description: "TLS Config to use for remote read.",
Ref: ref("github.com/coreos/prometheus-operator/pkg/client/monitoring/v1.TLSConfig"),
},
},

8
pkg/client/monitoring/v1/types.go
View file

@ -213,18 +213,18 @@ type RemoteReadSpec struct {
//An optional list of equality matchers which have to be present
// in a selector to query the remote read endpoint.
RequiredMatchers map[string]string `json:"requiredMatchers,omitempty"`
//Timeout for requests to the remote write endpoint.
//Timeout for requests to the remote read endpoint.
RemoteTimeout string `json:"remoteTimeout,omitempty"`
//Whether reads should be made for queries for time ranges that
// the local storage should have complete data for.
ReadRecent bool `json:"readRecent,omitempty"`
//BasicAuth for the URL.
BasicAuth *BasicAuth `json:"basicAuth,omitempty"`
// bearer token for remote write.
// bearer token for remote read.
BearerToken string `json:"bearerToken,omitempty"`
// File to read bearer token for remote write.
// File to read bearer token for remote read.
BearerTokenFile string `json:"bearerTokenFile,omitempty"`
// TLS Config to use for remote write.
// TLS Config to use for remote read.
TLSConfig *TLSConfig `json:"tlsConfig,omitempty"`
//Optional ProxyURL
ProxyURL string `json:"proxyUrl,omitempty"`