Skip to content

Commit

Permalink
chore(operator): fix API documentation relative to OTEL
Browse files Browse the repository at this point in the history
  • Loading branch information
@JoaoBraveCoding
JoaoBraveCoding committed Sep 24, 2024
1 parent 758364c commit b7b6871
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 26 deletions.
6 changes: 3 additions & 3 deletions operator/apis/loki/v1/lokistack_types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -887,7 +887,7 @@ type OTLPResourceAttributesSpec struct {
// tenants.
type GlobalOTLPSpec struct {
// IndexedResourceAttributes contains the global configuration for resource attributes
// to store them as index labels or structured metadata or drop them altogether.
// to store them as index labels.
//
// +optional
// +kubebuilder:validation:Optional
Expand All @@ -909,15 +909,15 @@ type OTLPSpec struct {
ResourceAttributes *OTLPResourceAttributesSpec `json:"resourceAttributes,omitempty"`

// ScopeAttributes contains the configuration for scope attributes
// to store them as index labels or structured metadata or drop them altogether.
// to store them as structured metadata or drop them altogether.
//
// +optional
// +kubebuilder:validation:Optional
// +operator-sdk:csv:customresourcedefinitions:type=spec,displayName="Scope Attributes"
ScopeAttributes []OTLPAttributesSpec `json:"scopeAttributes,omitempty"`

// LogAttributes contains the configuration for log attributes
// to store them as index labels or structured metadata or drop them altogether.
// to store them as structured metadata or drop them altogether.
//
// +optional
// +kubebuilder:validation:Optional
Expand Down
13 changes: 6 additions & 7 deletions operator/bundle/community/manifests/loki-operator.clusterserviceversion.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ metadata:
categories: OpenShift Optional, Logging & Tracing
certified: "false"
containerImage: docker.io/grafana/loki-operator:0.6.2
createdAt: "2024-09-09T09:16:56Z"
createdAt: "2024-09-24T16:09:54Z"
description: The Community Loki Operator provides Kubernetes native deployment
and management of Loki and related logging components.
operators.operatorframework.io/builder: operator-sdk-unknown
Expand Down Expand Up @@ -355,12 +355,11 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: IndexedResourceAttributes contains the global configuration for
resource attributes to store them as index labels or structured metadata
or drop them altogether.
resource attributes to store them as index labels.
displayName: Indexed Resource Attributes
path: limits.global.otlp.indexedResourceAttributes
- description: LogAttributes contains the configuration for log attributes to
store them as index labels or structured metadata or drop them altogether.
store them as structured metadata or drop them altogether.
displayName: Log Attributes
path: limits.global.otlp.logAttributes
- description: Action defines the indexing action for the selected attributes.
Expand Down Expand Up @@ -401,7 +400,7 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- description: ScopeAttributes contains the configuration for scope attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
displayName: Scope Attributes
path: limits.global.otlp.scopeAttributes
- description: Action defines the indexing action for the selected attributes.
Expand Down Expand Up @@ -511,7 +510,7 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: LogAttributes contains the configuration for log attributes to
store them as index labels or structured metadata or drop them altogether.
store them as structured metadata or drop them altogether.
displayName: Log Attributes
path: limits.tenants.otlp.logAttributes
- description: Action defines the indexing action for the selected attributes.
Expand Down Expand Up @@ -552,7 +551,7 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- description: ScopeAttributes contains the configuration for scope attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
displayName: Scope Attributes
path: limits.tenants.otlp.scopeAttributes
- description: Action defines the indexing action for the selected attributes.
Expand Down
10 changes: 5 additions & 5 deletions operator/bundle/community/manifests/loki.grafana.com_lokistacks.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,14 @@ spec:
indexedResourceAttributes:
description: |-
IndexedResourceAttributes contains the global configuration for resource attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as index labels.
items:
type: string
type: array
logAttributes:
description: |-
LogAttributes contains the configuration for log attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
items:
description: |-
OTLPAttributesSpec contains the configuration for a set of attributes
Expand Down Expand Up @@ -256,7 +256,7 @@ spec:
scopeAttributes:
description: |-
ScopeAttributes contains the configuration for scope attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
items:
description: |-
OTLPAttributesSpec contains the configuration for a set of attributes
Expand Down Expand Up @@ -437,7 +437,7 @@ spec:
logAttributes:
description: |-
LogAttributes contains the configuration for log attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
items:
description: |-
OTLPAttributesSpec contains the configuration for a set of attributes
Expand Down Expand Up @@ -513,7 +513,7 @@ spec:
scopeAttributes:
description: |-
ScopeAttributes contains the configuration for scope attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
items:
description: |-
OTLPAttributesSpec contains the configuration for a set of attributes
Expand Down
10 changes: 5 additions & 5 deletions operator/config/crd/bases/loki.grafana.com_lokistacks.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,14 @@ spec:
indexedResourceAttributes:
description: |-
IndexedResourceAttributes contains the global configuration for resource attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as index labels.
items:
type: string
type: array
logAttributes:
description: |-
LogAttributes contains the configuration for log attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
items:
description: |-
OTLPAttributesSpec contains the configuration for a set of attributes
Expand Down Expand Up @@ -238,7 +238,7 @@ spec:
scopeAttributes:
description: |-
ScopeAttributes contains the configuration for scope attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
items:
description: |-
OTLPAttributesSpec contains the configuration for a set of attributes
Expand Down Expand Up @@ -419,7 +419,7 @@ spec:
logAttributes:
description: |-
LogAttributes contains the configuration for log attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
items:
description: |-
OTLPAttributesSpec contains the configuration for a set of attributes
Expand Down Expand Up @@ -495,7 +495,7 @@ spec:
scopeAttributes:
description: |-
ScopeAttributes contains the configuration for scope attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
items:
description: |-
OTLPAttributesSpec contains the configuration for a set of attributes
Expand Down
11 changes: 5 additions & 6 deletions operator/config/manifests/community/bases/loki-operator.clusterserviceversion.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -268,12 +268,11 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: IndexedResourceAttributes contains the global configuration for
resource attributes to store them as index labels or structured metadata
or drop them altogether.
resource attributes to store them as index labels.
displayName: Indexed Resource Attributes
path: limits.global.otlp.indexedResourceAttributes
- description: LogAttributes contains the configuration for log attributes to
store them as index labels or structured metadata or drop them altogether.
store them as structured metadata or drop them altogether.
displayName: Log Attributes
path: limits.global.otlp.logAttributes
- description: Action defines the indexing action for the selected attributes.
Expand Down Expand Up @@ -314,7 +313,7 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- description: ScopeAttributes contains the configuration for scope attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
displayName: Scope Attributes
path: limits.global.otlp.scopeAttributes
- description: Action defines the indexing action for the selected attributes.
Expand Down Expand Up @@ -424,7 +423,7 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:number
- description: LogAttributes contains the configuration for log attributes to
store them as index labels or structured metadata or drop them altogether.
store them as structured metadata or drop them altogether.
displayName: Log Attributes
path: limits.tenants.otlp.logAttributes
- description: Action defines the indexing action for the selected attributes.
Expand Down Expand Up @@ -465,7 +464,7 @@ spec:
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:booleanSwitch
- description: ScopeAttributes contains the configuration for scope attributes
to store them as index labels or structured metadata or drop them altogether.
to store them as structured metadata or drop them altogether.
displayName: Scope Attributes
path: limits.tenants.otlp.scopeAttributes
- description: Action defines the indexing action for the selected attributes.
Expand Down

0 comments on commit b7b6871

Please sign in to comment.