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

Merge pull request from aknuds1/add-pvc-link

Browse source 
Add link to PersistentVolumeClaim reference
This commit is contained in:
Frederic Branczyk 2017-07-20 15:17:17 +02:00 • committed by GitHub
commit d260dbb728
4 changed files with 7 additions and 6 deletions
Documentation
api.md
Makefile
cmd/apidocgen
main.go
pkg/client/monitoring/v1alpha1
types.go

4
Documentation/api.md
View file

@ -6,7 +6,7 @@ This Document documents the types introduced by the Prometheus Operator to be co
## AlertingSpec
AlertingSpec defines paramters for alerting configuration of Prometheus servers.
AlertingSpec defines parameters for alerting configuration of Prometheus servers.
| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
@ -199,7 +199,7 @@ StorageSpec defines the configured storage for a group Prometheus servers.
| class | Name of the StorageClass to use when requesting storage provisioning. More info: https://kubernetes.io/docs/user-guide/persistent-volumes/#storageclasses DEPRECATED | string | true |
| selector | A label query over volumes to consider for binding. DEPRECATED | *[metav1.LabelSelector](https://kubernetes.io/docs/api-reference/v1.6/#labelselector-v1-meta) | true |
| resources | Resources represents the minimum resources the volume should have. More info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources DEPRECATED | [v1.ResourceRequirements](https://kubernetes.io/docs/api-reference/v1.6/#resourcerequirements-v1-core) | true |
| volumeClaimTemplate | Pvc A pvc spec to be used by the Prometheus statefulsets. | v1.PersistentVolumeClaim | false |
| volumeClaimTemplate | A PVC spec to be used by the Prometheus StatefulSets. | [v1.PersistentVolumeClaim](https://kubernetes.io/docs/api-reference/v1.6/#persistentvolumeclaim-v1-core) | false |
## TLSConfig

4
Makefile
View file

@ -52,8 +52,8 @@ apidocgen:
@go install github.com/coreos/prometheus-operator/cmd/apidocgen
docs: embedmd apidocgen
embedmd -w `find Documentation -name "*.md"`
apidocgen pkg/client/monitoring/v1alpha1/types.go > Documentation/api.md
$(GOPATH)/bin/embedmd -w `find Documentation -name "*.md"`
$(GOPATH)/bin/apidocgen pkg/client/monitoring/v1alpha1/types.go > Documentation/api.md
generate:
hack/generate.sh

1
cmd/apidocgen/main.go
View file

@ -42,6 +42,7 @@ var (
"v1.ResourceRequirements": "https://kubernetes.io/docs/api-reference/v1.6/#resourcerequirements-v1-core",
"v1.LocalObjectReference": "https://kubernetes.io/docs/api-reference/v1.6/#localobjectreference-v1-core",
"v1.SecretKeySelector": "https://kubernetes.io/docs/api-reference/v1.6/#secretkeyselector-v1-core",
"v1.PersistentVolumeClaim": "https://kubernetes.io/docs/api-reference/v1.6/#persistentvolumeclaim-v1-core",
}
selfLinks = map[string]string{}

4
pkg/client/monitoring/v1alpha1/types.go
View file

@ -125,7 +125,7 @@ type PrometheusStatus struct {
UnavailableReplicas int32 `json:"unavailableReplicas"`
}
// AlertingSpec defines paramters for alerting configuration of Prometheus servers.
// AlertingSpec defines parameters for alerting configuration of Prometheus servers.
type AlertingSpec struct {
// AlertmanagerEndpoints Prometheus should fire alerts against.
Alertmanagers []AlertmanagerEndpoints `json:"alertmanagers"`
@ -144,7 +144,7 @@ type StorageSpec struct {
// info: http://kubernetes.io/docs/user-guide/persistent-volumes#resources
// DEPRECATED
Resources v1.ResourceRequirements `json:"resources"`
// Pvc A pvc spec to be used by the Prometheus statefulsets.
// A PVC spec to be used by the Prometheus StatefulSets.
VolumeClaimTemplate v1.PersistentVolumeClaim `json:"volumeClaimTemplate,omitempty"`
}