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.

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

OPCT-220: validation: moving CCSP/validated OCP parts from OPCT docs #17

Closed
wants to merge 1 commit into from

Conversation

mtulio
Copy link
Contributor

@mtulio mtulio commented Jun 5, 2023

This PR introduces a new section /validation on Infra Onboarding Guide moving the VCSP/CCSP specific from OPCT documentation, creating more flexibility and details for the types of validation offered by VCSP using OPCT.

In the future that "dedicated Guides" will be more critical as OPCT is delivering a lot of features specific to the Program that will require steps to prepare the environment for each one, like SNO, Compact, and Upgrade Disconnected.

The documentation on this website will focus on the validation tests, not the tool itself.

Sections added:

Screenshot from 2023-06-05 16-21-28

Note:

  • the documentation uses the mkdocs plugin pymdownx to allow to include of snippets and reuse markdown fragments of the documentation, creating complete guides reusing existing content.

@mtulio mtulio changed the title docs/validation: moving VCSP parts from OPCT docs docs/validation-tests: moving VCSP parts from OPCT docs Jun 5, 2023
- 'Red Hat Relationship': 'red-hat-relationship/index.md'
- 'Release': 'release/index.md'
- Welcome: index.md
- Full integration:
Copy link
Contributor Author

@mtulio mtulio Jun 5, 2023

Choose a reason for hiding this comment

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

fyi: this change is aligned with the Platform External documentation, aligned in the change #16

@mtulio mtulio force-pushed the validation-tests-vcsp branch 3 times, most recently from cd6d8fe to 1818c09 Compare June 5, 2023 19:17
@mtulio mtulio changed the title docs/validation-tests: moving VCSP parts from OPCT docs docs/validation-tests: moving CCSP parts from OPCT docs Jun 5, 2023
@mtulio mtulio changed the title docs/validation-tests: moving CCSP parts from OPCT docs docs/validation-tests: moving CCSP/validated OCP parts from OPCT docs Jun 12, 2023
3) Run acceptance suite:

~~~bash
podman run -v ${INSTALL_DIR}:/opt/cluster:Z quay.io/ocsci/ocs-ci-container:stable run-ci -m acceptance --junit-xml /opt/cluster/junit.xml --cluster-path /opt/cluster --ocp-version ${CLUSTER_VERSION} --ocs-version ${CLUSTER_VERSION} --color=yes --cluster-name ${CLUSTER_NAME} tests/
Copy link
Contributor Author

@mtulio mtulio Jun 19, 2023

Choose a reason for hiding this comment

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

Email suggestion:

Suggested change
podman run -v ${INSTALL_DIR}:/opt/cluster:Z quay.io/ocsci/ocs-ci-container:stable run-ci -m acceptance --junit-xml /opt/cluster/junit.xml --cluster-path /opt/cluster --ocp-version ${CLUSTER_VERSION} --ocs-version ${CLUSTER_VERSION} --color=yes --cluster-name ${CLUSTER_NAME} tests/
podman run -v ${INSTALL_DIR}:/opt/cluster:Z \
quay.io/ocsci/ocs-ci-container:stable run-ci -m acceptance \
--junit-xml /opt/cluster/junit.xml \
--cluster-path /opt/cluster \
--ocp-version ${CLUSTER_VERSION} \
--ocs-version ${CLUSTER_VERSION} \
--ocsci-conf conf/deployment/baremetal/upi_1az_rhcos_nvme_intel_3m_3w.yaml \
--color=yes \
--cluster-name ${CLUSTER_NAME} tests/

Choose a reason for hiding this comment

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

Change the location of conf/deployment/baremetal/upi_1az_rhcos_nvme_intel_3m_3w.yaml based this cmd

$ podman run -v ~/ClusterPath:/opt/cluster:Z quay.io/ocsci/ocs-ci-container:stable run-ci -m acceptance --junit-xml /opt/cluster/junit.xml --cluster-path /opt/cluster --ocp-version 4.13 --ocs-version 4.13 --ocsci-conf conf/deployment/baremetal/upi_1az_rhcos_nvme_intel_3m_3w.yaml --color=yes --cluster-name oviner123 tests/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@OdedViner iiuc only the order of the arguments has been changed, right?

