fix: improve git PAT configuration documentation #2567
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com>
|
🎊 Navigate the preview: https://642d2b809a772270fcbe0093--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
…or-git-repositories-with-self-signed-certificates.adoc Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com>
svor
requested review from
rkratky,
max-cx,
deerskindoll and
a team
as code owners
14 tasks
Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com>
Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com>
Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com>
max-cx
reviewed
Apr 3, 2023
modules/end-user-guide/pages/using-a-git-provider-access-token.adoc
Outdated
Show resolved
Hide resolved
max-cx
reviewed
Apr 4, 2023
modules/end-user-guide/pages/using-a-git-provider-access-token.adoc
Outdated
Show resolved
Hide resolved
max-cx
reviewed
Apr 4, 2023
modules/end-user-guide/pages/using-a-git-provider-access-token.adoc
Outdated
Show resolved
Hide resolved
….adoc Co-authored-by: Max Leonov <mleonov@redhat.com>
….adoc Co-authored-by: Max Leonov <mleonov@redhat.com>
max-cx
reviewed
Apr 4, 2023
modules/end-user-guide/pages/using-a-git-provider-access-token.adoc
Outdated
Show resolved
Hide resolved
….adoc Co-authored-by: Max Leonov <mleonov@redhat.com>
…port-for-git-repositories-with-self-signed-certificates.adoc
max-cx
approved these changes
Apr 4, 2023
max-cx
added a commit
that referenced
this pull request
Apr 4, 2023
* fix: improve git PAT configuration documentation Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com> * Update :page-aliases: installation-guide:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com> * feat: extend available schemas for BB repos Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com> * feat: add a schema to start ws with BB repo url and specific branch Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com> * Update modules/end-user-guide/pages/using-a-git-provider-access-token.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Update modules/end-user-guide/pages/using-a-git-provider-access-token.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * Update modules/end-user-guide/pages/using-a-git-provider-access-token.adoc Co-authored-by: Max Leonov <mleonov@redhat.com> * suggestion to rephrase callout <2> and NOTE in deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc --------- Signed-off-by: Valerii Svydenko <vsvydenk@redhat.com> Co-authored-by: Max Leonov <mleonov@redhat.com>
|
Cherry-picked to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this pull request change?
Updates Deploying Che with support for Git repositories with self-signed certificates and Using a Git-provider access token articles
These PR provides a few updates related to (taken from the related issue):
Retrieving BB user id (for the annotation che.eclipse.org/scm-userid) is not straightforward. That's because using the curl command that is linked in the documentation fails with non-authorized. A link to the authentication for BB API should be added too.
I didn't know exactly what URL to use:
https://{bb-host}/users/{user-slug}/repos/{repo-name}/didn't work buthttps://{bb-host}/scm/~{user-slug}/{repo-name}.git. We should support both BB URL schemas.I initially set che.eclipse.org/scm-userid: 2 because BB user id is an integer. But the secret failed to be parsed because a string is expected. We should document that the scm-userid should be wrapped with "" or ''.
I didn't know exactly what URL to use: https://{bb-host}/users/{user-slug}/repos/{repo-name}/ didn't work but https://{bb-host}/scm/~{user-slug}/{repo-name}.git. We should support both BB URL schemas.
After successfully setting up the PAT secret, git clone continued to fail because BB was using an untrusted SSL certificate. The article "Deploying Che with support for Git repositories with self-signed certificates" should be referenced as an "additional resource".
As some point the configmap is referenced as a secret ("All Secrets that hold certificate files...")
It's not clear if certs in binary format are supported or not (they are not supported but this sentence is confusing "Also, they can be encoded as binary data, for example, .cer...")
It doesn't mention that the certificate chain is required
It doesn't mention that in the githost the protocol (i.e. https) is required
What issues does this pull request fix or reference?
eclipse-che/che#21989
https://issues.redhat.com/browse/RHDEVDOCS-4976
Specify the version of the product this pull request applies to
Che 7.62.0
DS 3.6.0
Merge to
mainCherry-pick to
7.62.x,7.63.x,7.64.xPull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.