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

fix(operator): Improve API documentation for schema version #13122

Merged
merged 2 commits into from
Jun 4, 2024
Merged

fix(operator): Improve API documentation for schema version #13122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c497838
fix(operator): Improve API documentation for schema version
xperimental Jun 4, 2024
b18bc73
Update api.md
xperimental Jun 4, 2024
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
12 changes: 7 additions & 5 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 @@ -556,8 +556,7 @@ const (
ObjectStorageSchemaV13 ObjectStorageSchemaVersion = "v13"
)

// ObjectStorageSchema defines the requirements needed to configure a new
// storage schema.
// ObjectStorageSchema defines a schema version and the date when it will become effective.
type ObjectStorageSchema struct {
// Version for writing and reading logs.
//
Expand All @@ -566,9 +565,12 @@ type ObjectStorageSchema struct {
// +operator-sdk:csv:customresourcedefinitions:type=spec,xDescriptors={"urn:alm:descriptor:com.tectonic.ui:select:v11","urn:alm:descriptor:com.tectonic.ui:select:v12","urn:alm:descriptor:com.tectonic.ui:select:v13"},displayName="Version"
Version ObjectStorageSchemaVersion `json:"version"`

// EffectiveDate is the date in UTC that the schema will be applied on.
// To ensure readibility of logs, this date should be before the current
// date in UTC.
// EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.
//
// The configuration always needs at least one schema that is currently valid. This means that when creating a new
// LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xperimental perhaps instead of

LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday". by

LokiStack it is recommended to add a schema with the latest available version and it should have an effective date of "yesterday".?

For being clear that the "recommended" is only for the schema version, but for the effective date, it should/must from yesterday for new installations

// New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
// using it once the day rolls over.
//
// +required
// +kubebuilder:validation:Required
Expand Down
2 changes: 1 addition & 1 deletion 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.1
createdAt: "2024-06-03T10:01:23Z"
createdAt: "2024-06-04T16:17:47Z"
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
30 changes: 18 additions & 12 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 @@ -598,15 +598,18 @@ spec:
version: v11
description: Schemas for reading and writing logs.
items:
description: |-
ObjectStorageSchema defines the requirements needed to configure a new
storage schema.
description: ObjectStorageSchema defines a schema version and
the date when it will become effective.
properties:
effectiveDate:
description: |-
EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.
EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.


The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
using it once the day rolls over.
pattern: ^([0-9]{4,})([-]([0-9]{2})){2}$
type: string
version:
Expand Down Expand Up @@ -3826,15 +3829,18 @@ spec:
Schemas is a list of schemas which have been applied
to the LokiStack.
items:
description: |-
ObjectStorageSchema defines the requirements needed to configure a new
storage schema.
description: ObjectStorageSchema defines a schema version and
the date when it will become effective.
properties:
effectiveDate:
description: |-
EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.
EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.


The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
using it once the day rolls over.
pattern: ^([0-9]{4,})([-]([0-9]{2})){2}$
type: string
version:
Expand Down
2 changes: 1 addition & 1 deletion 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.1
createdAt: "2024-06-03T10:01:22Z"
createdAt: "2024-06-04T16:17:41Z"
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
30 changes: 18 additions & 12 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 @@ -598,15 +598,18 @@ spec:
version: v11
description: Schemas for reading and writing logs.
items:
description: |-
ObjectStorageSchema defines the requirements needed to configure a new
storage schema.
description: ObjectStorageSchema defines a schema version and
the date when it will become effective.
properties:
effectiveDate:
description: |-
EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.
EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.


The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
using it once the day rolls over.
pattern: ^([0-9]{4,})([-]([0-9]{2})){2}$
type: string
version:
Expand Down Expand Up @@ -3826,15 +3829,18 @@ spec:
Schemas is a list of schemas which have been applied
to the LokiStack.
items:
description: |-
ObjectStorageSchema defines the requirements needed to configure a new
storage schema.
description: ObjectStorageSchema defines a schema version and
the date when it will become effective.
properties:
effectiveDate:
description: |-
EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.
EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.


The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
using it once the day rolls over.
pattern: ^([0-9]{4,})([-]([0-9]{2})){2}$
type: string
version:
Expand Down
2 changes: 1 addition & 1 deletion 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-06-03T10:01:25Z"
createdAt: "2024-06-04T16:17:54Z"
description: |
The Loki Operator for OCP provides a means for configuring and managing a Loki stack for cluster logging.
## Prerequisites and Requirements
Expand Down
30 changes: 18 additions & 12 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 @@ -598,15 +598,18 @@ spec:
version: v11
description: Schemas for reading and writing logs.
items:
description: |-
ObjectStorageSchema defines the requirements needed to configure a new
storage schema.
description: ObjectStorageSchema defines a schema version and
the date when it will become effective.
properties:
effectiveDate:
description: |-
EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.
EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.


The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
using it once the day rolls over.
pattern: ^([0-9]{4,})([-]([0-9]{2})){2}$
type: string
version:
Expand Down Expand Up @@ -3826,15 +3829,18 @@ spec:
Schemas is a list of schemas which have been applied
to the LokiStack.
items:
description: |-
ObjectStorageSchema defines the requirements needed to configure a new
storage schema.
description: ObjectStorageSchema defines a schema version and
the date when it will become effective.
properties:
effectiveDate:
description: |-
EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.
EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.


The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
using it once the day rolls over.
pattern: ^([0-9]{4,})([-]([0-9]{2})){2}$
type: string
version:
Expand Down
30 changes: 18 additions & 12 deletions operator/config/crd/bases/loki.grafana.com_lokistacks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,15 +580,18 @@ spec:
version: v11
description: Schemas for reading and writing logs.
items:
description: |-
ObjectStorageSchema defines the requirements needed to configure a new
storage schema.
description: ObjectStorageSchema defines a schema version and
the date when it will become effective.
properties:
effectiveDate:
description: |-
EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.
EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.


The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
using it once the day rolls over.
pattern: ^([0-9]{4,})([-]([0-9]{2})){2}$
type: string
version:
Expand Down Expand Up @@ -3808,15 +3811,18 @@ spec:
Schemas is a list of schemas which have been applied
to the LokiStack.
items:
description: |-
ObjectStorageSchema defines the requirements needed to configure a new
storage schema.
description: ObjectStorageSchema defines a schema version and
the date when it will become effective.
properties:
effectiveDate:
description: |-
EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.
EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.


The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of "yesterday".
New schema versions added to the configuration always needs to be placed "in the future", so that Loki can start
using it once the day rolls over.
pattern: ^([0-9]{4,})([-]([0-9]{2})){2}$
type: string
version:
Expand Down
11 changes: 6 additions & 5 deletions operator/docs/operator/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2594,8 +2594,7 @@ string
(<em>Appears on:</em><a href="#loki-grafana-com-v1-LokiStackStorageStatus">LokiStackStorageStatus</a>, <a href="#loki-grafana-com-v1-ObjectStorageSpec">ObjectStorageSpec</a>)
</p>
<div>
<p>ObjectStorageSchema defines the requirements needed to configure a new
storage schema.</p>
<p>ObjectStorageSchema defines a schema version and the date when it will become effective.</p>
</div>
<table>
<thead>
Expand Down Expand Up @@ -2628,9 +2627,11 @@ StorageSchemaEffectiveDate
</em>
</td>
<td>
<p>EffectiveDate is the date in UTC that the schema will be applied on.
To ensure readibility of logs, this date should be before the current
date in UTC.</p>
<p>EffectiveDate contains a date in YYYY-MM-DD format which is interpreted in the UTC time zone.</p>
<p>The configuration always needs at least one schema that is currently valid. This means that when creating a new
LokiStack it is recommended to add a schema with the latest available version and an effective date of &ldquo;yesterday&rdquo;.
New schema versions added to the configuration always needs to be placed &ldquo;in the future&rdquo;, so that Loki can start
using it once the day rolls over.</p>
</td>
</tr>
</tbody>
Expand Down
Loading