-
Notifications
You must be signed in to change notification settings - Fork 1
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
more fixing tips #399
base: main
Are you sure you want to change the base?
more fixing tips #399
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"label": "Git", | ||
"position": 2, | ||
"collapsible": true, | ||
"collapsed": true | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
title: Git Troubleshooting | ||
id: git-troubleshooting | ||
description: How to troubleshoot permissions and network issues with Git | ||
tags: [] | ||
--- | ||
|
||
Sometimes there is an error when Prophecy tries to reach Git. This could be caused by your user's [authorization](#debugging-git-credentials), a [repository setting](#debugging-repository-setttings), or a [network](#debugging-network-issues) issue. Fear not! This guide outlines what to do if you see error messages such as: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should use second person, so "This could be cause by your [authorization]..." |
||
`not authorized` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: to make it easier to read in this file, add empty spaces, so: This guide outlines what to do if you see error messages such as:
or
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Or better yet, use an unordered list for these, so:
|
||
`git-upload-pack-not-permitted` | ||
or | ||
`git-recieve-pack-not-permitted` | ||
|
||
 | ||
|
||
## Debugging Git Credentials | ||
|
||
Sometimes your personal access token (PAT) has expired or lacks a certain permission. | ||
|
||
1. Check if your PAT has expired. If so, create a new one with sufficient read and write access to the repository of interest. Here are the instructions to locate existing tokens and create new tokens for [Github](https://docs.github.com/en/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens), [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/repository-access-tokens/), or [GitLab](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should be mention where the reader can check to see if their PAT has expired? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it the Prophecy Access Tokens tab? |
||
2. Open a terminal from a computer that can access your Git repository. If you need help with this step, please reach out to your Git administrator. | ||
3. Have the new PAT ready; you'll use it in place of a password. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If the reader doesn't have a new PAT, should we tell them where/how they can create one? Or link them to https://docs.prophecy.io/metadata/prophecyAPI/#generate-a-pat |
||
4. Check for read access by testing your ability to [clone](https://git-scm.com/docs/git-clone) a repo | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For 4. and 5. I would add :'s at the end of the statements. And maybe use code blocks for better formatting and easier copy/paste-ability
|
||
`git clone` | ||
Here are the clone instructions for [Github](https://docs.github.com/en/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#using-a-personal-access-token-on-the-command-line), [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/clone-a-git-repository/), or [GitLab](https://docs.gitlab.com/ee/topics/git/clone.html). | ||
5. Check for write access by testing your ability to [push](https://git-scm.com/docs/git-push) to a repo | ||
`git push` | ||
Here are the push instructions for [Github](https://docs.github.com/en/enterprise-cloud@latest/get-started/using-git/pushing-commits-to-a-remote-repository), [Bitbucket](https://support.atlassian.com/bitbucket-cloud/docs/push-code-to-bitbucket/), or [GitLab](https://docs.gitlab.com/ee/topics/git/commands.html#git-push). | ||
6. If your PAT lacks read or write permissions for the repository of interest, ask the repository admin to adjust these permissions. | ||
7. If access has changed recently, check with your Git administrator to see if they have made any changes. | ||
|
||
## Debugging Repository Settings | ||
|
||
Sometimes a repository settings can restrict a user's permissions outside the user's profile settings page. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "...restrict your permissions" There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not sure where the reader would go to check the following restrictions. We could add a line saying something like, "On the repository's security settings, check for the following restrictions." |
||
|
||
1. Check if there are restrictions on writing to certain branches. | ||
2. Check if there are restrictions on commit hooks in the repository. | ||
3. Check if there are restrictions on commit messages. | ||
4. Check if the user's role allows read and write access on the repository. | ||
5. If access has changed recently, check with your Git administrator to see if they have made any changes. | ||
|
||
## Debugging Network Issues | ||
|
||
If the PAT works outside the Prophecy UI as mentioned above but does not work inside the Prophecy UI then there may be network issues. If you're using app.Prophecy.io, then seek a network admin to troubleshoot why Prophecy cannot read or write from the repository. If you're using a private Prophecy deployment, follow the instructions below. | ||
|
||
:::caution | ||
The steps below are intended for Private SaaS deployments, i.e. Prophecy is deployed within your organization's network. The steps are intended for the person who owns the Prophecy deployment. | ||
::: | ||
|
||
1. Login to the metagraph pod. | ||
2. If the remote repository is configured using SSL and the metagraph pod cannot reach the remote Git server, then set `SKIP_SSL_VERIFICATION` to true. | ||
3. If Prophecy is running on an encrypted cluster, then `ENABLE_PROPHECY_ENCRYPTION_PII` must be set to true. | ||
4. If the remote repository is configured via a proxy and the metagraph pod cannot reach the remote Git server, then add the proxy details to JVM options and restart. | ||
|
||
## Reach out for assistance | ||
|
||
If you're still facing issues, please don't hesitate to [reach out to us](/docs/getting-started/getting-help.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: are you okay with using sentence casing for titles and section headers? We have a mix of either that or title case in our docset, and I want to start enforcing one for consistency.
Git troubleshooting
Debugging Git credentials
Debugging network issues