You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/importing-repositories/procedure-data-handoff-and-custom-workflow-design.adoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
= Data handoff and custom workflow design
6
6
7
-
When you configure the Bulk Import plugin by setting the importAPI field to `scaffolder`, the Bulk Import Backend ensures all necessary context is passed directly to the Orchestrator.
7
+
When you configure the Bulk Import plugin by setting the importAPI field to `scaffolder`, the Bulk Import Backend ensures all necessary context is passed directly to the Scaffolder API.
8
8
9
9
Your control over input data:: The Orchestrator workflow receives the input data required to automate processing for every selected repository. The payload includes, at minimum, the complete list of repository URLs and the user identity.
10
10
+
@@ -21,10 +21,10 @@ Your control over input data:: The Orchestrator workflow receives the input data
21
21
}
22
22
----
23
23
24
-
As an administrator, you can define the Orchestrator workflow and structure the workflow to do the following:
24
+
As an administrator, you can define the Scaffolder template workflow and structure the workflow to do the following:
25
25
26
26
Consume the input:: Accept the repositories array as primary input.
27
27
28
28
Iterate and process:: Loop through the list, executing the custom logic for example, creating the `catalog-info.yaml` if needed, then running compliance checks, then registering with the catalog.
29
29
30
-
Manage lifecycle:: The Orchestrator workflow owns the entire import lifecycle for the repository list, providing a single point of management and traceability.
30
+
Manage lifecycle:: The Scaffolder template workflow owns the entire import lifecycle for the repository list, providing a single point of management and traceability.
= Setting up a custom scaffolder workflow for bulk import
5
5
6
-
As an administrator, you can create a scaffolder template specifically for the Bulk Import plugin. You can provide the scaffolder template within the configuration of your application.
6
+
As an administrator, you can create a scaffolder template specifically for the Bulk Import plugin. You can provide the Scaffolder template within the configuration of your application.
7
7
8
8
You can run the following tasks with this integration:
9
9
@@ -15,7 +15,7 @@ You can execute a custom automation workflow of a Scaffolder template on multipl
15
15
16
16
.Prerequisites
17
17
18
-
* You created a Scaffolder template specifically designed for the Bulk Import function and provided the scaffolder template within the configuration of your application. This template is the core definition of your customized import scenario.
18
+
* You created a Scaffolder template specifically designed for the Bulk Import function and provided the Scaffolder template within the configuration of your application. This template is the core definition of your customized import scenario.
19
19
20
20
.Procedure
21
21
@@ -28,26 +28,26 @@ To configure the Bulk Import workflow:
Enter your template entity reference or name of your Scaffolder template.
36
+
Enter your Scaffolder template entity reference.
37
37
38
38
`importAPI`::
39
39
Set the API to 'scaffolder' to trigger the defined workflow for high-fidelity automation. This field defines the import workflow and currently supports two following options:
40
40
41
41
`open-pull-requests`:: This is the default import workflow, which includes the logic for creating pull requests for every selected repository.
42
42
43
-
`scaffolder`:: This workflow uses an import scenario defined in the scaffolder template. Select this option to use the custom import scenario defined in your Scaffolder template.
43
+
`scaffolder`:: This workflow uses an import scenario defined in the Scaffolder template to create import jobs. Select this option to use the custom import scenario defined in your Scaffolder template.
44
44
+
45
45
[IMPORTANT]
46
46
====
47
47
The Scaffolder template must be generic and not specific to a single repository if you want your custom Scaffolder template to run successfully for every repository in the bulk list.
48
48
====
49
49
50
-
For the {product-very-short} instance to use the scaffolder functionality, you must run it with the following environment variable enabled:
50
+
For the {product-very-short} instance to use the Scaffolder functionality, you must run it with the following environment variable enabled:
0 commit comments