Skip to content

docs(upgrade): document LogFileMetricExporter delete/recreate step for v5-to-v6 migration - #3356

Open
Clee2691 wants to merge 1 commit into
openshift:masterfrom
Clee2691:LOG-7821
Open

docs(upgrade): document LogFileMetricExporter delete/recreate step for v5-to-v6 migration#3356
Clee2691 wants to merge 1 commit into
openshift:masterfrom
Clee2691:LOG-7821

Conversation

@Clee2691

@Clee2691 Clee2691 commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

Description

This PR documents the processes needed to ensure that the LFME functions after an upgrade from Logging v5 to Logging v6.

/cc @vparfonov
/assign @jcantrill

Links

Summary by CodeRabbit

  • Documentation
    • Added upgrade guidance for clusters using the Log File Metric Exporter.
    • Documented the required pre-upgrade cleanup and post-upgrade recreation steps.
    • Added troubleshooting instructions for resolving exporter reconciliation errors after upgrading.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 6dbc7fc1-8681-42d8-b057-c4d57ad8c6d3

📥 Commits

Reviewing files that changed from the base of the PR and between ffb245b and 18ab3b1.

📒 Files selected for processing (1)
  • docs/administration/upgrade/v6.0_changes.adoc
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/administration/upgrade/v6.0_changes.adoc

📝 Walkthrough

Walkthrough

Changes

Logging 6.0 upgrade

Layer / File(s) Summary
Log File Metric Exporter upgrade workflow
docs/administration/upgrade/v6.0_changes.adoc
Documents deleting the exporter CR and DaemonSet before upgrading, recreating the CR afterward with the logging.openshift.io/v1alpha1 API, and deleting the DaemonSet if selector immutability causes a reconciler error.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: vparfonov

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: documenting the LFME delete/recreate step for the v5-to-v6 upgrade path.
Description check ✅ Passed The description includes the required summary, /cc, /assign, and a JIRA link, so it mostly satisfies the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/administration/upgrade/v6.0_changes.adoc`:
- Around line 97-123: Update the “Before Upgrading” procedure to make removal of
the logfilesmetricexporter DaemonSet an explicit prerequisite after deleting the
LogFileMetricExporter CR. Instruct administrators to verify the DaemonSet is
absent and use the documented oc delete daemonset command if it remains, before
recreating the CR; keep the existing post-upgrade guidance consistent.
- Around line 98-115: Update the LogFileMetricExporter recreation instructions
to preserve the existing v5 resource spec: have administrators save the current
spec before deletion and reapply it when recreating the CR. State that spec: {}
should be used only if the original resource had an empty spec.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 0ccfc178-6257-46fa-b398-0a48940311c7

📥 Commits

Reviewing files that changed from the base of the PR and between 6a2b724 and f10de43.

📒 Files selected for processing (1)
  • docs/administration/upgrade/v6.0_changes.adoc

Comment thread docs/administration/upgrade/v6.0_changes.adoc
Comment thread docs/administration/upgrade/v6.0_changes.adoc Outdated

@jcantrill jcantrill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/approve

@openshift-ci

openshift-ci Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Clee2691, jcantrill

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci Bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 21, 2026
@Clee2691
Clee2691 force-pushed the LOG-7821 branch 2 times, most recently from 7d2dd23 to ffb245b Compare July 21, 2026 14:35
@Clee2691

Copy link
Copy Markdown
Contributor Author

/retest

2 similar comments
@Clee2691

Copy link
Copy Markdown
Contributor Author

/retest

@jcantrill

Copy link
Copy Markdown
Contributor

/retest

@Clee2691

Copy link
Copy Markdown
Contributor Author

/cc @r2d2rnd

@openshift-ci
openshift-ci Bot requested a review from r2d2rnd July 22, 2026 19:05
@jcantrill

Copy link
Copy Markdown
Contributor

/override "Spell Checking"

@jcantrill

Copy link
Copy Markdown
Contributor

/lgtm

@openshift-ci

openshift-ci Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

@jcantrill: /override requires failed status contexts, check run or a prowjob name to operate on.
The following unknown contexts/checkruns were given:

  • Spell Checking

Only the following failed contexts/checkruns were expected:

  • CodeRabbit
  • Spell checking
  • ci/prow/ci-index-cluster-logging-operator-bundle
  • ci/prow/e2e-target
  • ci/prow/e2e-using-bundle
  • ci/prow/functional-target
  • ci/prow/images
  • ci/prow/lint
  • ci/prow/unit
  • pull-ci-openshift-cluster-logging-operator-master-ci-index-cluster-logging-operator-bundle
  • pull-ci-openshift-cluster-logging-operator-master-e2e-target
  • pull-ci-openshift-cluster-logging-operator-master-e2e-using-bundle
  • pull-ci-openshift-cluster-logging-operator-master-functional-target
  • pull-ci-openshift-cluster-logging-operator-master-images
  • pull-ci-openshift-cluster-logging-operator-master-lint
  • pull-ci-openshift-cluster-logging-operator-master-unit
  • tide

If you are trying to override a checkrun that has a space in it, you must put a double quote on the context.

Details

In response to this:

/override "Spell Checking"

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 openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Jul 24, 2026
@Clee2691

Copy link
Copy Markdown
Contributor Author

/retest

@openshift-ci

openshift-ci Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

@Clee2691: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-using-bundle ffb245b link false /test e2e-using-bundle

Full PR test history. Your PR dashboard.

Details

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.

oc delete logfilemetricexporters instance -n openshift-logging
----

.Verify the DaemonSet is absent

@r2d2rnd r2d2rnd Jul 28, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'd change the steps for being:

  1. Verify the Daemonset is absent
  oc get daemonset logfilesmetricexporter -n openshift-logging
  1. Backup it
  oc get daemonset logfilesmetricexporter -n openshift-logging -o yaml > logfilemetricsexporter.yaml
  1. Delete it
oc delete daemonset logfilesmetricexporter -n openshift-logging 
  1. Recreate it....

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The point of doing the second command is IF the daemonset still exists, then delete it. If both these steps are combined then there is no need to verify first, just delete instead. I am inclined to leave it as is.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hello @Clee2691 ,

I'm not combinating any step, in fact, I'm adding the backup step, the 2 before deleting it

@Clee2691 Clee2691 Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@r2d2rnd Oh I was seeing the original comment. I see the edited one now.

Instead of backing up the daemonset, we should be backing up the LFME CR before deleting it. We want the CLO to reconcile the daemonset here.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@Clee2691 be aware that I should expect to have this step incorporated to the Upgrade documentation [0] as a sorted (numbered step) as it's in the KCS [1]

[0] https://docs.redhat.com/en/documentation/red_hat_openshift_logging/6.4/html/upgrading_logging/upgrading-to-logging-6
[1] https://access.redhat.com/articles/7089860

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Please raise this as a documentation bug/feature in the appropriate JIRA project

@r2d2rnd r2d2rnd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request review from 2026-07-28

@openshift-ci openshift-ci Bot removed the lgtm Indicates that a PR is ready to be merged. label Jul 29, 2026
@openshift-ci

openshift-ci Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

New changes are detected. LGTM label has been removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants