diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index 44bfde0385..7f8e1bdd97 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -1,14 +1,23 @@ :_mod-docs-content-type: ASSEMBLY [id="bulk-importing-github-repositories"] -= Bulk importing GitHub repositories += Bulk importing in {product} include::{docdir}/artifacts/snip-technology-preview.adoc[] -{product} can automate GitHub repositories onboarding and track their import status. +{product} can automate the onboarding of GitHub repositories and GitLab projects, and track their import status. + +include::modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc[leveloffset=+1] + +include::modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc[leveloffset=+1] + +include::modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc[leveloffset=+1] + +include::modules/streamline-software-development-and-management/proc-monitoring-bulk-import-actions-using-audit-logs.adoc[leveloffset=+1] include::modules/importing-repositories/concept-bulk-import-scaffolder-template.adoc[leveloffset=+1] include::modules/importing-repositories/procedure-integrating-bulk-import-with-orchestrator-workflows.adoc[leveloffset=+1] -include::modules/importing-repositories/concept-data-handoff-and-custom-workflow-design.adoc[leveloffset=+1] \ No newline at end of file +include::modules/importing-repositories/concept-data-handoff-and-custom-workflow-design.adoc[leveloffset=+1] + diff --git a/modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc b/modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc new file mode 100644 index 0000000000..d7ba816c1f --- /dev/null +++ b/modules/importing-repositories/proc-importing-multiple-repositories-from-gitlab.adoc @@ -0,0 +1,36 @@ +:_mod-docs-content-type: PROCEDURE + +[id="importing-multiple-repositories-from-gitlab"] += Importing multiple GitLab repositories + +In {product}, you can select your GitLab projects and automate their onboarding to the {product-short} catalog. +This feature is a Technology preview. + +[IMPORTANT] +==== +Technology Preview features provide early access to upcoming product innovations, enabling you to test functionality and provide feedback during the development process. +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. +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. +See: link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview support scope]. +==== + +.Prerequisites +* 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]. +* You have set up a link:https://docs.gitlab.com/user/profile/personal_access_tokens/[GitLab personal access token (PAT)]. + +.Procedure +. In {product-very-short}, click *Bulk Import* +. Click *Import*. +. Select GitLab as your *Approval tool* option. +. Use the *Project* and *Group* views to see the list of all available GitLab projects and groups: +** Use the *Project* view to select GitLab projects for importing. +** Use the *Group* view to select GitLab groups and their associated projects for importing. +. In GitLab, review the automatically created "Ad `catalog-info.yaml` file" merge request for each project you selected for Bulk Import. +. Merge the merge request. + +.Verification +. In {product-very-short}, click *Bulk Import* +. In the *Imported entities* list, each imported GitLab project has the appropriate status: either _Waiting for approval_ or _Added_. +* For each _Waiting for approval_ import job listed, there is a corresponding merge request adding the `catalog-info.yaml` file in the corresponding project. + + diff --git a/modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc b/modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc index bc9fa7bc14..cb6c4c24e5 100644 --- a/modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc +++ b/modules/streamline-software-development-and-management/proc-enabling-and-authorizing-bulk-import-capabilities.adoc @@ -4,9 +4,11 @@ = Enabling and authorizing Bulk Import capabilities in {product} You can enable the Bulk Import feature for users and give them the necessary permissions to access it. +This feature is available for GitHub repositories and GitLab projects. .Prerequisites -* You have {integrating-with-github-book-link}#enabling-github-repository-discovery[enabled GitHub repository discovery]. +* For GitHub only: You have {integrating-with-github-book-link}#enabling-github-repository-discovery[enabled GitHub repository discovery]. + .Procedure . 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 .Verification * The sidebar displays a *Bulk Import* option. -* The *Bulk Import* page shows a list of *Added Repositories*. +* The *Bulk Import* page shows a list of added GitHub repositories and GitLab projects. + diff --git a/modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc b/modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc index 3041dfc289..ab56822eff 100644 --- a/modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc +++ b/modules/streamline-software-development-and-management/proc-importing-multiple-repositories-from-github.adoc @@ -33,6 +33,6 @@ To view more details about the reasons, click *Edit*. . Review and merge each pull request that creates a `catalog-info.yml` file. .Verification -* The *Added repositories* list displays the repositories you imported, each with an appropriate status: either _Waiting for approval_ or _Added_. +* The *Added entities* list displays the repositories you imported, each with an appropriate status: either _Waiting for approval_ or _Added_. * For each _Waiting for approval_ import job listed, there is a corresponding pull request adding the `catalog-info.yaml` file in the corresponding repository. diff --git a/modules/streamline-software-development-and-management/proc-managing-repositories-after-import-to-stay-organized.adoc b/modules/streamline-software-development-and-management/proc-managing-repositories-after-import-to-stay-organized.adoc index ec16f0306b..763324737a 100644 --- a/modules/streamline-software-development-and-management/proc-managing-repositories-after-import-to-stay-organized.adoc +++ b/modules/streamline-software-development-and-management/proc-managing-repositories-after-import-to-stay-organized.adoc @@ -1,32 +1,32 @@ :_mod-docs-content-type: PROCEDURE -[id="managing-repositories-after-import-to-stay-organized"] -= Managing repositories after import to stay organized +[id="managing-the-added-repositories"] += Managing the added Git repositories -You can oversee and manage the repositories that are imported to the {product-short}. +You can oversee and manage the Git repositories that are imported to the {product-short}. .Prerequisites * You have xref:proc-importing-multiple-repositories-from-github[imported GitHub repositories]. .Procedure -. Click *Bulk Import* in the left sidebar to display all the current repositories that are being tracked as Import jobs, along with their status. +. 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. -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. +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. Note that it may take a few minutes for the entities to be available in the catalog. -Waiting for approval:: There is an open pull request adding a `catalog-info.yaml` file to the repository. +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. You can: -* Click the *pencil icon* on the right to see details about the pull request or edit the pull request content right from {product-short}. -* Delete the Import job, this action closes the import PR as well. -* To transition the Import job to the _Added_ state, merge the import pull request from the Git repository. +* 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}. +* Delete the Import job, this action closes the import pull request or merge request as well. +* To transition the Import job to the _Added_ state, merge the import pull request or merge request from the Git repository. -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. +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. [NOTE] ==== -* 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. -* 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: -** The target repository is accessible from the configured GitHub integrations. -** The location URL points to a `catalog-info.yaml` file at the root of the repository default branch. +* 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. +* 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: +** The location URL points to a `catalog-info.yaml` file at the root of the Git repository default branch. +** For GitHub only: The target repository is accessible from the configured GitHub integrations. ====