diff --git a/ansible/roles/operator-pipeline/templates/openshift/tasks/github-pipelinerun-summary.yml b/ansible/roles/operator-pipeline/templates/openshift/tasks/github-pipelinerun-summary.yml index f7def22f..c1386a11 100644 --- a/ansible/roles/operator-pipeline/templates/openshift/tasks/github-pipelinerun-summary.yml +++ b/ansible/roles/operator-pipeline/templates/openshift/tasks/github-pipelinerun-summary.yml @@ -128,7 +128,7 @@ spec: if [[ "$ORGANIZATION" == "community-operators" ]] then - DOC_LINK="https://redhat-openshift-ecosystem.github.io/operator-pipelines/users/contributing-prerequisites/" + DOC_LINK="https://raw.githubusercontent.com/redhat-openshift-ecosystem/operator-pipelines/main/docs/cluster-config.md/" else DOC_LINK="https://github.com/redhat-openshift-ecosystem/certification-releases/blob/main/4.9/ga/troubleshooting.md" fi diff --git a/docs/community-operators-troubleshooting.md b/docs/community-operators-troubleshooting.md new file mode 100644 index 00000000..b07302cf --- /dev/null +++ b/docs/community-operators-troubleshooting.md @@ -0,0 +1,219 @@ +# Troubleshooting the Community Operator Pipeline + +## Table of Contents + +### [Operator Hosted Pipeline](#hosted) +* [get-pr-number](#get-pr-number) +* [acquire-lease](#acquire-lease) +* [set-github-started-label](#set-github-started-label) +* [set-github-status-pending](#set-github-status-pending) +* [set-env](#set-env) +* [clone-repository-base](#clone-repository-base) +* [clone-repository](#clone-repository) +* [detect-changes](#detect-changes) +* [yaml-lint](#yaml-lint) +* [check-permissions](#check-permissions) +* [set-github-pr-title](#set-github-pr-title) +* [read-config](#read-config) +* [resolve-pr-type](#resolve-pr-type) +* [apply-test-waivers](#apply-test-waivers) +* [content-hash](#content-hash) +* [certification-project-check](#certification-project-check) +* [get-organization](#get-organization) +* [get-pyxis-certification-data](#get-pyxis-certification-data) +* [static-tests](#static-tests) +* [static-tests-results](#static-tests-results) +* [merge-registry-credentials](#merge-registry-credentials) +* [digest-pinning](#digest-pinning) +* [verify-pinned-digest](#verify-pinned-digest) +* [dockerfile-creation](#dockerfile-creation) +* [build-bundle](#build-bundle) +* [make-bundle-repo-public](#make-bundle-repo-public) +* [get-supported-versions](#get-supported-versions) +* [add-bundle-to-index](#add-bundle-to-index) +* [make-index-repo-public](#make-index-repo-public) +* [get-ci-results-attempt](#get-ci-results-attempt) +* [preflight-trigger](#preflight-trigger) +* [evaluate-preflight-result](#evaluate-preflight-result) +* [get-ci-results](#get-ci-results) +* [link-pull-request-with-open-status](#link-pull-request-with-open-status) +* [merge-pr](#merge-pr) +* [link-pull-request-with-merged-status](#link-pull-request-with-merged-status) + +### [Operator Released Pipeline](#released) +* [set-github-started-label](#set-github-started-label) +* [set-github-status-pending](#set-github-status-pending) +* [set-env](#set-env) +* [clone-repository-base](#clone-repository-base) +* [clone-repository](#clone-repository) +* [detect-changes](#detect-changes) +* [read-config](#read-config) +* [resolve-pr-type](#resolve-pr-type) +* [content-hash](#content-hash) +* [certification-project-check](#certification-project-check) +* [get-organization](#get-organization) +* [get-pyxis-certification-data](#get-pyxis-certification-data) +* [copy-bundle-image-to-released-registry](#copy-bundle-image-to-released-registry) +* [get-supported-versions](#get-supported-versions) +* [acquire-lease](#acquire-lease) +* [add-bundle-to-index](#add-bundle-to-index) +* [decide-index-paths](#decide-index-paths) +* [get-manifest-digests](#get-manifest-digests) +* [request-signature](#request-signature) +* [upload-signature](#upload-signature) +* [publish-to-index](#publish-to-index) + + +# Operator Hosted Pipeline + +## get-pr-number +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## acquire-lease +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## set-github-started-label +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## set-github-status-pending +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## set-env +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## clone-repository-base +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## clone-repository +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## detect-changes +### Pull Request Title +When creating a pull request manually the title of your pull request must follow a predefined format. + +| Prefix | Package Name | Version | +|--------|--------------|---------| +| The word `operator` | Operator package name | Version in parenthesis. DO NOT use a 'v' prefix.| + +> Note: The version string in your PR Title must match the version directory in your Operator Bundle. + +### Examples +`operator simple-demo-operator (0.0.0)` + +`operator hello-world-certified (1.2.3)` + +`operator my-operator (3.2.1)` + +## yaml-lint + +**Warnings** at this step should be addressed if possible but won't result in a failure. +**Errors** at this step will need to be addressed. Often errors center around unexpected whitespace at the end of lines or missing newlines at the end of your `yaml` files. + +## check-permissions +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## set-github-pr-title +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## read-config +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## resolve-pr-type +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## apply-test-waivers +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## content-hash +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## certification-project-check +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## get-organization +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## get-pyxis-certification-data +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## static-tests +The summary of failed static tests will be posted to the Pull Request as a comment with detailed reasons. Fix all of +failed static tests and retrigger the hosted pipeline. To learn more about static tests, please follow this [documentation](https://redhat-openshift-ecosystem.github.io/operator-pipelines/users/static_checks/). + +## static-tests-results +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## merge-registry-credentials +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## digest-pinning +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## verify-pinned-digest +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## dockerfile-creation +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## build-bundle +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## make-bundle-repo-public +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## get-supported-versions +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## add-bundle-to-index +Failures at this step are uncommon and if they do occur they are often transient. + +Please click the `Close pull request` button in GitHub then click the `Reopen pull request` button. +Closing and re-opening your Pull request will restart the Pipeline. If your PR fails at this step twice in a row please contact Red Hat Support + +## make-index-repo-public +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## get-ci-results-attempt +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## preflight-trigger +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +> Note: There is a known issue if you Operator only supports OpenShift 4.7 or below. In this case we recommend using the CI Pipeline. + +## evaluate-preflight-result +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## get-ci-results +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## link-pull-request-with-open-status +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## merge-pr +If hosted pipeline fails at this task with the error message: `Pull request Auto merge is not allowed for this repository (enablePullRequestAutoMerge)` then re-trigger the pipeline by running command `/pipeline restart operator-hosted-pipeline`. + +Another Failure at this step may happen if the pull request is a draft, convert the draft to a pull request and then retry. If this problem persists at this step, contact Red Hat Support. + +## link-pull-request-with-merged-status +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +# Operator Released Pipeline + +## copy-bundle-image-to-released-registry +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## decide-index-paths +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## get-manifest-digests +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## request-signatur +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## upload-signature +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support. + +## publish-to-index +Failures at this step are uncommon. If you do experience a failure or error at this step, contact Red Hat Support.