OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #94423

theashiot · 2025-06-09T10:30:02Z

Version(s): 6.0+

Issue: https://issues.redhat.com/browse/OBSDOCS-1726

Link to docs preview: https://94423--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html

QE review:

QE has approved this change.

Additional information: To be cherry-picked to: standalone-logging-docs-6.3, standalone-logging-docs-6.2, standalone-logging-docs-6.1, standalone-logging-docs-6.0

openshift-ci-robot · 2025-06-09T10:30:06Z

@theashiot: This pull request references OBSDOCS-1726 which is a valid jira issue.

In response to this:

Version(s): 6.0+

Issue: https://issues.redhat.com/browse/OBSDOCS-1726

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2025-06-09T10:38:48Z

🤖 Tue Jun 17 15:06:21 - Prow CI generated the docs preview:

https://94423--ocpdocs-pr.netlify.app/
https://94423--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html

JoaoBraveCoding

The "Deploying a Loki log store on a cluster that uses short-term credentials" section contains duplicated information from the "Install Log Store" that should be removed.

theashiot · 2025-06-11T20:15:36Z

The "Deploying a Loki log store on a cluster that uses short-term credentials" section contains duplicated information from the "Install Log Store" that should be removed.

removed

JoaoBraveCoding · 2025-06-12T11:32:41Z

/lgtm

theashiot · 2025-06-12T15:32:00Z

Thanks, @JoaoBraveCoding!

theashiot · 2025-06-12T15:34:18Z

Hi @anpingli, @kabirbhartiRH, @QiaolingTang, can you please provide a QE review for the changes?

thanks,
ashwin

kabirbhartiRH · 2025-06-16T18:22:19Z

/lgtm

theashiot · 2025-06-16T18:24:55Z

Thanks, @kabirbhartiRH!

openshift-ci-robot · 2025-06-16T18:25:05Z

@theashiot: This pull request references OBSDOCS-1726 which is a valid jira issue.

In response to this:

Version(s): 6.0+

Issue: https://issues.redhat.com/browse/OBSDOCS-1726

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

theashiot · 2025-06-16T18:25:17Z

/label peer-review-required

openshift-ci · 2025-06-16T18:25:21Z

@theashiot: The label(s) /label peer-review-required cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, ux-approved, no-qe, downstream-change-needed, rebase/manual, cluster-config-api-changed, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, cloud-experts, cnv, dev-tools, distributed-tracing, ims, jira/valid-bug, merge-review-in-progress, merge-review-needed, mtc, multi-arch, oadp, peer-review-done, peer-review-in-progress, peer-review-needed, rhacs, rhv, sd-docs, serverless, service-mesh, sme-review-done, sme-review-needed, stability-fix-approved, staff-eng-approved, telco. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

In response to this:

/label peer-review-required

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

theashiot · 2025-06-16T18:25:33Z

/label peer-review-needed

jeana-redhat

Nice migration! A couple issues I would address in the ccoctl intro, and otherwise just some docs plumbing that should accompany this type of work

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

jeana-redhat · 2025-06-16T18:37:48Z

configuring/configuring-the-log-store.adoc

+[id="installing-log-storage-loki-sts"]
+=== Deploying a Loki log store on a cluster that uses short-term credentials
+
+For some storage providers, you can use the CCO utility (`ccoctl`) during installation to implement short-term credentials. These credentials are created and managed outside the {ocp-product-title} cluster. link:https://docs.openshift.com/container-platform/latest/authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc#cco-short-term-creds[Manual mode with short-term credentials for components].


Suggested change

For some storage providers, you can use the CCO utility (`ccoctl`) during installation to implement short-term credentials. These credentials are created and managed outside the {ocp-product-title} cluster. link:https://docs.openshift.com/container-platform/latest/authentication/managing_cloud_provider_credentials/cco-short-term-creds.adoc#cco-short-term-creds[Manual mode with short-term credentials for components].

For some storage providers, you can use the Cloud Credential Operator utility (`ccoctl`) during installation to implement short-term credentials. These credentials are created and managed outside the {ocp-product-title} cluster. For more information, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.18/html/authentication_and_authorization/managing-cloud-provider-credentials#cco-short-term-creds[Manual mode with short-term credentials for components].

