Skip to content

Commit 6296622

Browse files
authored
Additional docs update for GitLab tokens (#2485)
1 parent b94a1ee commit 6296622

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

docs/2.0/docs/pipelines/architecture/security-controls.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,11 @@ See [Setup via Machine Users](/2.0/docs/pipelines/installation/viamachineusers.m
6363
<TabItem value="gitlab" label="GitLab">
6464
Requires the following tokens be created:
6565
- `PIPELINES_GITLAB_TOKEN`: A GitLab access token with `api` scope
66+
- `PIPELINES_GITLAB_READ_TOKEN`: A GitLab access token with `read_repository` scope
6667

67-
Pipelines will also require access to GitHub, however those tokens are generated at runtime via the Gruntwork Management Portal.
68+
See [Setup via Machine Users](/2.0/docs/pipelines/installation/viamachineusers) for more details.
69+
70+
Pipelines will also require access to Gruntwork's GitHub repositories, however those tokens are generated at runtime via the Gruntwork Management Portal.
6871

6972
</TabItem>
7073
</Tabs>
@@ -201,4 +204,4 @@ A read/write apply role for delegated repositories.
201204

202205
:::note
203206
The `delegated-pipelines-plan` and `delegated-pipelines-apply` roles are automatically provisioned for new delegated accounts. Enterprise customers will see pull requests created in the `infrastructure-live-access-control` repository to vend these roles with proper configurations.
204-
:::
207+
:::

docs/2.0/docs/pipelines/installation/addinggitlabrepo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ After setting up Pipelines, you can:
162162
If you encounter issues during setup:
163163

164164
- Ensure your GitLab CI user has the correct permissions to your group and projects
165-
- Verify the `PIPELINES_GITLAB_TOKEN` is set correctly as a CI/CD variable and is *NOT* marked as protected
165+
- Verify that both `PIPELINES_GITLAB_TOKEN` and `PIPELINES_GITLAB_READ_TOKEN` are set correctly as CI/CD variables and are *NOT* marked as protected
166166
- Confirm your GitLab group has been authorized by Gruntwork for Pipelines usage
167167

168168
For further assistance, contact [[email protected]](mailto:[email protected]).

docs/2.0/docs/pipelines/installation/viamachineusers.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ For more information on creating and using GitHub Actions Repository secrets, re
392392
<TabItem value="gitlab" label="GitLab">
393393

394394

395-
For GitLab, Gruntwork Pipelines two CI variables. The first, the `PIPELINES_GITLAB_TOKEN` requires the `Developer`, `Maintainer` or `Owner` role and the scopes listed below. This token will be used to authenticate API calls and access repositories within your GitLab group. The second, the `PIPELINES_GITLAB_READ_TOKEN` will be used to access your own code within GitLab. If not set, Pipelines will default to the `CI_JOB_TOKEN` when accessing internal GitLab hosted code.
395+
For GitLab, Gruntwork Pipelines two CI variables. The first, the `PIPELINES_GITLAB_TOKEN` requires the `Developer`, `Maintainer` or `Owner` role and the scopes listed below. This token will be used to authenticate API calls and access repositories within your GitLab group. The second, the `PIPELINES_GITLAB_READ_TOKEN` will be used to access your own code within GitLab. If not set, Pipelines will default to the `CI_JOB_TOKEN` when accessing internal GitLab hosted code.
396396

397397

398398
### Creating the Access Token
@@ -436,6 +436,7 @@ Add the `PIPELINES_GITLAB_TOKEN` and `PIPELINES_GITLAB_READ_TOKEN` as CI/CD vari
436436
**Checklist:**
437437
<PersistentCheckbox id="via-machine-users-gitlab-5" label="PIPELINES_GITLAB_TOKEN added to CI/CD variables" />
438438
<PersistentCheckbox id="via-machine-users-gitlab-6" label="PIPELINES_GITLAB_READ_TOKEN added to CI/CD variables" />
439+
439440
:::caution
440441
Remember to update this token before it expires to prevent pipeline disruptions.
441442
:::

0 commit comments

Comments
 (0)