You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/bitbucket-installation.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,26 @@ description: Install gitStream to your Bitbucket workspace.
19
19
- 13.56.203.235
20
20
- 54.151.81.98
21
21
22
+
??? Info "Understanding IP Allowlisting for gitStream"
23
+
When setting up IP allowlists in Bitbucket, you're specifying which source IP addresses are permitted to interact with your repositories and APIs. This affects both gitStream and your CI/CD runners.
24
+
25
+
There are two primary cases where this matters for gitStream:
26
+
27
+
1. **Webhook Event Handling by gitStream**
28
+
When Bitbucket triggers a webhook event (e.g., a pull request opened), gitStream may need to make follow-up API calls to Bitbucket. This can include fetching additional metadata, posting comments to the PR, or performing other actions. These calls are made from the LinearB/gitStream service, which uses a fixed set of IP addresses. These IPs must be added to your Bitbucket allowlist to ensure proper operation.
29
+
30
+
2. **Outbound Requests from Your CI Runner**
31
+
When your pipeline runs gitStream, that runner might also make outbound calls to Bitbucket—for example, to clone a repository or retrieve commit history. These requests will originate from the runner's IP address.
32
+
33
+
If you encounter errors due to blocked IPs during your CI runs, it's likely that the runner is using an IP that is not part of the configured allowlist.
34
+
35
+
**Recommended Solution**
36
+
To ensure reliability:
37
+
- Add LinearB/gitStream service IPs to your Bitbucket allowlist (listed above).
38
+
- Use self-hosted runners or runners with static IPs so you can manage and allowlist their addresses explicitly.
39
+
40
+
This combination ensures that both gitStream's internal operations and your CI runners' interactions with Bitbucket function without network restrictions.
Copy file name to clipboardExpand all lines: docs/github-installation.md
+21-1Lines changed: 21 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,30 @@ description: Install gitStream to your GitHub organization.
6
6
7
7
!!! Info "Prerequisites"
8
8
Allowed network connection between the runners and the following IPs:
9
-
9
+
10
10
- 13.56.203.235
11
11
- 54.151.81.98
12
12
13
+
??? Info "Understanding IP Allowlisting for gitStream"
14
+
When setting up IP allowlists in GitHub, you're specifying which source IP addresses are permitted to interact with your repositories and APIs. This affects both gitStream and your CI/CD runners.
15
+
16
+
There are two primary cases where this matters for gitStream:
17
+
18
+
1. **Webhook Event Handling by gitStream**
19
+
When GitHub triggers a webhook event (e.g., a pull request opened), gitStream may need to make follow-up API calls to GitHub. This can include fetching additional metadata, posting comments to the PR, or performing other actions. These calls are made from the LinearB/gitStream service, which uses a fixed set of IP addresses. These IPs must be added to your GitHub allowlist to ensure proper operation.
20
+
21
+
2. **Outbound Requests from Your CI Runner**
22
+
When your pipeline runs gitStream (e.g., via a GitHub Action), that runner might also make outbound calls to GitHub—for example, to clone a repository or retrieve commit history. These requests will originate from the runner's IP address.
23
+
24
+
If you encounter errors due to blocked IPs during your CI runs, it's likely that the runner is using an IP that is not part of the configured allowlist. This is a common issue with GitHub-hosted runners, as their IPs can be dynamic and change frequently.
25
+
26
+
**Recommended Solution**
27
+
To ensure reliability:
28
+
- Add LinearB/gitStream service IPs to your GitHub allowlist (listed above).
29
+
- Use self-hosted runners or runners with static IPs so you can manage and allowlist their addresses explicitly.
30
+
31
+
This combination ensures that both gitStream's internal operations and your CI runners' interactions with GitHub function without network restrictions.
32
+
13
33
!!! Warning "Install gitStream"
14
34
15
35
Before you can complete the gitStream setup process, you need to install the gitStream app to your [GitHub organization](https://github.com/apps/gitstream-cm/installations/new){ .md-button }.
Copy file name to clipboardExpand all lines: docs/gitlab-installation.md
+26-8Lines changed: 26 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,16 +13,36 @@ description: Install gitStream to your GitLab organization.
13
13
- 13.56.203.235
14
14
- 54.151.81.98
15
15
16
+
??? Info "Understanding IP Allowlisting for gitStream"
17
+
When setting up IP allowlists in GitLab, you're specifying which source IP addresses are permitted to interact with your repositories and APIs. This affects both gitStream and your CI/CD runners.
18
+
19
+
There are two primary cases where this matters for gitStream:
20
+
21
+
1. **Webhook Event Handling by gitStream**
22
+
When GitLab triggers a webhook event (e.g., a merge request opened), gitStream may need to make follow-up API calls to GitLab. This can include fetching additional metadata, posting comments to the MR, or performing other actions. These calls are made from the LinearB/gitStream service, which uses a fixed set of IP addresses. These IPs must be added to your GitLab allowlist to ensure proper operation.
23
+
24
+
2. **Outbound Requests from Your CI Runner**
25
+
When your pipeline runs gitStream, that runner might also make outbound calls to GitLab—for example, to clone a repository or retrieve commit history. These requests will originate from the runner's IP address.
26
+
27
+
If you encounter errors due to blocked IPs during your CI runs, it's likely that the runner is using an IP that is not part of the configured allowlist.
28
+
29
+
**Recommended Solution**
30
+
To ensure reliability:
31
+
- Add LinearB/gitStream service IPs to your GitLab allowlist (listed above).
32
+
- Use self-hosted runners or runners with static IPs so you can manage and allowlist their addresses explicitly.
33
+
34
+
This combination ensures that both gitStream's internal operations and your CI runners' interactions with GitLab function without network restrictions.
35
+
16
36
GitLab Installation Overview
17
37
18
38
1. Designate a gitStream user account.
19
39
1. Create a `cm` repo and `.cm` configuration file.
20
40
1. Create a GitLab pipeline.
21
-
1. Connect gitStream in LinearB.
41
+
1. Connect gitStream in LinearB.
22
42
23
43
## Designate a gitStream User Account
24
44
25
-
gitStream automation rules are executed on behalf of the user account configured when you install the gitStream service. This account must have the `maintainer` or `owner` role to the relevant repos.
45
+
gitStream automation rules are executed on behalf of the user account configured when you install the gitStream service. This account must have the `maintainer` or `owner` role to the relevant repos.
26
46
27
47
We recommend creating a [dedicated service account](https://docs.gitlab.com/ee/user/profile/service_accounts.html){:target="_blank"} to control access to individual repos easily. You can also use your professional or personal GitLab account for this, which would result in all automations being executed under that account, which might also affect LinearB's metrics.
28
48
@@ -50,7 +70,7 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
50
70
=== "GitLab-Hosted runners"
51
71
52
72
**Gitlab-Hosted Runners**
53
-
73
+
54
74
Use the following `.gitlab-ci.yml`
55
75
56
76
``` yaml+jinja
@@ -68,14 +88,14 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
68
88
``` yaml+jinja
69
89
--8<-- "docs/downloads/gitlab-shell-ci.yml"
70
90
```
71
-
91
+
72
92
=== "Self-Managed Runners - Kubernetes"
73
93
**Self-Managed Runners**
74
94
75
95
First, [register the runner](https://docs.gitlab.com/runner/register/){:target="_blank"} with a tag, and use the named tag in the `.gitlab-ci.yml` file
76
96
77
97
**Kubernetes executors**
78
-
98
+
79
99
1. Ensure your runner configuration (`config.toml` for example) has the followig:
80
100
``` yaml
81
101
[runners.kubernetes]
@@ -93,7 +113,7 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
0 commit comments