Skip to content

Commit 6b39d07

Browse files
committed
fixed bullet list
1 parent 1200fed commit 6b39d07

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed

docs/bitbucket-installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ description: Install gitStream to your Bitbucket workspace.
2323
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.
2424

2525
There are two primary cases where this matters for gitStream:
26+
2627
1. **Webhook Event Handling by gitStream**
2728
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+
2830
2. **Outbound Requests from Your CI Runner**
2931
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.
3032

docs/github-installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,18 @@ description: Install gitStream to your GitHub organization.
66

77
!!! Info "Prerequisites"
88
Allowed network connection between the runners and the following IPs:
9-
9+
1010
- 13.56.203.235
1111
- 54.151.81.98
1212

1313
??? Info "Understanding IP Allowlisting for gitStream"
1414
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.
1515

1616
There are two primary cases where this matters for gitStream:
17+
1718
1. **Webhook Event Handling by gitStream**
1819
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+
1921
2. **Outbound Requests from Your CI Runner**
2022
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.
2123

docs/gitlab-installation.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ description: Install gitStream to your GitLab organization.
1717
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.
1818

1919
There are two primary cases where this matters for gitStream:
20+
2021
1. **Webhook Event Handling by gitStream**
2122
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+
2224
2. **Outbound Requests from Your CI Runner**
2325
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.
2426

@@ -36,11 +38,11 @@ GitLab Installation Overview
3638
1. Designate a gitStream user account.
3739
1. Create a `cm` repo and `.cm` configuration file.
3840
1. Create a GitLab pipeline.
39-
1. Connect gitStream in LinearB.
41+
1. Connect gitStream in LinearB.
4042

4143
## Designate a gitStream User Account
4244

43-
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.
4446

4547
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.
4648

@@ -68,7 +70,7 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
6870
=== "GitLab-Hosted runners"
6971

7072
**Gitlab-Hosted Runners**
71-
73+
7274
Use the following `.gitlab-ci.yml`
7375

7476
``` yaml+jinja
@@ -86,14 +88,14 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
8688
``` yaml+jinja
8789
--8<-- "docs/downloads/gitlab-shell-ci.yml"
8890
```
89-
91+
9092
=== "Self-Managed Runners - Kubernetes"
9193
**Self-Managed Runners**
9294

9395
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
9496

9597
**Kubernetes executors**
96-
98+
9799
1. Ensure your runner configuration (`config.toml` for example) has the followig:
98100
``` yaml
99101
[runners.kubernetes]
@@ -111,7 +113,7 @@ Once your gitStream configuration file is set up, you need a GitLab CI configura
111113
- ...
112114
- docker pull YOUR-REGISTRY-URL/gitstream/rules-engine:latest
113115
```
114-
The docker image can be pulled to your private repository from [DockerHub](https://hub.docker.com/r/gitstream/rules-engine){:target=_blank}.
116+
The docker image can be pulled to your private repository from [DockerHub](https://hub.docker.com/r/gitstream/rules-engine){:target=_blank}.
115117

116118
## Connect gitStream in LinearB
117119

@@ -135,5 +137,3 @@ The required permissions are:
135137
| Read/Write API | To get notified on MR changes and allow gitStream to approve MRs once all conditions are met |
136138
| Read repository | To read and check rules over the code changes on monitored repositories |
137139
| Read user profile | Used to identify users |
138-
139-

0 commit comments

Comments
 (0)