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/modules/ROOT/pages/getting-started.adoc
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,11 +62,13 @@ To view the integration test Custom Resource:
62
62
oc get integrationtestscenarios -n <tenant-namespace>
63
63
----
64
64
65
-
. **Creates CI checks** on the pull request. {KonfluxName} creates checks for both GitHub and GitLab. The difference is how the integration with {KonfluxName} is managed: for GitHub, a GitHub App is created ahead of time during installation; for GitLab, the webhook is created when the repository is onboarded. Two checks appear:
65
+
. **Creates CI checks** on the pull request. Two checks appear:
66
66
* One for the build pipeline status
67
67
* One for the integration test pipeline status
68
68
+
69
69
You can click through to view logs and additional information.
70
+
+
71
+
For GitLab, the webhook is created and configured in the repository.
70
72
71
73
IMPORTANT: Do not merge this pull request yet. Configure a release first so you can see the full end-to-end flow.
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/installing.adoc
+9-37Lines changed: 9 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -160,61 +160,33 @@ NOTE: The installer may log an error about failing to open the browser. This is
160
160
161
161
== Configure the GitLab integration
162
162
163
-
If you are using GitLab instead of GitHub, configure the GitLab integration. Create a Project Access Token for each GitLab project that you want to onboard to {TSFShortName}.
163
+
If you are using GitLab instead of GitHub, configure the GitLab integration. The installer creates the required namespace and secret for the `default-tenant` automatically during deployment.
164
164
165
165
=== Prerequisites
166
166
167
167
* You have started the {TSFShortName} installer container.
168
168
* You are logged in to the {OCPShortName} cluster.
169
-
* You have a GitLab project that you want to onboard.
169
+
* You have prepared the GitLab variables (`GITLAB__HOST`, `GITLAB__GROUP`, `GITLAB__TOKEN`) in your `tsf.env` file.
170
170
171
171
=== Steps
172
172
173
-
. In your GitLab project, create a Project Access Token:
174
-
.. Navigate to *Settings* > *Access Tokens*.
175
-
.. Enter a name for the token, for example, `tsf-integration`.
176
-
.. Select the *Maintainer* role.
177
-
.. Select the following scopes: `api`, `read_repository`, `write_repository`.
178
-
.. Click *Create project access token*.
179
-
.. Copy the token value.
180
-
181
-
. Create a Kubernetes secret in the tenant namespace that contains the GitLab credentials:
182
-
+
183
-
[source,bash]
184
-
----
185
-
oc create secret generic gitlab-auth-secret \
186
-
-n <tenant-namespace> \
187
-
--from-literal=password="$GITLAB__TOKEN" \
188
-
--type=kubernetes.io/basic-auth
189
-
----
190
-
+
191
-
The default tenant namespace is `default-tenant`. If multiple namespaces are used, the secret must be created in each namespace where you onboard components. For more information about tenant namespaces, see link:https://konflux-ci.dev/docs/advanced-how-tos/managing/environments/[Managing environments] in the {KonfluxName} documentation.
192
-
193
-
. Label the secret so that {KonfluxName} can discover it:
194
-
+
195
-
[source,bash]
196
-
----
197
-
oc label secret gitlab-auth-secret \
198
-
-n <tenant-namespace> \
199
-
appstudio.redhat.com/credentials=scm
200
-
----
201
-
202
-
. Annotate the secret with the GitLab host:
173
+
. Configure the GitLab integration:
203
174
+
204
175
[source,bash]
205
176
----
206
-
oc annotate secret gitlab-auth-secret \
207
-
-n <tenant-namespace> \
208
-
appstudio.redhat.com/scm.host="$GITLAB__HOST"
177
+
tsf integration gitlab \
178
+
--group="$GITLAB__GROUP" \
179
+
--host="$GITLAB__HOST" \
180
+
--token="$GITLAB__TOKEN"
209
181
----
210
182
211
183
=== Verification
212
184
213
-
Verify that the secret was created:
185
+
Verify that the GitLab integration secret was created:
214
186
215
187
[source,bash]
216
188
----
217
-
oc get secret gitlab-auth-secret -n <tenant-namespace>
0 commit comments