Skip to content

Commit 71d0451

Browse files
deerskindolljmagak
deerskindoll
and
jmagak
authored
RHIDP-8631: bulk import with gitlab (#1474)
* RHIDP-8631 RHIDP-8631 RHIDP-8631 added gitlab to bulk import docs Update proc-importing-multiple-repositories-from-gitlab.adoc Update modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc Co-authored-by: Judith Magak <124673476+jmagak@users.noreply.github.com> Update modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc Co-authored-by: Judith Magak <124673476+jmagak@users.noreply.github.com> Update modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc Co-authored-by: Judith Magak <124673476+jmagak@users.noreply.github.com> Update modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc Co-authored-by: Judith Magak <124673476+jmagak@users.noreply.github.com> test test test test * fixed file paths * fixed file paths * fixed file paths * Update modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc Co-authored-by: Judith Magak <124673476+jmagak@users.noreply.github.com> --------- Co-authored-by: Judith Magak <124673476+jmagak@users.noreply.github.com>
1 parent 54f68b8 commit 71d0451

File tree

5 files changed

+68
-20
lines changed

5 files changed

+68
-20
lines changed

‎assemblies/assembly-bulk-importing-from-github.adoc‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,23 @@
11
:_mod-docs-content-type: ASSEMBLY
22

33
[id="bulk-importing-github-repositories"]
4-
= Bulk importing GitHub repositories
4+
= Bulk importing in {product}
55

66
include::{docdir}/artifacts/snip-technology-preview.adoc[]
77

8-
{product} can automate GitHub repositories onboarding and track their import status.
8+
{product} can automate the onboarding of GitHub repositories and GitLab projects, and track their import status.
9+
10+
include::modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc[leveloffset=+1]
11+
12+
include::modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc[leveloffset=+1]
13+
14+
include::modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc[leveloffset=+1]
15+
16+
include::modules/streamline-software-development-and-management/proc-monitoring-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1]
917

1018
include::modules/importing-repositories/concept-bulk-import-scaffolder-template.adoc[leveloffset=+1]
1119

1220
include::modules/importing-repositories/procedure-integrating-bulk-import-with-orchestrator-workflows.adoc[leveloffset=+1]
1321

14-
include::modules/importing-repositories/concept-data-handoff-and-custom-workflow-design.adoc[leveloffset=+1]
22+
include::modules/importing-repositories/concept-data-handoff-and-custom-workflow-design.adoc[leveloffset=+1]
23+

‎modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
3+
[id="importing-multiple-repositories-from-gitlab"]
4+
= Importing multiple GitLab repositories
5+
6+
In {product}, you can select your GitLab projects and automate their onboarding to the {product-short} catalog.
7+
This feature is a Technology preview.
8+
9+
[IMPORTANT]
10+
====
11+
Technology Preview features provide early access to upcoming product innovations, enabling you to test functionality and provide feedback during the development process.
12+
However, these features are not fully supported under Red Hat Subscription Level Agreements, may not be functionally complete, and are not intended for production use.
13+
As Red Hat considers making future iterations of Technology Preview features generally available, we will attempt to resolve any issues that customers experience when using these features.
14+
See: link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview support scope].
15+
====
16+
17+
.Prerequisites
18+
* You have include::modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc[enabled the Bulk Import feature and given access to it].
19+
* You have set up a link:https://docs.gitlab.com/user/profile/personal_access_tokens/[GitLab personal access token (PAT)].
20+
21+
.Procedure
22+
. In {product-very-short}, click *Bulk Import*
23+
. Click *Import*.
24+
. Select GitLab as your *Approval tool* option.
25+
. Use the *Project* and *Group* views to see the list of all available GitLab projects and groups:
26+
** Use the *Project* view to select GitLab projects for importing.
27+
** Use the *Group* view to select GitLab groups and their associated projects for importing.
28+
. In GitLab, review the automatically created "Ad `catalog-info.yaml` file" merge request for each project you selected for Bulk Import.
29+
. Merge the merge request.
30+
31+
.Verification
32+
. In {product-very-short}, click *Bulk Import*
33+
. In the *Imported entities* list, each imported GitLab project has the appropriate status: either _Waiting for approval_ or _Added_.
34+
* For each _Waiting for approval_ import job listed, there is a corresponding merge request adding the `catalog-info.yaml` file in the corresponding project.
35+
36+

‎modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
= Enabling and authorizing Bulk Import capabilities in {product}
55

66
You can enable the Bulk Import feature for users and give them the necessary permissions to access it.
7+
This feature is available for GitHub repositories and GitLab projects.
78

89
.Prerequisites
9-
* You have {integrating-with-github-book-link}#enabling-github-repository-discovery[enabled GitHub repository discovery].
10+
* For GitHub only: You have {integrating-with-github-book-link}#enabling-github-repository-discovery[enabled GitHub repository discovery].
11+
1012

