From 5508792fa56eacf954118f7ed2883d5733401e3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Fri, 11 Oct 2024 13:30:26 +0200 Subject: [PATCH 01/49] RHIDP-1925 bulk import from GitHub MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- .../assembly-bulk-importing-from-github.adoc | 15 ++++ ...g-the-bulk-import-from-github-feature.adoc | 22 ++++++ ...ing-multiple-repositories-from-github.adoc | 37 ++++++++++ ...managing-the-imported-repository-list.adoc | 25 +++++++ ...-understanding-bulk-import-audit-logs.adoc | 69 +++++++++++++++++++ ...understanding-bulk-import-limitations.adoc | 13 ++++ .../title-getting-started.adoc | 1 + 7 files changed, 182 insertions(+) create mode 100644 assemblies/assembly-bulk-importing-from-github.adoc create mode 100644 modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc create mode 100644 modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc create mode 100644 modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc create mode 100644 modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc create mode 100644 modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc new file mode 100644 index 0000000000..47998f527c --- /dev/null +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -0,0 +1,15 @@ += Bulk Import GitHub repositories + +Bulk Import is a {company-name} *Tech Preview* feature. + +It allows you to automate GitHub repositories onboarding and track their import status. + +include::modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc[leveloffset=+1] + +include::modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc[leveloffset=+1] + +include::modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc[leveloffset=+1] + +include::modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc[leveloffset=+1] + +include::modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc[leveloffset=+1] diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc new file mode 100644 index 0000000000..833083dcf5 --- /dev/null +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -0,0 +1,22 @@ +[id="enabling-ang-giving-access-to-the-bulk-import-feature"] += Enabling and giving access to the Bulk Import feature + +.Procedure +. To give {product-short} access to GitHub, link:{linkgettingstartedguide}#configuring-github-integration[configure GitHub integration]. + +. The Bulk Import plugin is installed but disabled by default. +Enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import` preinstalled plugins. +See link:{plugins-configure-book-url}[{plugins-configure-book-title}]. + +. Only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. +Configure the required `bulk.import` RBAC permission for the users that are not administrators. +See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. + + +.Verification +* The sidebar displays a *Bulk Import* line. +* The *Bulk Import* page shows a list of *Added Repositories*. + +.Troubleshooting +* If clicking on the *Bulk Import* option displays the following error message: _To view the added repositories, contact your administrator to give you the `bulk.import` permission_, it means that your user does not have the necessary permission to use the Bulk Import feature. +Refer back to link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub] for more information on how an administrator can add that permission to your user. diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc new file mode 100644 index 0000000000..1c1a3e3c1b --- /dev/null +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -0,0 +1,37 @@ += Importing multiple repositories + +The Bulk Import feature allows you to view all the GitHub repositories and organizations accessible from the configured GitHub Integrations. +From there, you can pick any number of repositories and onboard them. + +.Prerequisites +* xref:enabling-ang-giving-access-to-the-bulk-import-feature[You enabled the Bulk Import feature]. +* xref:enabling-ang-giving-access-to-the-bulk-import-feature[Your {product-short} user has access to the Bulk Import feature]. + +.Procedure +. Click on *Bulk Import* in the left sidebar. +. Click on the *Add* button in the top-right corner to see the list of all repositories accessible from the configured GitHub integrations. +.. From the *Repositories* view, you can select any repository, or search for any accessible repositories. +For each repository selected, a `catalog-info.yaml` will be generated. +.. From the *Organizations* view, you can select any organization by clicking on *Select* in the third column. +This will allow you to pick one or more repositories that are part of the selected organization. +. Click on *Preview file* to view or edit the details of the pull request for each repository. +The pull request details form will be preloaded with some data, and you can also preview the content of the `catalog-info.yaml`. +If the repository already has a `.github/CODEOWNERS` file, you can select the *Use CODEOWNERS file as Entity Owner* checkbox to use it, rather than having the `content-info.yaml` contain a specific entity owner. +. Click on *Save*. +. Click on *Create pull requests*. +At this point, a set of dry-run checks will be run against the selected repositories to make sure they meet the requirements to be imported, that is: +.. Checking that there is no entity in the Developer Hub catalog with the name specified in the repository `catalog-info.yaml` +.. Checking that the repository is not empty +.. Checking that the repository already has a `.github/CODEOWNERS` file if the *Use CODEOWNERS file as Entity Owner* checkbox was selected for that repository. + +** If there are any errors, the pull requests will not be created, but you will see a _Failed to create PR_ error message indicating the failures. +Clicking on *Edit* will show more details about the reasons. + +** If there are no errors, the pull requests will be created, and you will be redirected to the list of Added repositories. + +. Review and merge each pull request that creates a `catalog-info.yml` file. + +.Verification +* The *Added repositories* list displays the repositories you just 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/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc new file mode 100644 index 0000000000..978f471ab2 --- /dev/null +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -0,0 +1,25 @@ += Managing the list of Added repositories + +.Procedure +. Click on *Bulk Import* in the left sidebar to display all the current repositories that are being tracked as Import jobs, along with their status. + +Added:: The repository has been added to the Developer Hub catalog. +This can be the case after the import PR has been merged, or if the repository already had a `catalog-info.yaml` when it was bulk-imported. +Please note that it might take a few minutes until the entities are available in the catalog. + +Waiting for approval:: There is an open pull request adding a `catalog-info.yaml`. +You can: +* Click on the *pencil icon* on the right to see details about this pull request or edit the pull request content right from {product-short}. +* Delete the Import job, in which case the import PR will be closed as well. +* To transition the Import job to the _Added_ state, merge the import pull request from the Git repository. + +Empty:: {product-short} was not able to determine the Import job status. +This can be the case if the repository was imported from other sources but does not have any `catalog-info.yaml` file and does not have any import PR adding it. + +[NOTE] +==== +* After an import pull request is merged, the Import status will be _Added_ in the list of Added Repositories, but it might take a few seconds until the corresponding entities show up in the Developer Hub Catalog. +* A Location added through other sources (like statically in an `app-config.yaml` file, dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery], or registered manually via the "Register an existing component" page) may show up in the Bulk Import list of Added Repositories if both 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. +==== diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc new file mode 100644 index 0000000000..718e0d538b --- /dev/null +++ b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc @@ -0,0 +1,69 @@ += Bulk Import Audit Logs + +The Bulk Import Backend plugin adds the events below to the Developer Hub audit logs. +See link:{linkgettingstartedguide}#assembly-audit-log[Audit Logs in {product}] for more information on how to configure and view such audit logs. + +*Bulk Import Events*: + +`BulkImportUnknownEndpoint`:: +Tracks requests to unknown endpoints. + +`BulkImportPing`:: +Tracks `GET` requests to the `/ping` endpoint, which allows us to make sure the bulk import backend is up and running. + +`BulkImportFindAllOrganizations`:: +Tracks `GET` requests to the /organizations endpoint, which returns the list of organizations accessible from all configured GitHub Integrations. + +`BulkImportFindRepositoriesByOrganization`:: +Tracks `GET` requests to the `/organizations/:orgName/repositories` endpoint, which returns the list of repositories for the specified organization (accessible from any of the configured GitHub Integrations). + +`BulkImportFindAllRepositories`:: +Tracks GET requests to the `/repositories` endpoint, which returns the list of repositories accessible from all configured GitHub Integrations. + +`BulkImportFindAllImports`:: +Tracks `GET` requests to the `/imports` endpoint, which returns the list of existing import jobs along with their statuses. + +`BulkImportCreateImportJobs`:: +Tracks `POST` requests to the `/imports` endpoint, which allows to submit requests to bulk-import one or many repositories into the Developer Hub Catalog, by eventually creating import Pull Requests in the target repositories. + +`BulkImportFindImportStatusByRepo`:: +Tracks `GET` requests to the `/import/by-repo` endpoint, which fetches details about the import job for the specified repository. + +`BulkImportDeleteImportByRepo`:: +Tracks `DELETE` requests to the `/import/by-repo` endpoint, which deletes any existing import job for the specified repository, by closing any open import Pull Request that could have been created. + +.Example +[code,json] +---- +{ + "actor": { + "actorId": "user:default/myuser", + "hostname": "localhost", + "ip": "::1", + "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/128.0.0.0 Safari/537.36" + }, + "eventName": "BulkImportFindAllOrganizations", + "isAuditLog": true, + "level": "info", + "message": "'get /organizations' endpoint hit by user:default/myuser", + "meta": {}, + "plugin": "bulk-import", + "request": { + "body": {}, + "method": "GET", + "params": {}, + "query": { + "pagePerIntegration": "1", + "sizePerIntegration": "5" + }, + "url": "/api/bulk-import/organizations?pagePerIntegration=1&sizePerIntegration=5" + }, + "response": { + "status": 200 + }, + "service": "backstage", + "stage": "completion", + "status": "succeeded", + "timestamp": "2024-08-26 16:41:02" +} +---- diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc new file mode 100644 index 0000000000..6218c362cb --- /dev/null +++ b/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc @@ -0,0 +1,13 @@ += Bulk Import limitations + +* Only the first 20 repositories (in alphabetical order) can be displayed at most on the Added Repositories page. +Also, the count of Added Repositories displayed might be wrong. +In future releases, we plan to address this with proper pagination. +Meanwhile, as a workaround, searching would still work against all Added Repositories. +So you can still search any Added Repository and get it listed on the table. +See https://issues.redhat.com/browse/RHIDP-4067[RHIDP-4067]. + +* Repositories might be added to {product-short} from various sources (like statically in an app-config file or dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery]). +By design, the bulk import plugin will only track repositories that are accessible from the configured GitHub integrations. +However, deleting a repository from the Bulk Imports listing page may not work if the repository was discovered by the GitHub discovery plugin. +See https://issues.redhat.com/browse/RHIDP-3931[RHIDP-3931]. diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc index 37955d6d04..a98c25dde5 100644 --- a/titles/getting-started-rhdh/title-getting-started.adoc +++ b/titles/getting-started-rhdh/title-getting-started.adoc @@ -20,6 +20,7 @@ include::modules/installation/ref-rhdh-sizing.adoc[leveloffset=+1] include::modules/getting-started/ref-rhdh-supported-configs.adoc[leveloffset=+1] include::assemblies/assembly-add-custom-app-file-openshift.adoc[leveloffset=+2] include::modules/getting-started/proc-add-source-control-rhdh-catalog.adoc[leveloffset=+2] +include::assemblies/assembly-bulk-importing-from-github.adoc[leveloffset=+3] include::modules/getting-started/proc-customize-rhdh-homepage.adoc[leveloffset=+1] include::modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc[leveloffset=+1] From 144b226af7470f3924b7e663f05ba3f06c6edcca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Fri, 11 Oct 2024 15:06:49 +0200 Subject: [PATCH 02/49] added YAML fragment MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- ...g-the-bulk-import-from-github-feature.adoc | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 833083dcf5..930283ead4 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -4,9 +4,24 @@ .Procedure . To give {product-short} access to GitHub, link:{linkgettingstartedguide}#configuring-github-integration[configure GitHub integration]. -. The Bulk Import plugin is installed but disabled by default. -Enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import` preinstalled plugins. +. The Bulk Import plugins are installed but disabled by default. +To enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import` plugins, +edit your `dynamic-plugins.yaml` with following content. See link:{plugins-configure-book-url}[{plugins-configure-book-title}]. ++ +.`dynamic-plugins.yaml` fragment +[source,yaml] +---- +global: + dynamic: + includes: + - dynamic-plugins.default.yaml + plugins: + - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic + disabled: false + - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import + disabled: false +---- . Only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. Configure the required `bulk.import` RBAC permission for the users that are not administrators. From c17d774fb89cf4ae2bb6fa573f1db454a6f097ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 14 Oct 2024 11:13:12 +0200 Subject: [PATCH 03/49] Update assemblies/assembly-bulk-importing-from-github.adoc Co-authored-by: Armel Soro --- assemblies/assembly-bulk-importing-from-github.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index 47998f527c..10e283174e 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -1,6 +1,6 @@ = Bulk Import GitHub repositories -Bulk Import is a {company-name} *Tech Preview* feature. +Bulk Import is a https://access.redhat.com/support/offerings/techpreview[{company-name} *Tech Preview*] feature. It allows you to automate GitHub repositories onboarding and track their import status. From caf5f41fccdb7fe35b546e6484208462c8cf9fad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 14 Oct 2024 11:15:19 +0200 Subject: [PATCH 04/49] Update modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc Co-authored-by: Armel Soro --- .../procedure-managing-the-imported-repository-list.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc index 978f471ab2..b2a2a520ae 100644 --- a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -1,5 +1,10 @@ = Managing the list of Added repositories +.Prerequisites +* xref:enabling-ang-giving-access-to-the-bulk-import-feature[You enabled the Bulk Import feature]. +* xref:enabling-ang-giving-access-to-the-bulk-import-feature[Your {product-short} user has access to the Bulk Import feature]. + + .Procedure . Click on *Bulk Import* in the left sidebar to display all the current repositories that are being tracked as Import jobs, along with their status. From 3dbf3201b9f71424c7dd71b10ec225c2daee9991 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 14 Oct 2024 11:17:55 +0200 Subject: [PATCH 05/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc --- ...abling-the-bulk-import-from-github-feature.adoc | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 930283ead4..e4e6888b9b 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -12,15 +12,11 @@ See link:{plugins-configure-book-url}[{plugins-configure-book-title}]. .`dynamic-plugins.yaml` fragment [source,yaml] ---- -global: - dynamic: - includes: - - dynamic-plugins.default.yaml - plugins: - - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic - disabled: false - - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import - disabled: false +plugins: + - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic + disabled: false + - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import + disabled: false ---- . Only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. From b6e10fcf1d5eae959772ad2c82446d2f2705774f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 14 Oct 2024 11:20:51 +0200 Subject: [PATCH 06/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc --- ...ure-enabling-the-bulk-import-from-github-feature.adoc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index e4e6888b9b..c95fce818b 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -22,6 +22,15 @@ plugins: . Only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. Configure the required `bulk.import` RBAC permission for the users that are not administrators. See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. ++ +.`rbac-policy.csv` fragment +[source,csv,subs="+quotes"] +---- +p, role:default/bulk-import, bulk.import, use, allow +p, role:default/bulk-import, catalog-entity.read, read, allow +p, role:default/bulk-import, catalog.entity.create, create, allow +g, user:default/____, role:default/bulk-import +---- .Verification From 1e1b3bbf3df229b4a0cd009bc7144e2a12cdbf7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 14 Oct 2024 11:23:50 +0200 Subject: [PATCH 07/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index c95fce818b..d351b10b30 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -7,7 +7,7 @@ . The Bulk Import plugins are installed but disabled by default. To enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import` plugins, edit your `dynamic-plugins.yaml` with following content. -See link:{plugins-configure-book-url}[{plugins-configure-book-title}]. +See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. + .`dynamic-plugins.yaml` fragment [source,yaml] From 1f985ce1094b85ec5acf5771a67e7d715eaa6a37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Mon, 14 Oct 2024 11:33:06 +0200 Subject: [PATCH 08/49] RHIDP-1925 bulk import from GitHub MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- .../ref-rbac-permission-policies.adoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/modules/authorization/ref-rbac-permission-policies.adoc b/modules/authorization/ref-rbac-permission-policies.adoc index 013ceb98eb..f5c4a2b5a2 100644 --- a/modules/authorization/ref-rbac-permission-policies.adoc +++ b/modules/authorization/ref-rbac-permission-policies.adoc @@ -78,6 +78,22 @@ Catalog permissions:: |Allows user or role to delete locations from the catalog |=== +Bulk import permissions:: + +[cols="15%,25%,15%,45%", frame="all", options="header"] +|=== +|Name +|Resource type +|Policy +|Description + +|`bulk.import` +|`bulk-import` +| +|Allows the user to access the bulk import endpoints, such as listing all repositories and organizations accessible by all GitHub integrations and managing the import requests. + +|=== + Scaffolder permissions:: [cols="15%,25%,15%,45%", frame="all", options="header"] From d95792207aa93020cd0b669836ebca7dd10af98a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:00:47 +0200 Subject: [PATCH 09/49] Update titles/getting-started-rhdh/title-getting-started.adoc --- titles/getting-started-rhdh/title-getting-started.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/titles/getting-started-rhdh/title-getting-started.adoc b/titles/getting-started-rhdh/title-getting-started.adoc index a98c25dde5..5b76d962f1 100644 --- a/titles/getting-started-rhdh/title-getting-started.adoc +++ b/titles/getting-started-rhdh/title-getting-started.adoc @@ -20,7 +20,7 @@ include::modules/installation/ref-rhdh-sizing.adoc[leveloffset=+1] include::modules/getting-started/ref-rhdh-supported-configs.adoc[leveloffset=+1] include::assemblies/assembly-add-custom-app-file-openshift.adoc[leveloffset=+2] include::modules/getting-started/proc-add-source-control-rhdh-catalog.adoc[leveloffset=+2] -include::assemblies/assembly-bulk-importing-from-github.adoc[leveloffset=+3] +include::assemblies/assembly-bulk-importing-from-github.adoc[leveloffset=+1] include::modules/getting-started/proc-customize-rhdh-homepage.adoc[leveloffset=+1] include::modules/getting-started/proc-customize-rhdh-tech-radar-page.adoc[leveloffset=+1] From 7558b6c3635eb1dfa9c0a0706daba50d9779bd50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:02:22 +0200 Subject: [PATCH 10/49] Apply suggestions from code review Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- ...procedure-enabling-the-bulk-import-from-github-feature.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index d351b10b30..99ff3f1d1f 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -7,7 +7,6 @@ . The Bulk Import plugins are installed but disabled by default. To enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import` plugins, edit your `dynamic-plugins.yaml` with following content. -See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. + .`dynamic-plugins.yaml` fragment [source,yaml] @@ -18,7 +17,7 @@ plugins: - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import disabled: false ---- - +See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. . Only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. Configure the required `bulk.import` RBAC permission for the users that are not administrators. See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. From b01ac0a697b999d0e64065069196809e8e6cd1f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:03:37 +0200 Subject: [PATCH 11/49] Apply suggestions from code review Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- ...ling-the-bulk-import-from-github-feature.adoc | 5 +++-- ...orting-multiple-repositories-from-github.adoc | 16 ++++++++-------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 99ff3f1d1f..c791e3d67e 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -37,5 +37,6 @@ g, user:default/____, role:default/bulk-import * The *Bulk Import* page shows a list of *Added Repositories*. .Troubleshooting -* If clicking on the *Bulk Import* option displays the following error message: _To view the added repositories, contact your administrator to give you the `bulk.import` permission_, it means that your user does not have the necessary permission to use the Bulk Import feature. -Refer back to link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub] for more information on how an administrator can add that permission to your user. +* If clicking on the *Bulk Import* option displays the following error message: +_To view the added repositories, contact your administrator to give you the `bulk.import` permission_, which means the user does not have the necessary permission to use the Bulk Import feature. +See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub] for more information on how an administrator can add that permission to your user. diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index 1c1a3e3c1b..a1288bce55 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -4,18 +4,18 @@ The Bulk Import feature allows you to view all the GitHub repositories and organ From there, you can pick any number of repositories and onboard them. .Prerequisites -* xref:enabling-ang-giving-access-to-the-bulk-import-feature[You enabled the Bulk Import feature]. -* xref:enabling-ang-giving-access-to-the-bulk-import-feature[Your {product-short} user has access to the Bulk Import feature]. +* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature]. +* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[access to the Bulk Import feature]. .Procedure -. Click on *Bulk Import* in the left sidebar. -. Click on the *Add* button in the top-right corner to see the list of all repositories accessible from the configured GitHub integrations. +. Click *Bulk Import* in the left sidebar. +. Click the *Add* button in the top-right corner to see the list of all repositories accessible from the configured GitHub integrations. .. From the *Repositories* view, you can select any repository, or search for any accessible repositories. -For each repository selected, a `catalog-info.yaml` will be generated. +For each repository selected, a `catalog-info.yaml` is generated. .. From the *Organizations* view, you can select any organization by clicking on *Select* in the third column. -This will allow you to pick one or more repositories that are part of the selected organization. -. Click on *Preview file* to view or edit the details of the pull request for each repository. -The pull request details form will be preloaded with some data, and you can also preview the content of the `catalog-info.yaml`. +This option allows you to select one or more repositories from the selected organization. +. Click *Preview file* to view or edit the details of the pull request for each repository. +The pull request details form is preloaded with some data, and you can also preview the content of the `catalog-info.yaml`. If the repository already has a `.github/CODEOWNERS` file, you can select the *Use CODEOWNERS file as Entity Owner* checkbox to use it, rather than having the `content-info.yaml` contain a specific entity owner. . Click on *Save*. . Click on *Create pull requests*. From 8d4c7da321166968a256acb96cbe69c191d49879 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:05:39 +0200 Subject: [PATCH 12/49] Apply suggestions from code review Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- ...ing-multiple-repositories-from-github.adoc | 16 ++++++------- ...managing-the-imported-repository-list.adoc | 24 +++++++++---------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index a1288bce55..88d4c3c937 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -18,20 +18,20 @@ This option allows you to select one or more repositories from the selected orga The pull request details form is preloaded with some data, and you can also preview the content of the `catalog-info.yaml`. If the repository already has a `.github/CODEOWNERS` file, you can select the *Use CODEOWNERS file as Entity Owner* checkbox to use it, rather than having the `content-info.yaml` contain a specific entity owner. . Click on *Save*. -. Click on *Create pull requests*. -At this point, a set of dry-run checks will be run against the selected repositories to make sure they meet the requirements to be imported, that is: -.. Checking that there is no entity in the Developer Hub catalog with the name specified in the repository `catalog-info.yaml` +. Click *Create pull requests*. +At this point, a set of dry-run checks runs against the selected repositories to ensure they meet the requirements for import, such as: +.. Verifying that there is no entity in the {product-short} catalog with the name specified in the repository `catalog-info.yaml` .. Checking that the repository is not empty -.. Checking that the repository already has a `.github/CODEOWNERS` file if the *Use CODEOWNERS file as Entity Owner* checkbox was selected for that repository. +.. Verifying that the repository contains a `.github/CODEOWNERS` file if the *Use CODEOWNERS file as Entity Owner* checkbox is selected for that repository. -** If there are any errors, the pull requests will not be created, but you will see a _Failed to create PR_ error message indicating the failures. -Clicking on *Edit* will show more details about the reasons. +** If any errors occur, the pull requests are not created, and you will see a _Failed to create PR_ error message detailing the issues. +To view more details about the reasons, click *Edit*. -** If there are no errors, the pull requests will be created, and you will be redirected to the list of Added repositories. +** If there are no errors, the pull requests are created, and you will be redirected to the list of added repositories. . Review and merge each pull request that creates a `catalog-info.yml` file. .Verification * The *Added repositories* list displays the repositories you just 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 +* 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/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc index b2a2a520ae..d6c4d00d16 100644 --- a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -1,30 +1,30 @@ = Managing the list of Added repositories .Prerequisites -* xref:enabling-ang-giving-access-to-the-bulk-import-feature[You enabled the Bulk Import feature]. -* xref:enabling-ang-giving-access-to-the-bulk-import-feature[Your {product-short} user has access to the Bulk Import feature]. +* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature]. +* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[access to the Bulk Import feature]. .Procedure -. Click on *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 repositories that are being tracked as Import jobs, along with their status. -Added:: The repository has been added to the Developer Hub catalog. +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. This can be the case after the import PR has been merged, or if the repository already had a `catalog-info.yaml` when it was bulk-imported. -Please note that it might take a few minutes until the entities are available in the catalog. +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`. +Waiting for approval:: There is an open pull request adding a `catalog-info.yaml` file to the repository. You can: -* Click on the *pencil icon* on the right to see details about this pull request or edit the pull request content right from {product-short}. -* Delete the Import job, in which case the import PR will be closed as well. +* 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 closes the import PR as well. * To transition the Import job to the _Added_ state, merge the import pull request from the Git repository. -Empty:: {product-short} was not able to determine the Import job status. +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. This can be the case if the repository was imported from other sources but does not have any `catalog-info.yaml` file and does not have any import PR adding it. [NOTE] ==== -* After an import pull request is merged, the Import status will be _Added_ in the list of Added Repositories, but it might take a few seconds until the corresponding entities show up in the Developer Hub Catalog. -* A Location added through other sources (like statically in an `app-config.yaml` file, dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery], or registered manually via the "Register an existing component" page) may show up in the Bulk Import list of Added Repositories if both conditions are met: +* 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 `app-config.yaml` file, dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery], or registered manually using the "Register an existing component" page) may 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. +** The location URL points to a `catalog-info.yaml` file at the root of the repository default branch. ==== From 77810d0c838c44efce39bbe43610b4f618acc3f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:06:20 +0200 Subject: [PATCH 13/49] Apply suggestions from code review Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-understanding-bulk-import-limitations.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc index 6218c362cb..f87a38ac3b 100644 --- a/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc +++ b/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc @@ -1,8 +1,8 @@ = Bulk Import limitations * Only the first 20 repositories (in alphabetical order) can be displayed at most on the Added Repositories page. -Also, the count of Added Repositories displayed might be wrong. -In future releases, we plan to address this with proper pagination. +Also, the count of Added Repositories displayed might be incorrect. +In future releases, this issue can be addressed with proper pagination. Meanwhile, as a workaround, searching would still work against all Added Repositories. So you can still search any Added Repository and get it listed on the table. See https://issues.redhat.com/browse/RHIDP-4067[RHIDP-4067]. From 82d5622b43590298b2e46305321cb0356331931e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:07:31 +0200 Subject: [PATCH 14/49] Apply suggestions from code review --- ...rocedure-enabling-the-bulk-import-from-github-feature.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index c791e3d67e..d1c60c6d2b 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -20,7 +20,6 @@ plugins: See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. . Only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. Configure the required `bulk.import` RBAC permission for the users that are not administrators. -See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. + .`rbac-policy.csv` fragment [source,csv,subs="+quotes"] @@ -30,7 +29,8 @@ p, role:default/bulk-import, catalog-entity.read, read, allow p, role:default/bulk-import, catalog.entity.create, create, allow g, user:default/____, role:default/bulk-import ---- - ++ +See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. .Verification * The sidebar displays a *Bulk Import* line. From c1659c5d08000e6aa6ecf3d37a040d6f4655fdd6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:08:42 +0200 Subject: [PATCH 15/49] Delete modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc --- ...edure-understanding-bulk-import-limitations.adoc | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc deleted file mode 100644 index f87a38ac3b..0000000000 --- a/modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc +++ /dev/null @@ -1,13 +0,0 @@ -= Bulk Import limitations - -* Only the first 20 repositories (in alphabetical order) can be displayed at most on the Added Repositories page. -Also, the count of Added Repositories displayed might be incorrect. -In future releases, this issue can be addressed with proper pagination. -Meanwhile, as a workaround, searching would still work against all Added Repositories. -So you can still search any Added Repository and get it listed on the table. -See https://issues.redhat.com/browse/RHIDP-4067[RHIDP-4067]. - -* Repositories might be added to {product-short} from various sources (like statically in an app-config file or dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery]). -By design, the bulk import plugin will only track repositories that are accessible from the configured GitHub integrations. -However, deleting a repository from the Bulk Imports listing page may not work if the repository was discovered by the GitHub discovery plugin. -See https://issues.redhat.com/browse/RHIDP-3931[RHIDP-3931]. From f6e04ce61c8ebbf257de0bebf2f7115d2a3fa22f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:09:16 +0200 Subject: [PATCH 16/49] Update assemblies/assembly-bulk-importing-from-github.adoc --- assemblies/assembly-bulk-importing-from-github.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index 10e283174e..1e1e534d24 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -12,4 +12,3 @@ include::modules/importing-repositories/procedure-managing-the-imported-reposito include::modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc[leveloffset=+1] -include::modules/importing-repositories/procedure-understanding-bulk-import-limitations.adoc[leveloffset=+1] From 63146153b8e3a950f00597a4b2a90395f7ec11da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:09:31 +0200 Subject: [PATCH 17/49] Update modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-importing-multiple-repositories-from-github.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index 88d4c3c937..f9d2f422a6 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -17,7 +17,7 @@ This option allows you to select one or more repositories from the selected orga . Click *Preview file* to view or edit the details of the pull request for each repository. The pull request details form is preloaded with some data, and you can also preview the content of the `catalog-info.yaml`. If the repository already has a `.github/CODEOWNERS` file, you can select the *Use CODEOWNERS file as Entity Owner* checkbox to use it, rather than having the `content-info.yaml` contain a specific entity owner. -. Click on *Save*. +. Click *Save*. . Click *Create pull requests*. At this point, a set of dry-run checks runs against the selected repositories to ensure they meet the requirements for import, such as: .. Verifying that there is no entity in the {product-short} catalog with the name specified in the repository `catalog-info.yaml` From 7997fb37f3f79f02829ac68980668229b1fd09ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:09:49 +0200 Subject: [PATCH 18/49] Update modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-understanding-bulk-import-audit-logs.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc index 718e0d538b..af798d1865 100644 --- a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc +++ b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc @@ -1,6 +1,6 @@ = Bulk Import Audit Logs -The Bulk Import Backend plugin adds the events below to the Developer Hub audit logs. +The Bulk Import backend plugin adds the following events to the {product-short} audit logs. See link:{linkgettingstartedguide}#assembly-audit-log[Audit Logs in {product}] for more information on how to configure and view such audit logs. *Bulk Import Events*: From 524f299c374b21e694f6315f316e8630427c2778 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:10:03 +0200 Subject: [PATCH 19/49] Update modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-understanding-bulk-import-audit-logs.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc index af798d1865..859ad6044c 100644 --- a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc +++ b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc @@ -12,7 +12,7 @@ Tracks requests to unknown endpoints. Tracks `GET` requests to the `/ping` endpoint, which allows us to make sure the bulk import backend is up and running. `BulkImportFindAllOrganizations`:: -Tracks `GET` requests to the /organizations endpoint, which returns the list of organizations accessible from all configured GitHub Integrations. +Tracks `GET` requests to the `/organizations` endpoint, which returns the list of organizations accessible from all configured GitHub Integrations. `BulkImportFindRepositoriesByOrganization`:: Tracks `GET` requests to the `/organizations/:orgName/repositories` endpoint, which returns the list of repositories for the specified organization (accessible from any of the configured GitHub Integrations). From cd3dd5773e4bbd5708c3c4f2b8ef5199445876f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:10:22 +0200 Subject: [PATCH 20/49] Apply suggestions from code review Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-understanding-bulk-import-audit-logs.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc index 859ad6044c..2eae84e674 100644 --- a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc +++ b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc @@ -30,9 +30,9 @@ Tracks `POST` requests to the `/imports` endpoint, which allows to submit reques Tracks `GET` requests to the `/import/by-repo` endpoint, which fetches details about the import job for the specified repository. `BulkImportDeleteImportByRepo`:: -Tracks `DELETE` requests to the `/import/by-repo` endpoint, which deletes any existing import job for the specified repository, by closing any open import Pull Request that could have been created. +Tracks `DELETE` requests to the `/import/by-repo` endpoint, which deletes any existing import job for the specified repository, by closing any open import pull request that could have been created. -.Example +.Example bulk import audit logs [code,json] ---- { From ca97090bdb6a42a9dbf172b822a34cf900fed540 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:10:39 +0200 Subject: [PATCH 21/49] Update modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-understanding-bulk-import-audit-logs.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc index 2eae84e674..4cd3178106 100644 --- a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc +++ b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc @@ -24,7 +24,7 @@ Tracks GET requests to the `/repositories` endpoint, which returns the list of r Tracks `GET` requests to the `/imports` endpoint, which returns the list of existing import jobs along with their statuses. `BulkImportCreateImportJobs`:: -Tracks `POST` requests to the `/imports` endpoint, which allows to submit requests to bulk-import one or many repositories into the Developer Hub Catalog, by eventually creating import Pull Requests in the target repositories. +Tracks `POST` requests to the `/imports` endpoint, which allows to submit requests to bulk-import one or many repositories into the {product-short} catalog, by eventually creating import pull requests in the target repositories. `BulkImportFindImportStatusByRepo`:: Tracks `GET` requests to the `/import/by-repo` endpoint, which fetches details about the import job for the specified repository. From a8e40d052f7cb7dc4a9e939ea5fda5aa1270d7df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:18:56 +0200 Subject: [PATCH 22/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc --- ...rocedure-enabling-the-bulk-import-from-github-feature.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index d1c60c6d2b..2dd83befc2 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -1,8 +1,10 @@ [id="enabling-ang-giving-access-to-the-bulk-import-feature"] = Enabling and giving access to the Bulk Import feature +.Prerequisites +. You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration]. + .Procedure -. To give {product-short} access to GitHub, link:{linkgettingstartedguide}#configuring-github-integration[configure GitHub integration]. . The Bulk Import plugins are installed but disabled by default. To enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import` plugins, From aadf9590842b496efebae7b57d0f5862853c0e0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:19:33 +0200 Subject: [PATCH 23/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 2dd83befc2..79fabeea52 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -19,7 +19,9 @@ plugins: - package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import disabled: false ---- ++ See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. + . Only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. Configure the required `bulk.import` RBAC permission for the users that are not administrators. + From ec43f0ecc5f3c7d6208bea668862e452fc3ff2dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 12:20:56 +0200 Subject: [PATCH 24/49] Update modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc --- .../procedure-importing-multiple-repositories-from-github.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index f9d2f422a6..d8873062ef 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -4,8 +4,7 @@ The Bulk Import feature allows you to view all the GitHub repositories and organ From there, you can pick any number of repositories and onboard them. .Prerequisites -* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature]. -* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[access to the Bulk Import feature]. +* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and gave access to it]. .Procedure . Click *Bulk Import* in the left sidebar. From 8d02776c351e8eccf25b1723a573acd6b69e16c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:02:04 +0200 Subject: [PATCH 25/49] Update assemblies/assembly-bulk-importing-from-github.adoc --- assemblies/assembly-bulk-importing-from-github.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index 1e1e534d24..a4f294cecb 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -1,4 +1,4 @@ -= Bulk Import GitHub repositories += Bulk importing GitHub repositories Bulk Import is a https://access.redhat.com/support/offerings/techpreview[{company-name} *Tech Preview*] feature. From 92b6d99cf77c554ff3c17880ffa6e2002eb53db3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:06:08 +0200 Subject: [PATCH 26/49] Update modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc --- ...cedure-importing-multiple-repositories-from-github.adoc | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index d8873062ef..dfff1cee6e 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -14,9 +14,10 @@ For each repository selected, a `catalog-info.yaml` is generated. .. From the *Organizations* view, you can select any organization by clicking on *Select* in the third column. This option allows you to select one or more repositories from the selected organization. . Click *Preview file* to view or edit the details of the pull request for each repository. -The pull request details form is preloaded with some data, and you can also preview the content of the `catalog-info.yaml`. -If the repository already has a `.github/CODEOWNERS` file, you can select the *Use CODEOWNERS file as Entity Owner* checkbox to use it, rather than having the `content-info.yaml` contain a specific entity owner. -. Click *Save*. +.. Edit the pull request description. +.. Review the content of the `catalog-info.yaml` file. +.. Optional: when the repository has a `.github/CODEOWNERS` file, you can select the *Use CODEOWNERS file as Entity Owner* checkbox to use it, rather than having the `content-info.yaml` contain a specific entity owner. +.. Click *Save*. . Click *Create pull requests*. At this point, a set of dry-run checks runs against the selected repositories to ensure they meet the requirements for import, such as: .. Verifying that there is no entity in the {product-short} catalog with the name specified in the repository `catalog-info.yaml` From 268172e808d88e12b1260dcb9a09f0fe7da236a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:11:56 +0200 Subject: [PATCH 27/49] Update assemblies/assembly-bulk-importing-from-github.adoc --- assemblies/assembly-bulk-importing-from-github.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index a4f294cecb..201cf67d2c 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -1,6 +1,9 @@ = Bulk importing GitHub repositories -Bulk Import is a https://access.redhat.com/support/offerings/techpreview[{company-name} *Tech Preview*] feature. +[IMPORTANT] +==== +This is a https://access.redhat.com/support/offerings/techpreview/[Technology Preview] feature. +==== It allows you to automate GitHub repositories onboarding and track their import status. From 34deeb6f9be37fa1810117d1529fcd457a950402 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:15:13 +0200 Subject: [PATCH 28/49] Update assemblies/assembly-bulk-importing-from-github.adoc --- assemblies/assembly-bulk-importing-from-github.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index 201cf67d2c..8572781ba1 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -5,7 +5,7 @@ This is a https://access.redhat.com/support/offerings/techpreview/[Technology Preview] feature. ==== -It allows you to automate GitHub repositories onboarding and track their import status. +{product} can automate GitHub repositories onboarding and track their import status. include::modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc[leveloffset=+1] From 135311f6e9c4561cfb510499a617d4a2d4440ad5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:18:11 +0200 Subject: [PATCH 29/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc --- ...rocedure-enabling-the-bulk-import-from-github-feature.adoc | 4 ---- 1 file changed, 4 deletions(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 79fabeea52..17133b972b 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -40,7 +40,3 @@ See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorizati * The sidebar displays a *Bulk Import* line. * The *Bulk Import* page shows a list of *Added Repositories*. -.Troubleshooting -* If clicking on the *Bulk Import* option displays the following error message: -_To view the added repositories, contact your administrator to give you the `bulk.import` permission_, which means the user does not have the necessary permission to use the Bulk Import feature. -See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub] for more information on how an administrator can add that permission to your user. From f92f7cb942a2d9010ff452088df7a2068c094313 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:21:50 +0200 Subject: [PATCH 30/49] Update modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc --- .../procedure-importing-multiple-repositories-from-github.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index dfff1cee6e..3ca9eb225d 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -14,8 +14,7 @@ For each repository selected, a `catalog-info.yaml` is generated. .. From the *Organizations* view, you can select any organization by clicking on *Select* in the third column. This option allows you to select one or more repositories from the selected organization. . Click *Preview file* to view or edit the details of the pull request for each repository. -.. Edit the pull request description. -.. Review the content of the `catalog-info.yaml` file. +.. Review the pull request description and the `catalog-info.yaml` file content. .. Optional: when the repository has a `.github/CODEOWNERS` file, you can select the *Use CODEOWNERS file as Entity Owner* checkbox to use it, rather than having the `content-info.yaml` contain a specific entity owner. .. Click *Save*. . Click *Create pull requests*. From 753114daae9c06c3e62ae833d63251e3fcdd6fff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:28:13 +0200 Subject: [PATCH 31/49] Apply suggestions from code review --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 2 +- .../procedure-importing-multiple-repositories-from-github.adoc | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 17133b972b..4a68526609 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -2,7 +2,7 @@ = Enabling and giving access to the Bulk Import feature .Prerequisites -. You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration]. +* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration]. .Procedure diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index 3ca9eb225d..1d8432c223 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -4,6 +4,7 @@ The Bulk Import feature allows you to view all the GitHub repositories and organ From there, you can pick any number of repositories and onboard them. .Prerequisites +* You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration]. * You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and gave access to it]. .Procedure From af3ccb28a283bde1c7ed72b0df45bf34ae8583a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:32:49 +0200 Subject: [PATCH 32/49] Update modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc --- .../procedure-importing-multiple-repositories-from-github.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index 1d8432c223..b8bb5ad97a 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -1,7 +1,6 @@ = Importing multiple repositories -The Bulk Import feature allows you to view all the GitHub repositories and organizations accessible from the configured GitHub Integrations. -From there, you can pick any number of repositories and onboard them. +In {product}, you can select your GitHub repositories and automate their onboarding to the {product-short} catalog. .Prerequisites * You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration]. From 31af868616472bde6bd6380538709dc704998de5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:37:38 +0200 Subject: [PATCH 33/49] Apply suggestions from code review --- ...ocedure-importing-multiple-repositories-from-github.adoc | 3 ++- .../procedure-managing-the-imported-repository-list.adoc | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index b8bb5ad97a..cc387d5bf7 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -1,4 +1,5 @@ -= Importing multiple repositories +[id="importing-multiple-github-repositories] += Importing multiple GitHub repositories In {product}, you can select your GitHub repositories and automate their onboarding to the {product-short} catalog. diff --git a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc index d6c4d00d16..0315ae9bc3 100644 --- a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -1,8 +1,8 @@ -= Managing the list of Added repositories +[id="managing-the-added-repository] += Managing the added repositories .Prerequisites -* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature]. -* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[access to the Bulk Import feature]. +* You have xref:importing-multiple-github-repositories[imported GitHub repositories]. .Procedure From 7b5995ae6e001d6d0268cecba7d3e83056e58daa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:43:49 +0200 Subject: [PATCH 34/49] Update modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc --- .../procedure-managing-the-imported-repository-list.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc index 0315ae9bc3..06bc1e9d8d 100644 --- a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -1,4 +1,4 @@ -[id="managing-the-added-repository] +[id="managing-the-added-repositories] = Managing the added repositories .Prerequisites From 23178b162bd66d26b004049358f1d40d93ab6de7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:44:57 +0200 Subject: [PATCH 35/49] Update modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc --- .../procedure-understanding-bulk-import-audit-logs.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc index 4cd3178106..c60ac8b953 100644 --- a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc +++ b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc @@ -1,4 +1,5 @@ -= Bulk Import Audit Logs +[id="understanding-bulk-import-audit-logs"] += Understanding the Bulk Import audit Logs The Bulk Import backend plugin adds the following events to the {product-short} audit logs. See link:{linkgettingstartedguide}#assembly-audit-log[Audit Logs in {product}] for more information on how to configure and view such audit logs. From 91bc0442d34ed1f4e3af7a50ff230fdcf104f7e0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:45:36 +0200 Subject: [PATCH 36/49] Update assemblies/assembly-bulk-importing-from-github.adoc --- assemblies/assembly-bulk-importing-from-github.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index 8572781ba1..a1f7e829a2 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -1,3 +1,4 @@ +[id="bulk-importing-github-repositories"] = Bulk importing GitHub repositories [IMPORTANT] From 09af6d4f9f496f7fc227713f0eb22a703452da46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Tue, 15 Oct 2024 13:46:44 +0200 Subject: [PATCH 37/49] Apply suggestions from code review --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 2 +- .../procedure-importing-multiple-repositories-from-github.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 4a68526609..465da0ebfb 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -1,4 +1,4 @@ -[id="enabling-ang-giving-access-to-the-bulk-import-feature"] +[id="enabling-and-giving-access-to-the-bulk-import-feature"] = Enabling and giving access to the Bulk Import feature .Prerequisites diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index cc387d5bf7..d3475a68a9 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -5,7 +5,7 @@ In {product}, you can select your GitHub repositories and automate their onboard .Prerequisites * You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration]. -* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and gave access to it]. +* You have xref:enabling-and-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature and gave access to it]. .Procedure . Click *Bulk Import* in the left sidebar. From 772599348ccb44d5219a2aa3ccf3ddfdbfb8bf5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:42:26 +0200 Subject: [PATCH 38/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 465da0ebfb..2394efec01 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -8,7 +8,7 @@ . The Bulk Import plugins are installed but disabled by default. To enable the `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import-backend-dynamic` and `./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import` plugins, -edit your `dynamic-plugins.yaml` with following content. +edit your `dynamic-plugins.yaml` with the following content: + .`dynamic-plugins.yaml` fragment [source,yaml] From c8fbf7a598bad2010298a91dc83b1dffc8114cfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:43:00 +0200 Subject: [PATCH 39/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 2394efec01..b184fc425f 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -22,7 +22,7 @@ plugins: + See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. -. Only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. +. Configure the required `bulk.import` RBAC permission for the users who are not administrators as follows: Configure the required `bulk.import` RBAC permission for the users that are not administrators. + .`rbac-policy.csv` fragment From 5aed4617a47974a57e0007e2a2f6bf682efdae4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:43:19 +0200 Subject: [PATCH 40/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index b184fc425f..dc1ec297e9 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -34,7 +34,7 @@ p, role:default/bulk-import, catalog.entity.create, create, allow g, user:default/____, role:default/bulk-import ---- + -See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. +Note that only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. .Verification * The sidebar displays a *Bulk Import* line. From de6ef909545d8c90efbf05a416fcaad33e9a9f65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:43:47 +0200 Subject: [PATCH 41/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index dc1ec297e9..dc0f30efd0 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -23,7 +23,6 @@ plugins: See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dynamic-plugins-title}]. . Configure the required `bulk.import` RBAC permission for the users who are not administrators as follows: -Configure the required `bulk.import` RBAC permission for the users that are not administrators. + .`rbac-policy.csv` fragment [source,csv,subs="+quotes"] From fe629f09aa6ca626a4e56605184ef6d68a5a6fad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:44:03 +0200 Subject: [PATCH 42/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index dc0f30efd0..d5a8f81ff9 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -1,6 +1,6 @@ [id="enabling-and-giving-access-to-the-bulk-import-feature"] = Enabling and giving access to the Bulk Import feature - +You can enable the Bulk Import feature for users and give them the necessary permissions to access it. .Prerequisites * You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration]. From 097365bd291a172bcf7af07735f03e5ee0f90768 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:44:18 +0200 Subject: [PATCH 43/49] Update modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- .../procedure-importing-multiple-repositories-from-github.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index d3475a68a9..49bd76afd5 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -12,7 +12,7 @@ In {product}, you can select your GitHub repositories and automate their onboard . Click the *Add* button in the top-right corner to see the list of all repositories accessible from the configured GitHub integrations. .. From the *Repositories* view, you can select any repository, or search for any accessible repositories. For each repository selected, a `catalog-info.yaml` is generated. -.. From the *Organizations* view, you can select any organization by clicking on *Select* in the third column. +.. From the *Organizations* view, you can select any organization by clicking *Select* in the third column. This option allows you to select one or more repositories from the selected organization. . Click *Preview file* to view or edit the details of the pull request for each repository. .. Review the pull request description and the `catalog-info.yaml` file content. From 5067b35f3fa757707ec3464dc2a3a25f1b6e33ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:45:14 +0200 Subject: [PATCH 44/49] Apply suggestions from code review Co-authored-by: Heena Manwani <59050394+hmanwani-rh@users.noreply.github.com> --- ...-importing-multiple-repositories-from-github.adoc | 12 ++++++------ ...cedure-managing-the-imported-repository-list.adoc | 6 +++--- ...ocedure-understanding-bulk-import-audit-logs.adoc | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc index 49bd76afd5..27843b02de 100644 --- a/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc +++ b/modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc @@ -21,17 +21,17 @@ This option allows you to select one or more repositories from the selected orga . Click *Create pull requests*. At this point, a set of dry-run checks runs against the selected repositories to ensure they meet the requirements for import, such as: .. Verifying that there is no entity in the {product-short} catalog with the name specified in the repository `catalog-info.yaml` -.. Checking that the repository is not empty -.. Verifying that the repository contains a `.github/CODEOWNERS` file if the *Use CODEOWNERS file as Entity Owner* checkbox is selected for that repository. +.. Verifying that the repository is not empty +.. Verifying that the repository contains a `.github/CODEOWNERS` file if the *Use CODEOWNERS file as Entity Owner* checkbox is selected for that repository -** If any errors occur, the pull requests are not created, and you will see a _Failed to create PR_ error message detailing the issues. +** If any errors occur, the pull requests are not created, and you see a _Failed to create PR_ error message detailing the issues. To view more details about the reasons, click *Edit*. -** If there are no errors, the pull requests are created, and you will be redirected to the list of added repositories. +** If there are no errors, the pull requests are created, and you are redirected to the list of added repositories. . Review and merge each pull request that creates a `catalog-info.yml` file. .Verification -* The *Added repositories* list displays the repositories you just 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 +* The *Added repositories* 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/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc index 06bc1e9d8d..9eb7c74221 100644 --- a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -1,6 +1,6 @@ [id="managing-the-added-repositories] = Managing the added repositories - +You can oversee and manage the repositories that are imported to the {product-short}. .Prerequisites * You have xref:importing-multiple-github-repositories[imported GitHub repositories]. @@ -15,7 +15,7 @@ Note that it may take a few minutes for the entities to be available in the cata Waiting for approval:: There is an open pull request adding a `catalog-info.yaml` file to the repository. 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 closes the import PR as well. +* 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. 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,7 +24,7 @@ This can be the case if the repository was imported from other sources but does [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 `app-config.yaml` file, dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery], or registered manually using the "Register an existing component" page) may show up in the Bulk Import list of Added Repositories if the following conditions are met: +* A location added through other sources (like statically in an `app-config.yaml` file, dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[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. ==== diff --git a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc index c60ac8b953..695378c8d2 100644 --- a/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc +++ b/modules/importing-repositories/procedure-understanding-bulk-import-audit-logs.adoc @@ -2,7 +2,7 @@ = Understanding the Bulk Import audit Logs The Bulk Import backend plugin adds the following events to the {product-short} audit logs. -See link:{linkgettingstartedguide}#assembly-audit-log[Audit Logs in {product}] for more information on how to configure and view such audit logs. +See link:{linkgettingstartedguide}#assembly-audit-log[Audit Logs in {product}] for more information on how to configure and view audit logs. *Bulk Import Events*: From 3cf4d5fd796bbcac9f363bd00edb63d9ae74a641 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:45:54 +0200 Subject: [PATCH 45/49] Update modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc --- .../procedure-managing-the-imported-repository-list.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc index 9eb7c74221..58470dfcb7 100644 --- a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -1,6 +1,7 @@ [id="managing-the-added-repositories] = Managing the added repositories You can oversee and manage the repositories that are imported to the {product-short}. + .Prerequisites * You have xref:importing-multiple-github-repositories[imported GitHub repositories]. From 6239ea67f0ac80b2642c60ff495fc8d31e3e8b7d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 11:47:02 +0200 Subject: [PATCH 46/49] Apply suggestions from code review --- .../procedure-managing-the-imported-repository-list.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc index 58470dfcb7..00c1bd4ff3 100644 --- a/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc +++ b/modules/importing-repositories/procedure-managing-the-imported-repository-list.adoc @@ -10,7 +10,6 @@ You can oversee and manage the repositories that are imported to the {product-sh . Click *Bulk Import* in the left sidebar to display all the current repositories 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. -This can be the case after the import PR has been merged, or if the repository already had a `catalog-info.yaml` when it was bulk-imported. 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. @@ -20,7 +19,6 @@ You can: * To transition the Import job to the _Added_ state, merge the import pull 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. -This can be the case if the repository was imported from other sources but does not have any `catalog-info.yaml` file and does not have any import PR adding it. [NOTE] ==== From 5417090cac6c35f13e25e6c0dfb26e10946b8f47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 12:01:59 +0200 Subject: [PATCH 47/49] chore: reuse technology preview content MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fabrice Flore-Thébault --- artifacts/snip-technology-preview.adoc | 6 ++++++ assemblies/assembly-bulk-importing-from-github.adoc | 5 +---- modules/getting-started/con-servicenow-custom-actions.adoc | 7 +------ 3 files changed, 8 insertions(+), 10 deletions(-) create mode 100644 artifacts/snip-technology-preview.adoc diff --git a/artifacts/snip-technology-preview.adoc b/artifacts/snip-technology-preview.adoc new file mode 100644 index 0000000000..e94b591ef7 --- /dev/null +++ b/artifacts/snip-technology-preview.adoc @@ -0,0 +1,6 @@ +[IMPORTANT] +==== +These features are for Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. + +For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope]. +==== diff --git a/assemblies/assembly-bulk-importing-from-github.adoc b/assemblies/assembly-bulk-importing-from-github.adoc index a1f7e829a2..0641acf589 100644 --- a/assemblies/assembly-bulk-importing-from-github.adoc +++ b/assemblies/assembly-bulk-importing-from-github.adoc @@ -1,10 +1,7 @@ [id="bulk-importing-github-repositories"] = Bulk importing GitHub repositories -[IMPORTANT] -==== -This is a https://access.redhat.com/support/offerings/techpreview/[Technology Preview] feature. -==== +include::{docdir}/artifacts/snip-technology-preview.adoc[] {product} can automate GitHub repositories onboarding and track their import status. diff --git a/modules/getting-started/con-servicenow-custom-actions.adoc b/modules/getting-started/con-servicenow-custom-actions.adoc index 08f5095224..01a47b3693 100644 --- a/modules/getting-started/con-servicenow-custom-actions.adoc +++ b/modules/getting-started/con-servicenow-custom-actions.adoc @@ -1,12 +1,7 @@ [id='con-servicenow-custom-actions_{context}'] = ServiceNow Custom actions in {product} -[IMPORTANT] -==== -These features are for Technology Preview only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs), might not be functionally complete, and Red Hat does not recommend using them for production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. - -For more information on Red Hat Technology Preview features, see https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Scope]. -==== +include::{docdir}/artifacts/snip-technology-preview.adoc[] In {product}, you can access ServiceNow custom actions (custom actions) for fetching and registering resources in the catalog. From a287215c71a2a700efdfeaaf98f5e47d69f55365 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 13:56:56 +0200 Subject: [PATCH 48/49] Apply suggestions from code review Co-authored-by: Subhash Khileri --- ...rocedure-enabling-the-bulk-import-from-github-feature.adoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index d5a8f81ff9..4950ab5a82 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -28,14 +28,12 @@ See link:{installing-and-viewing-dynamic-plugins-url}[{installing-and-viewing-dy [source,csv,subs="+quotes"] ---- p, role:default/bulk-import, bulk.import, use, allow -p, role:default/bulk-import, catalog-entity.read, read, allow -p, role:default/bulk-import, catalog.entity.create, create, allow g, user:default/____, role:default/bulk-import ---- + Note that only {product-short} administrators or users with the `bulk.import` permission can use the Bulk Import feature. See link:{authorization-book-url}#ref-rbac-permission-policies_title-authorization[Permission policies in Red Hat Developer Hub]. .Verification -* The sidebar displays a *Bulk Import* line. +* The sidebar displays a *Bulk Import* option. * The *Bulk Import* page shows a list of *Added Repositories*. From ccd7c35b6c397bbd42881c1317300b9cab1a5042 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fabrice=20Flore-Th=C3=A9bault?= Date: Thu, 17 Oct 2024 14:25:14 +0200 Subject: [PATCH 49/49] Update modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc --- .../procedure-enabling-the-bulk-import-from-github-feature.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc index 4950ab5a82..b2f05fd5bd 100644 --- a/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc +++ b/modules/importing-repositories/procedure-enabling-the-bulk-import-from-github-feature.adoc @@ -1,6 +1,7 @@ [id="enabling-and-giving-access-to-the-bulk-import-feature"] = Enabling and giving access to the Bulk Import feature You can enable the Bulk Import feature for users and give them the necessary permissions to access it. + .Prerequisites * You have link:{authentication-book-url}#enabling-authentication-with-github[configured GitHub authentication and integration].