openshift-kni / lifecycle-agent

Local agent for orchestration of SNO Image Based Upgrade
Apache License 2.0
6 stars 28 forks source link

OCPBUGS-32495: prep stage doc updates and unify logs and naming #517

Closed pixelsoccupied closed 4 months ago

pixelsoccupied commented 4 months ago

Background / Context

This PR finalizes the work related Prep stage resiliency with docs + log messages + uniform naming convention

Things to note:

Ref: https://github.com/openshift-kni/lifecycle-agent/pull/476 https://github.com/openshift-kni/lifecycle-agent/pull/498

/cc @donpenney @Missxiaoguo

pixelsoccupied commented 4 months ago

/hold until https://github.com/openshift-kni/lifecycle-agent/pull/498

openshift-ci-robot commented 4 months ago

@pixelsoccupied: This pull request references Jira Issue OCPBUGS-32495, which is invalid:

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to [this](https://github.com/openshift-kni/lifecycle-agent/pull/517): ># Background / Context > >This PR finalizes the work related Prep stage resiliency with docs + log messages + uniform naming convention > >Removed precache plugin md file as they were mostly focused on dev (all which are already in .go file) and/or outdated. > >https://github.com/openshift-kni/lifecycle-agent/pull/476 >https://github.com/openshift-kni/lifecycle-agent/pull/498 > >/cc @donpenney @Missxiaoguo Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=openshift-kni%2Flifecycle-agent). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.
openshift-ci-robot commented 4 months ago

@pixelsoccupied: This pull request references Jira Issue OCPBUGS-32495, which is invalid:

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to [this](https://github.com/openshift-kni/lifecycle-agent/pull/517): ># Background / Context > >This PR finalizes the work related Prep stage resiliency with docs + log messages + uniform naming convention > >Things to note: >- Cleaned up existing docs to reflect the updates better and helpful commands to get logs. >- Removed precache plugin md file as they were mostly dev focused (all which are already in .go file) and/or outdated. >- Streamlined logs and status messages to include job metadata >- Updated precache resource name to be simply `lca-prep-precache`. This should indicate that the job is from `Prep` stage. This also means previously appended resource names (`job` or `cm`) are also dropped as they are redundant and they are both using the same name. >- Updated extra-manifest warning annotation key to follow convention. `.lca.openshift.io/warn-` >- Addressed nits from prev PR > > >Ref: >https://github.com/openshift-kni/lifecycle-agent/pull/476 >https://github.com/openshift-kni/lifecycle-agent/pull/498 > >/cc @donpenney @Missxiaoguo Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=openshift-kni%2Flifecycle-agent). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.
pixelsoccupied commented 4 months ago

/unhold

pixelsoccupied commented 4 months ago

/hold testing a little bit

openshift-ci-robot commented 4 months ago

@pixelsoccupied: This pull request references Jira Issue OCPBUGS-32495, which is invalid:

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

In response to [this](https://github.com/openshift-kni/lifecycle-agent/pull/517): ># Background / Context > >This PR finalizes the work related Prep stage resiliency with docs + log messages + uniform naming convention > >Things to note: >- Cleaned up existing docs to reflect the updates better and helpful commands to get logs. >- Removed precache plugin md file as they were mostly dev focused (all which are already in .go file) and/or outdated. >- Streamlined logs and status messages to include job metadata >- Updated precache resource name to be simply `lca-prep-precache`. This should indicate that the job is from `Prep` stage. This also means previously appended resource names (`job` or `cm`) are also dropped as they are redundant and they are both using the same name. >- ~~Updated extra-manifest warning annotation key to follow convention. `.lca.openshift.io/warn-`~~ >- ~~Addressed nits from prev PR~~ >(Strikethrough will be addressed in another PR) > > >Ref: >https://github.com/openshift-kni/lifecycle-agent/pull/476 >https://github.com/openshift-kni/lifecycle-agent/pull/498 > >/cc @donpenney @Missxiaoguo Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=openshift-kni%2Flifecycle-agent). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.
pixelsoccupied commented 4 months ago

/unhold

jc-rh commented 4 months ago

/lgtm

pixelsoccupied commented 4 months ago

the extramanifest clean up/nit covered in https://github.com/openshift-kni/lifecycle-agent/pull/521. wdyt about getting this PR in before 521?

Missxiaoguo commented 4 months ago

/lgtm

openshift-ci[bot] commented 4 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: donpenney

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

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/openshift-kni/lifecycle-agent/blob/main/OWNERS)~~ [donpenney] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
donpenney commented 4 months ago

/override ci/prow/integration

openshift-ci[bot] commented 4 months ago

@donpenney: Overrode contexts on behalf of donpenney: ci/prow/integration

In response to [this](https://github.com/openshift-kni/lifecycle-agent/pull/517#issuecomment-2122634692): >/override ci/prow/integration Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
openshift-ci-robot commented 4 months ago

@pixelsoccupied: Jira Issue OCPBUGS-32495 is in an unrecognized state (ON_QA) and will not be moved to the MODIFIED state.

In response to [this](https://github.com/openshift-kni/lifecycle-agent/pull/517): ># Background / Context > >This PR finalizes the work related Prep stage resiliency with docs + log messages + uniform naming convention > >Things to note: >- Cleaned up existing docs to reflect the updates better and helpful commands to get logs. >- Removed precache plugin md file as they were mostly dev focused (all which are already in .go file) and/or outdated. >- Streamlined logs and status messages to include job metadata >- Updated precache resource name to be simply `lca-prep-precache`. This should indicate that the job is from `Prep` stage. This also means previously appended resource names (`job` or `cm`) are also dropped as they are redundant and they are both using the same name. >- ~~Updated extra-manifest warning annotation key to follow convention. `.lca.openshift.io/warn-`~~ >- ~~Addressed nits from prev PR~~ >(Strikethrough will be addressed in another PR) > > >Ref: >https://github.com/openshift-kni/lifecycle-agent/pull/476 >https://github.com/openshift-kni/lifecycle-agent/pull/498 > >/cc @donpenney @Missxiaoguo Instructions for interacting with me using PR comments are available [here](https://prow.ci.openshift.org/command-help?repo=openshift-kni%2Flifecycle-agent). If you have questions or suggestions related to my behavior, please file an issue against the [openshift-eng/jira-lifecycle-plugin](https://github.com/openshift-eng/jira-lifecycle-plugin/issues/new) repository.