jeana-redhat · 2025-06-16T18:40:42Z

configuring/configuring-the-log-store.adoc

Every module in this assembly should be updated to have the assembly listed under

// Module included in the following assemblies:

And if they are no longer included in e.g. configuring/configuring-lokistack-storage.adoc, that line should be removed from the list

thanks, I know that's a pain!

openshift-ci · 2025-06-16T20:05:09Z

New changes are detected. LGTM label has been removed.

theashiot · 2025-06-17T07:33:17Z

Thanks, @jeana-redhat for the review!

best,
ashwin

theashiot · 2025-06-17T07:33:48Z

/label merge-review-needed

openshift-ci-robot · 2025-06-17T07:36:29Z

@theashiot: This pull request references OBSDOCS-1726 which is a valid jira issue.

In response to this:

Version(s): 6.0+

Issue: https://issues.redhat.com/browse/OBSDOCS-1726

Link to docs preview: https://94423--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-the-log-store.html

QE review:

QE has approved this change.

Additional information: To be cherry-picked to: standalone-logging-docs-6.3, standalone-logging-docs-6.2, standalone-logging-docs-6.1, standalone-logging-docs-6.0

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

kcarmichael08

Looks good, but I would fix the filename in the metadata just to avoid future confusion.

kcarmichael08 · 2025-06-17T12:38:16Z

modules/logging-create-loki-cr-console.adoc

 //
-// * logging/log_storage/installing-log-storage.adoc
+// * configuring/configuring-the-log-storage.adoc


looks like filename is configuring-the-log-store and not configuring-the-log-storage? Not a big deal but could be confusing for someone unfamiliar with the docs so I would fix this in the modules.

….y docs

openshift-ci · 2025-06-17T15:07:21Z

@theashiot: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

theashiot · 2025-06-17T15:30:43Z

Thanks, @kcarmichael08 for the review! I've updated the file name in all the relevant modules.

kcarmichael08 · 2025-06-17T19:03:36Z

/cherrypick standalone-logging-docs-6.3

kcarmichael08 · 2025-06-17T19:03:55Z

/cherrypick standalone-logging-docs-6.2

kcarmichael08 · 2025-06-17T19:04:04Z

standalone-logging-docs-6.1

kcarmichael08 · 2025-06-17T19:04:19Z

/cherrypick standalone-logging-docs-6.1

openshift-cherrypick-robot · 2025-06-17T19:04:24Z

@kcarmichael08: new pull request created: #94860

In response to this:

/cherrypick standalone-logging-docs-6.3

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

kcarmichael08 · 2025-06-17T19:04:30Z

/cherrypick standalone-logging-docs-6.0

openshift-cherrypick-robot · 2025-06-17T19:04:43Z

@kcarmichael08: new pull request created: #94861

In response to this:

/cherrypick standalone-logging-docs-6.2

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2025-06-17T19:05:04Z

@kcarmichael08: #94423 failed to apply on top of branch "standalone-logging-docs-6.1":

Applying: OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6.y docs
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	configuring/configuring-lokistack-storage.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): configuring/configuring-lokistack-storage.adoc deleted in OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6.y docs and modified in HEAD. Version HEAD of configuring/configuring-lokistack-storage.adoc left in tree.
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6.y docs

In response to this:

/cherrypick standalone-logging-docs-6.1

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2025-06-17T19:05:13Z

@kcarmichael08: #94423 failed to apply on top of branch "standalone-logging-docs-6.0":

Applying: OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6.y docs
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	configuring/configuring-lokistack-storage.adoc
M	modules/loki-retention.adoc
A	modules/loki-sizing.adoc
M	modules/loki-zone-fail-recovery.adoc
Falling back to patching base and 3-way merge...
Auto-merging modules/loki-zone-fail-recovery.adoc
CONFLICT (content): Merge conflict in modules/loki-zone-fail-recovery.adoc
Auto-merging modules/loki-retention.adoc
Auto-merging modules/loki-deployment-sizing.adoc
CONFLICT (content): Merge conflict in modules/loki-deployment-sizing.adoc
CONFLICT (modify/delete): configuring/configuring-lokistack-storage.adoc deleted in OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6.y docs and modified in HEAD. Version HEAD of configuring/configuring-lokistack-storage.adoc left in tree.
Auto-merging _topic_maps/_topic_map.yml
CONFLICT (content): Merge conflict in _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6.y docs

In response to this:

/cherrypick standalone-logging-docs-6.0

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jun 9, 2025

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 9, 2025

JoaoBraveCoding reviewed Jun 9, 2025

View reviewed changes

theashiot force-pushed the OBSDOCS-1726-standalone branch from 139fe88 to dae433a Compare June 11, 2025 20:15

openshift-ci bot assigned JoaoBraveCoding Jun 12, 2025

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Jun 12, 2025

openshift-ci bot assigned kabirbhartiRH Jun 16, 2025

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Jun 16, 2025

jeana-redhat added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Jun 16, 2025

jeana-redhat reviewed Jun 16, 2025

View reviewed changes

openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Jun 16, 2025

theashiot force-pushed the OBSDOCS-1726-standalone branch from dae433a to 52d65a2 Compare June 16, 2025 20:05

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jun 16, 2025

theashiot force-pushed the OBSDOCS-1726-standalone branch 2 times, most recently from 0217378 to 67889fe Compare June 16, 2025 20:23

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Jun 17, 2025

kcarmichael08 added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Jun 17, 2025

kcarmichael08 reviewed Jun 17, 2025

View reviewed changes

kcarmichael08 removed the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Jun 17, 2025

OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6…

61a696a

….y docs

theashiot force-pushed the OBSDOCS-1726-standalone branch from 67889fe to 61a696a Compare June 17, 2025 14:59

kcarmichael08 added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Jun 17, 2025

kcarmichael08 merged commit b5f1ebe into openshift:standalone-logging-docs-main Jun 17, 2025
2 checks passed

openshift-cherrypick-robot mentioned this pull request Jun 17, 2025

[standalone-logging-docs-6.3] OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #94860

Merged

openshift-cherrypick-robot mentioned this pull request Jun 17, 2025

[standalone-logging-docs-6.2] OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #94861

Merged

This was referenced Jun 20, 2025

OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #95026

Closed

OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #95027

Open

OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #95028

Open

OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #94423

OBSDOCS-1726: Port the "Installing log storage" sections to 5.8 and 6… #94423

Uh oh!

Conversation

theashiot commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Jun 9, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

JoaoBraveCoding left a comment

Choose a reason for hiding this comment

Uh oh!

theashiot commented Jun 11, 2025

Uh oh!

JoaoBraveCoding commented Jun 12, 2025

Uh oh!

theashiot commented Jun 12, 2025

Uh oh!

theashiot commented Jun 12, 2025

Uh oh!

kabirbhartiRH commented Jun 16, 2025

Uh oh!

theashiot commented Jun 16, 2025

Uh oh!

openshift-ci-robot commented Jun 16, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

theashiot commented Jun 16, 2025

Uh oh!

openshift-ci bot commented Jun 16, 2025

Uh oh!

theashiot commented Jun 16, 2025

Uh oh!

jeana-redhat left a comment

Choose a reason for hiding this comment

Uh oh!

jeana-redhat Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

theashiot Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

jeana-redhat Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

theashiot Jun 16, 2025

Choose a reason for hiding this comment

Uh oh!

jeana-redhat Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Jun 16, 2025

Uh oh!

theashiot commented Jun 17, 2025

Uh oh!

theashiot commented Jun 17, 2025

Uh oh!

openshift-ci-robot commented Jun 17, 2025 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kcarmichael08 left a comment

Choose a reason for hiding this comment

Uh oh!

kcarmichael08 Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

theashiot Jun 17, 2025

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Jun 17, 2025

Uh oh!

theashiot commented Jun 17, 2025

Uh oh!

Uh oh!

kcarmichael08 commented Jun 17, 2025

Uh oh!

theashiot commented Jun 9, 2025 •

edited

Loading

openshift-ci-robot commented Jun 9, 2025 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Jun 9, 2025 •

edited

Loading

openshift-ci-robot commented Jun 16, 2025 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jun 17, 2025 •

edited by openshift-ci bot

Loading