Choose a reason for hiding this comment

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

yes.. I tested it on my setup....

@rvanderp3
Copy link

/approve


~~~bash
oc adm must-gather --image=registry.redhat.io/odf4/odf-must-gather-rhel9
~~~
Copy link

@OdedViner OdedViner Jun 21, 2023

Choose a reason for hiding this comment

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

MG cmd failed with this image

$ oc adm must-gather --image=registry.redhat.io/odf4/odf-must-gather-rhel9
[must-gather      ] OUT Using must-gather plug-in image: registry.redhat.io/odf4/odf-must-gather-rhel9
When opening a support case, bugzilla, or issue please include the following summary data along with any other requested information:
ClusterID: 90e29e2c-b6bc-42e8-b980-dc7bad925878
ClusterVersion: Stable at "4.13.0-0.nightly-2023-06-19-110814"
ClusterOperators:
	clusteroperator/machine-config is degraded because Failed to resync 4.13.0-0.nightly-2023-06-19-110814 because: error during syncRequiredMachineConfigPools: [timed out waiting for the condition, error pool worker is not ready, retrying. Status: (pool degraded: true total: 3, ready 2, updated: 2, unavailable: 0)]


[must-gather      ] OUT namespace/openshift-must-gather-nzxg8 created
[must-gather      ] OUT clusterrolebinding.rbac.authorization.k8s.io/must-gather-2m9zg created
[must-gather      ] OUT pod for plug-in image registry.redhat.io/odf4/odf-must-gather-rhel9 created
[must-gather-9nf66] OUT gather did not start: unable to pull image: ImagePullBackOff: Back-off pulling image "registry.redhat.io/odf4/odf-must-gather-rhel9"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks, idk where that image came from :)
I just added the available in the docs https://docs.openshift.com/container-platform/4.10/support/gathering-cluster-data.html

@mtulio
Copy link
Contributor Author

mtulio commented Jul 12, 2023

/assign @rvanderp3 @elmiko

@mtulio mtulio changed the title docs/validation-tests: moving CCSP/validated OCP parts from OPCT docs OPCT-220: validation: moving CCSP/validated OCP parts from OPCT docs Jul 12, 2023
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 12, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 12, 2023

@mtulio: This pull request references OPCT-220 which is a valid jira issue.

In response to this:

This PR introduces a new section /validation on Infra Onboarding Guide moving the VCSP/CCSP specific from OPCT documentation, creating more flexibility and details for the types of validation offered by VCSP using OPCT.

In the future that "dedicated Guides" will be more critical as OPCT is delivering a lot of features specific to the Program that will require steps to prepare the environment for each one, like SNO, Compact, and Upgrade Disconnected.

The documentation on this website will focus on the validation tests, not the tool itself.

Sections added:

Screenshot from 2023-06-05 16-21-28

Note:

  • the documentation uses the mkdocs plugin pymdownx to allow to include of snippets and reuse markdown fragments of the documentation, creating complete guides reusing existing content.

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/test-infra repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jul 12, 2023

@mtulio: This pull request references OPCT-220 which is a valid jira issue.

In response to this:

This PR introduces a new section /validation on Infra Onboarding Guide moving the VCSP/CCSP specific from OPCT documentation, creating more flexibility and details for the types of validation offered by VCSP using OPCT.

In the future that "dedicated Guides" will be more critical as OPCT is delivering a lot of features specific to the Program that will require steps to prepare the environment for each one, like SNO, Compact, and Upgrade Disconnected.

The documentation on this website will focus on the validation tests, not the tool itself.

Sections added:

Screenshot from 2023-06-05 16-21-28

Note:

  • the documentation uses the mkdocs plugin pymdownx to allow to include of snippets and reuse markdown fragments of the documentation, creating complete guides reusing existing content.

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/test-infra repository.