1113
.Procedure
1214
. The Bulk Import plugins are installed but disabled by default.
@@ -38,5 +40,6 @@ See {authorization-book-link}#ref-rbac-permission-policies_title-authorization[P
3840

3941
.Verification
4042
* The sidebar displays a *Bulk Import* option.
41-
* The *Bulk Import* page shows a list of *Added Repositories*.
43+
* The *Bulk Import* page shows a list of added GitHub repositories and GitLab projects.
44+
4245

‎modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,6 @@ To view more details about the reasons, click *Edit*.
3333
. Review and merge each pull request that creates a `catalog-info.yml` file.
3434

3535
.Verification
36-
* The *Added repositories* list displays the repositories you imported, each with an appropriate status: either _Waiting for approval_ or _Added_.
36+
* The *Added entities* list displays the repositories you imported, each with an appropriate status: either _Waiting for approval_ or _Added_.
3737
* For each _Waiting for approval_ import job listed, there is a corresponding pull request adding the `catalog-info.yaml` file in the corresponding repository.
3838

‎modules/streamline-software-development-and-management/proc-managing-repositories-after-import-to-stay-organized.adoc‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
:_mod-docs-content-type: PROCEDURE
22

3-
[id="managing-repositories-after-import-to-stay-organized"]
4-
= Managing repositories after import to stay organized
3+
[id="managing-the-added-repositories"]
4+
= Managing the added Git repositories
55

6-
You can oversee and manage the repositories that are imported to the {product-short}.
6+
You can oversee and manage the Git repositories that are imported to the {product-short}.
77

88
.Prerequisites
99
* You have xref:proc-importing-multiple-repositories-from-github[imported GitHub repositories].
1010

1111

1212
.Procedure
13-
. Click *Bulk Import* in the left sidebar to display all the current repositories that are being tracked as Import jobs, along with their status.
13+
. Click *Bulk Import* in the left sidebar to display all the current GitHub repositories and GitLab projects that are being tracked as Import jobs, along with their status.
1414

15-
Added:: The repository is added to the {product-short} catalog after the import pull request is merged or if the repository already contained a `catalog-info.yaml` file during the bulk import.
15+
Added:: The Git repository is added to the {product-short} catalog after the import pull request is merged or if the Git repository already contained a `catalog-info.yaml` file during the bulk import.
1616
Note that it may take a few minutes for the entities to be available in the catalog.
1717

18-
Waiting for approval:: There is an open pull request adding a `catalog-info.yaml` file to the repository.
18+
Waiting for approval:: There is an open pull request or merge request adding a `catalog-info.yaml` file to the GitHub repository or GitLab project.
1919
You can:
20-
* Click the *pencil icon* on the right to see details about the pull request or edit the pull request content right from {product-short}.
21-
* Delete the Import job, this action closes the import PR as well.
22-
* To transition the Import job to the _Added_ state, merge the import pull request from the Git repository.
20+
* Click *pencil* icon on the right to see details about the pull request or merge request. You can use the detailed view to edit the request content right from {product-short}.
21+
* Delete the Import job, this action closes the import pull request or merge request as well.
22+
* To transition the Import job to the _Added_ state, merge the import pull request or merge request from the Git repository.
2323

24-
Empty:: {product-short} is unable to determine the import job status because the repository is imported from other sources but does not have a `catalog-info.yaml` file and lacks any import pull request adding it.
24+
Empty:: {product-short} is unable to determine the import job status because the Git repository is imported from other sources but does not have a `catalog-info.yaml` file and lacks any import pull or merge request adding it.
2525

2626
[NOTE]
2727
====
28-
* After an import pull request is merged, the import status is marked as _Added_ in the list of Added Repositories, but it might take a few seconds for the corresponding entities to appear in the {product-short} Catalog.
29-
* A location added through other sources (like statically in an `{my-app-config-file}` file, dynamically when {integrating-with-github-book-link}#enabling-github-repository-discovery[enabling GitHub discovery], or registered manually using the "Register an existing component" page) might show up in the Bulk Import list of Added Repositories if the following conditions are met:
30-
** The target repository is accessible from the configured GitHub integrations.
31-
** The location URL points to a `catalog-info.yaml` file at the root of the repository default branch.
28+
* After an import pull request or merge request is merged, the import status is marked as _Added_ in the list of *Added entities*, but it might take a few seconds for the corresponding entities to appear in the {product-short} Catalog.
29+
* A location added through other sources (for example, statically in an `{my-app-config-file}` file, dynamically when {integrating-with-github-book-link}#enabling-github-repository-discovery[enabling GitHub discovery], or registered manually using the "Register an existing component" page) might show up in the Bulk Import list of Added Repositories if the following conditions are met:
30+
** The location URL points to a `catalog-info.yaml` file at the root of the Git repository default branch.
31+
** For GitHub only: The target repository is accessible from the configured GitHub integrations.
3232
====

0 commit comments

Comments
 (0)