Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(operator): fix API documentation relative to OTEL #14246

Merged
merged 1 commit into from
Sep 25, 2024
Merged

chore(operator): fix API documentation relative to OTEL #14246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions operator/apis/loki/v1/lokistack_types.go
View file
Open in desktop
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-openshift/manifests/loki-operator.clusterserviceversion.yaml
View file
Open in desktop
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:58Z"
createdAt: "2024-09-25T09:56:42Z"
description: The Community Loki Operator provides Kubernetes native deployment
and management of Loki and related logging components.
features.operators.openshift.io/disconnected: "true"
Expand Down Expand Up @@ -362,12 +362,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 @@ -408,7 +407,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 @@ -518,7 +517,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 @@ -559,7 +558,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-openshift/manifests/loki.grafana.com_lokistacks.yaml
View file
Open in desktop
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
13 changes: 6 additions & 7 deletions operator/bundle/community/manifests/loki-operator.clusterserviceversion.yaml
View file
Open in desktop
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-25T09:56:40Z"
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
Open in desktop
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
13 changes: 6 additions & 7 deletions operator/bundle/openshift/manifests/loki-operator.clusterserviceversion.yaml
View file
Open in desktop
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: quay.io/openshift-logging/loki-operator:0.1.0
createdAt: "2024-09-09T09:17:00Z"
createdAt: "2024-09-25T09:56:44Z"
description: |
The Loki Operator for OCP provides a means for configuring and managing a Loki stack for cluster logging.
## Prerequisites and Requirements
Expand Down Expand Up @@ -375,12 +375,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 @@ -421,7 +420,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 @@ -531,7 +530,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 @@ -572,7 +571,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/openshift/manifests/loki.grafana.com_lokistacks.yaml
View file
Open in desktop
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
Loading
Loading