docs/validation/index.md Outdated Show resolved Hide resolved
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jul 12, 2023

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mtulio, rvanderp3
Once this PR has been reviewed and has the lgtm label, please ask for approval from elmiko. For more information see the Kubernetes Code Review Process.

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

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

Copy link
Contributor

@elmiko elmiko left a comment

Choose a reason for hiding this comment

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

in general this is looking good to me. one thing that bums me out is that apparently we have hit a bug (mkdocs/mkdocs#3111) with mkdocs and our navigation bar.

when i do a fresh load of the page now, i see that the validation guides is highlighted and the focus is moved there. it looks like this:

Screenshot from 2023-07-13 09-58-47

i'm not sure there is much we can do about it, i've tried messing with the nav bar configuration but we might need to consider flattening the navigation menu or some other way to remediate this.

docs/index.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
This change introduce the /validation path with steps to
partners validated the OpenShift installations in
non-integrated providers.

Those steps are used by CCSP/Validated[1] program, which use
the tool OPCT[2] to run conformance tests.

Those guides was initialy created in the OPCT tool[3], but it
must be moved to a single entry point to partners, leaving
the tool to its documentation.

[1] https://source.redhat.com/groups/public/global_partner_engagement/global_partner_engagement_wiki/validated_ccsp
[2] https://redhat-openshift-ecosystem.github.io/provider-certification-tool/
[3] https://redhat-openshift-ecosystem.github.io/provider-certification-tool/user/
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Jul 14, 2023

@mtulio: 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/test-infra repository. I understand the commands that are listed here.

@mtulio
Copy link
Contributor Author

mtulio commented Aug 2, 2023

This PR is on hold awaiting the next steps in the bug mentioned by @elmiko .
/hold

@openshift-ci openshift-ci bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 2, 2023
@openshift-bot
Copy link

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 1, 2023
@openshift-bot
Copy link

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Dec 1, 2023
@openshift-bot
Copy link

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 1, 2024
@openshift-merge-robot
Copy link
Contributor

PR needs rebase.

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/test-infra repository.

@openshift-ci openshift-ci bot closed this Jan 1, 2024
Copy link
Contributor

openshift-ci bot commented Jan 1, 2024

@openshift-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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/test-infra repository.

@elmiko
Copy link
Contributor

elmiko commented Jan 4, 2024

/reopen

@openshift-ci openshift-ci bot reopened this Jan 4, 2024
Copy link
Contributor

openshift-ci bot commented Jan 4, 2024

@elmiko: Reopened this PR.

In response to this:

/reopen

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/test-infra repository.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 4, 2024

@mtulio: This pull request references OPCT-220 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.16.0" version, but no target version was set.

In response to this:

This PR introduces a new section /validation on Infra Onboarding Guide moving the VCSP/CCSP specific from OPCT documentation, creating more flexibility and details for the types of validation offered by VCSP using OPCT.

In the future that "dedicated Guides" will be more critical as OPCT is delivering a lot of features specific to the Program that will require steps to prepare the environment for each one, like SNO, Compact, and Upgrade Disconnected.

The documentation on this website will focus on the validation tests, not the tool itself.

Sections added:

Screenshot from 2023-06-05 16-21-28

Note:

  • the documentation uses the mkdocs plugin pymdownx to allow to include of snippets and reuse markdown fragments of the documentation, creating complete guides reusing existing content.

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.

@elmiko
Copy link
Contributor

elmiko commented Jan 4, 2024

i think we want to keep working on this, it's just lower priority at the moment.

@elmiko
Copy link
Contributor

elmiko commented Jan 4, 2024

/remove-lifecycle rotten

@openshift-ci openshift-ci bot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jan 4, 2024
@openshift-bot
Copy link

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 4, 2024
@openshift-bot
Copy link

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 4, 2024
@mtulio
Copy link
Contributor Author

mtulio commented May 14, 2024

Closing this PR as we dont have intention and well-defined the model to move on the VCSP guidance. When the card OPCT-220 will be addressed we can revisit this PR.

@mtulio mtulio closed this May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants