Improve secret hostname hint

[jerolimov]

Fixes:
https://issues.redhat.com/browse/ODC-4906

Analysis / Root cause:
When starting a pipeline there is an option to add a Secret to fetch data from a private git repository. The hint here suggest a server name like "https://github.com", but the pipeline/secret combination works only when the server name is something like "github.com".

Solution Description:
Update the hint from static The base server url (e.g. https://github.com) to a dynamic version which is now depending on the selected auth mechanism:

For docker config json: The base server url (e.g. https://quay.io/) (new example server)
For http basic auth: The base server url (e.g. https://github.com) (unchanged)
For SSH: Server hostname without schema or path (e.g. github.com)

Edit: After getting some feedback in this PR, this PR now also changes the order of the input fields to show depending fields below the more generic options.

It also hides some useless "Access To" and "Authentication Type" combinations:

• For "Access To: Git" we only show the auth types "Basic Authentication" and "SSH Key" and dropped the option "Image Registry Credentials"
• For "Access To: Image" we only show the auth types "Basic Authentication" and "Image Registry Credentials" and dropeed the option "SSH Key".

See #6873 (comment) and #6873 (comment)

Screen shots / Gifs for design review:
@openshift/team-devconsole-ux

Before:

After:

And some more detail screens:

Access to options in now above the auth type

Docker registry auth type options:

Docker registry with basic auth selected:

Docker registry with Image Registry selected:

Git server auth type options:

Git server with basic auth selected:

Git server with SSH Key selected:

Unit test coverage report:
No unit test changed.

Test setup:

• Install OpenShift Pipelines Operator
• Create a new pipeline (e.g. add a deployment and enable the option "Add Pipeline")
• Open the "Start Pipeline" dialog

Browser conformance:

• Chrome
• Firefox
• Safari
• Edge

[jerolimov]

/kind bug
/cc @karthikjeeyar

[karthikjeeyar]

@jerolimov , The Server URL annotation's value can be https://github.com (for: https://github.com/test/testRepo) or github.com (for ssh url: git@github.com/test/testRepo), It depends on the git url that we use in the pipelines.
Refer the basic Auth and ssh examples here : https://github.com/tektoncd/pipeline/blob/master/docs/auth.md

[jerolimov]

@karthikjeeyar You're absolute right here. We need to make a difference here between http and ssh. I updated this PR (incl the PR description and gif). Wdyt about this change now?

(I didn't tested the dockerconfig way and are not sure if https:// is correct in that case.)

[karthikjeeyar]

@jerolimov Thank you for improving the hint based on the Authentication type, this is very useful to the user, but however i have a suggestion to reorder the Authentication Type and the Annotation section, because i feel changing the previous field's help text will not help the user to identify the value upfront, they might have to revisit the previous field to adjust the value. I think we need UX input here.

@bgliwa01 Let us know your thought on this.

[jerolimov]

@karthikjeeyar Yes, I see this exactly like you. From the code perspective it looks a little bit strange, but I think also this would improve the UX. I reordered the components to get a better feeling for the result:

(Not part of this PR yet!)

@karthikjeeyar @bgliwa01 Wdyt? I removed the subtitle "Designate provider to be authenticated" because I was unsure where we want keep it. But I can restore it again if you want this.

[jerolimov]

Btw, if the tekton Authentication at Run Time doc contains all cases we also should (in this ticket, or in a new one..) hide some combinations here:

(screenshot of the doc toc)

• When "Access to" "Git Server" is selected we should hide the "Auth Type" option "Image Registry Credentials"
• When "Access to" "Docker Server" is selected we should hide the "Auth Type" option "SSH auth"

/cc @andrewballantyne @vdemeester wdyt? Should I create a new ticket for this or solve this here as well?

[vdemeester]

• When "Access to" "Git Server" is selected we should hide the "Auth Type" option "Image Registry Credentials"
• When "Access to" "Docker Server" is selected we should hide the "Auth Type" option "SSH auth"

/cc @andrewballantyne @vdemeester wdyt? Should I create a new ticket for this or solve this here as well?

Right, I think it make sense to hide thoses

[jerolimov]

@christianvogt @vdemeester @karthikjeeyar @andrewballantyne Updated the PR with your feedback,

• it nows also reorders the fields so that you need to select the "Access to" and "Auth type" fields before entering the "Server URL".
• it hides the "Auth type" "Image Registry Credentials" for Git servers and "SSH auth" for Docker registry.

Btw, should we rename Docker registry to Image registry?!?

[jerolimov]

@bgliwa01 Thanks for bringing this up in the weekly pipeline sync. Added the following changes now:

• Changed section title from "Create Source Secret" to "Create Secret"
• Restored "Designate provider to be authenticated." as hint for "Access to:"
• Renamed "Docker Registry" to "Image Registry"

[jerolimov]

/retest

[karthikjeeyar]

Thanks @jerolimov
/lgtm

[jerolimov]

/retest

[jerolimov]

/retest

[jerolimov]

Thanks @vikram-raj, I added the missing translation namespace.

[vikram-raj]

verified it. Thanks @jerolimov

/lgtm

[andrewballantyne]

Forgot to hit a review on Friday. @jerolimov You still have the same issue that I noted in my description to Brigid. If you switch the type or access-to it does not reset the value of the Server URL... which could be easily overlooked that the hint changed.

[jerolimov]

Forgot to hit a review on Friday. @jerolimov You still have the same issue that I noted in my description to Brigid. If you switch the type or access-to it does not reset the value of the Server URL... which could be easily overlooked that the hint changed.

So you want that we clear the server URL or change them as well? Yeah its maybe the safest way.

We could also apply some additional form validation rules here. But let us start with the easiest solution (resetting it)?! Will do that.

[andrewballantyne]

Forgot to hit a review on Friday. @jerolimov You still have the same issue that I noted in my description to Brigid. If you switch the type or access-to it does not reset the value of the Server URL... which could be easily overlooked that the hint changed.

So you want that we clear the server URL or change them as well? Yeah its maybe the safest way.

We could also apply some additional form validation rules here. But let us start with the easiest solution (resetting it)?! Will do that.

Right, the easiest thing is for us to clear (reset back to default) items below the changed field... that way the user is mentally required to re-address those values. I think you'll probably also want to reset the field back to untouched(?) because Formik won't understand what we are doing and will flag the field against the validation schema -- which says "string not empty"... and errors it because we just emptied it haha. I don't think this noise is needed for the user.

[jerolimov]

@andrewballantyne @vikram-raj @bgliwa01 I added the following change so that the "Server URL" was now cleared when

• the user switches the "Access to" and this automatically switch the the "Authentication Type"
• the user manually switches "Authentication Type"

[jerolimov]

/retest

[jerolimov]

JavaScript heap out of memory

/retest

[jerolimov]

/test backend

[karthikjeeyar]

Thanks @jerolimov, Verified locally, works fine
/lgtm

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andrewballantyne, bgliwa01, jerolimov, karthikjeeyar, vikram-raj

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:

• frontend/packages/dev-console/integration-tests/OWNERS [andrewballantyne]
• frontend/packages/pipelines-plugin/OWNERS [andrewballantyne]

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