Skip to content
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.

Sign up for GitHub

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

docs: Add git proxy support docs #547

Merged
merged 1 commit into from
Jan 20, 2022
Merged

docs: Add git proxy support docs #547

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions docs/spec/v1beta1/gitrepositories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,9 @@ To be able to support Azure DevOps a compromise solution was built, giving the u
option to select the git library while accepting the drawbacks.

| Git Implementation | Shallow Clones | Git Submodules | V2 Protocol Support |
|---|---|---|---|
| 'go-git' | true | true | false |
| 'libgit2' | false | false | true |
| --- | --- | --- | --- |
| 'go-git' | true | true | false |
| 'libgit2' | false | false | true |
Copy link
Contributor Author

@darkowlzz darkowlzz Jan 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated change. I used https://github.com/godlygeek/tabular to automatically format the table.
I can undo it and keep it simple if it'd be easier to maintain.


Pull the master branch from a repository in Azure DevOps.

Expand All @@ -225,6 +225,21 @@ spec:
gitImplementation: libgit2
```

## Git Proxy

A Git proxy can be configured by setting the appropriate environment variables
for proxy configurations, for example `HTTPS_PROXY`, `NO_PROXY`, etc., in the
source-controller pod. There may be some limitations in the proxy support based
on the Git implementations.

| Git Implementation | HTTP_PROXY | HTTPS_PROXY | NO_PROXY | Self-signed Certs |
| --- | --- | --- | --- | --- |
| 'go-git' | true | true | true | false |
| 'libgit2' | false | true | false | true |

**NOTE:** libgit2 v1.2.0 supports `NO_PROXY`, but source-controller uses
libgit2 v1.1.1 at the moment.

## Spec examples

### Checkout strategies
Expand Down