added upgrade ginkgo documentation for contributors

[SaumyaBhushan]

What this PR does / why we need it:

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• CVE Report (Scanner found CVE and adding report)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation only

Which issue/s this PR fixes

added documentation for gingko-upgrade

How Has This Been Tested?

Checklist:

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I've read the CONTRIBUTION guide
• I have added unit and/or e2e tests to cover my changes.
• All new and existing tests passed.
• Added Release Notes.

Does my pull request need a release note?

Any user-visible or operator-visible change qualifies for a release note. This could be a:

• CLI change
• API change
• UI change
• configuration schema change
• behavioral change
• change in non-functional attributes such as efficiency or availability, availability of a new platform
• a warning about a deprecation
• fix of a previous Known Issue
• fix of a vulnerability (CVE)

No release notes are required for changes to the following:

• Tests
• Build infrastructure
• Fixes for unreleased bugs

For more tips on writing good release notes, check out the Release Notes Handbook

PLACE RELEASE NOTES HERE

[k8s-ci-robot]

@SaumyaBhushan: This issue is currently awaiting triage.

If Ingress contributors determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: SaumyaBhushan
Once this PR has been reviewed and has the lgtm label, please assign rikatz for approval by writing /assign @rikatz in a comment. 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:

• OWNERS

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

[k8s-ci-robot]

Hi @SaumyaBhushan. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

[SaumyaBhushan]

@longwuyuan and @strongjz Please have a review and let me know if something needs to be updated or changed here .

[longwuyuan]

@SaumyaBhushan even though we have a bot to squash commits, you have the option to consider squashing commits yourself, to keep the PR cleaner

[SaumyaBhushan]

@SaumyaBhushan even though we have a bot to squash commits, you have the option to consider squashing commits yourself, to keep the PR cleaner

Sure @long I will do that

[SaumyaBhushan]

@longwuyuan If everything looks good to you then I will squash the commits If it is Okay with you.

[longwuyuan]

Correct me if I am wrong but I only looked at the rendered md file https://github.com/SaumyaBhushan/ingress-nginx/blob/gingko-upgrade/upgrade_ginkgo.md . And I did not see the last step which is changing the sha of the test-runner image in th ecode, after successfully promoting the new image.

[SaumyaBhushan]

Correct me if I am wrong but I only looked at the rendered md file https://github.com/SaumyaBhushan/ingress-nginx/blob/gingko-upgrade/upgrade_ginkgo.md . And I did not see the last step which is changing the sha of the test-runner image in th ecode, after successfully promoting the new image.

Those steps has been added in the third step only (in 3rd PR) . Is it ok ? Or do I need to add something else for the last step .

[longwuyuan]

I see this as the last part

But after this promotion of the new test-runner image, the sha of the newly generated test-runner image has to be changed in the project code.

This is an example PR for that sha change #9444

[SaumyaBhushan]

I see this as the last part

But after this promotion of the new test-runner image, the sha of the newly generated test-runner image has to be changed in the project code.

This is an example PR for that sha change #9444

Thanks Long . Let me add that also . Thanks for your guidance

[SaumyaBhushan]

Updated the PR @longwuyuan. Please review.

[rikatz]

Before reviewing, a question: can't we have ginkgo updated just once instead of 4 times? :)

[longwuyuan]

Literally/Technically speaking, ginkgo bump occurs only once, not 4 times. We see 4 steps, because we lack a super cool automation. - Dependabot PR only bumps go.mod & go.sum but not the pinned/hard-coded bits - Manual PR bumps hard-coded bits - Bump produces new testrunner image so promoting image PR is required but it's not in ingress-nginx repo so need manual PR in k8S.io repo - New testrunner image means new sha needs to be put in scripts so one more manual PR But James implemented a file in root for nginxbase image long ago. Top of the head thought is we can use same trick. Create a file for ginkgo version and another new file for testrunner image sha. So that way scripts can pick up from the file a-la-ngingbaseimage. Dream would be to fire all those other PRs automatically, on the event of Dependabot ginkgo bump PR merge. That requires highest level skill, knowledge and work. Pretty challenging.

…

On Fri, 30 Dec, 2022, 2:00 am Ricardo Katz, ***@***.***> wrote: Before reviewing, a question: can't we have ginkgo updated just once instead of 4 times? :) — Reply to this email directly, view it on GitHub <#9452 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABGZVWRGMVVM3UX2RFCD75TWPXYF7ANCNFSM6AAAAAATKFOTT4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[longwuyuan]

@SaumyaBhushan , if you are interested, you could try a new PR to create 2 new files in root, one for ginkgo version and another for testrunner-image sha.

Look at the file https://github.com/kubernetes/ingress-nginx/blob/main/NGINX_BASE . That file's content is used in many places in the code, where the nginx-base-image sha is needed. Earlier the nginx-base-image sha was used to be deuplicated in several scripts, that use the nginx-base-image sha.

[SaumyaBhushan]

Sure

@SaumyaBhushan , if you are interested, you could try a new PR to create 2 new files in root, one for ginkgo version and another for testrunner-image sha.

Look at the file https://github.com/kubernetes/ingress-nginx/blob/main/NGINX_BASE . That file's content is used in many places in the code, where the nginx-base-image sha is needed. Earlier the nginx-base-image sha was used to be deuplicated in several scripts, that use the nginx-base-image sha.

Sure @longwuyuan I can do that.

[SaumyaBhushan]

@SaumyaBhushan , if you are interested, you could try a new PR to create 2 new files in root, one for ginkgo version and another for testrunner-image sha.

Look at the file https://github.com/kubernetes/ingress-nginx/blob/main/NGINX_BASE . That file's content is used in many places in the code, where the nginx-base-image sha is needed. Earlier the nginx-base-image sha was used to be deuplicated in several scripts, that use the nginx-base-image sha.

@longwuyuan Here is the PR #9470

[longwuyuan]

I made comments on #9470

[longwuyuan]

@saumya, is the content of this PR edited as per the idea of #9470 or are we going to do this in phases

[SaumyaBhushan]

@saumya, is the content of this PR edited as per the idea of #9470 or are we going to do this in phases

hI @longwuyuan I will raise a PR tomorrow .

[SaumyaBhushan]

Hi @longwuyuan I think the documentation part is completed in this PR. For the changes mentioned in #9470 will be covered in that PR only . I am going to update this PR for that

[k8s-ci-robot]

@SaumyaBhushan: 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.