Skip to content

Commit 84be15b

Browse files
pabel-rhopenshift-cherrypick-robot
authored andcommitted
Incorporated Judy's comments
1 parent 06bdebd commit 84be15b

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

assemblies/assembly-tracking-component-origin-and-software-template-version.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Platform engineers use custom actions within the Software Template scaffolding process to establish and track the dependency link between a generated entity (Component or Resource) and its source template. This relationship is called scaffolding provenance.
77

8-
Platform administrators use the existing custom actions `catalog:scaffolded-from` and `catalog:template:version` in the scaffolder backend module. These actions track the template version and the corresponding entity version, which simplifies lifecycle management.
8+
Platform administrators use custom actions such as `catalog:scaffolded-from` and `catalog:template:version` in the scaffolder backend module to track the template version and the corresponding entity version, which simplifies lifecycle management.
99

1010
include::modules/tracking-component-origin-and-software-template-version/proc-configuring-provenance-and-software-template-versioning.adoc[leveloffset=+1]
1111

modules/tracking-component-origin-and-software-template-version/proc-configuring-provenance-and-software-template-versioning.adoc

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,10 @@ As a platform engineer, you must modify the Software Template YAML definition to
1212
.Procedure
1313

1414
. Locate the Software Template object YAML file where you want to add the provenance information and add a step that uses the `catalog:scaffolded-from` action. This action links the resulting catalog entity back to the source template.
15-
. Optional: To track the template version (for example, v1.0 versus v1.5), include the `catalog:template:version` action in the `steps` section.
15+
. Optional: To track the template version (for example, v1.0 versus v1.5), include the `catalog:template:version` action in the `steps` section. The following code block is an example to adding versioning action to the `steps` section:
1616
+
1717
[source,yaml]
1818
----
19-
# Example: Adding the versioning action to the steps section
2019
steps:
2120
- id: create-provenance-annotation
2221
name: Append the entityRef of this template to the entityRef
@@ -25,16 +24,20 @@ steps:
2524
name: Create Template Version Annotation
2625
action: catalog:template:version
2726
input:
28-
templateVersion: ${{ parameters.version }} # Reads the version parameter
27+
templateVersion: ${{ parameters.version }}
2928
- ... other steps ...
3029
----
3130
+
31+
where:
32+
33+
`steps:input:templateVersion`:: Reads the version parameter
34+
+
3235
[NOTE]
3336
====
34-
This action reads a version parameter defined in the template and applies it as an annotation to the resulting catalog entity.
37+
The `catalog:template:version` action reads a version parameter defined in the template and applies it as an annotation to the resulting catalog entity.
3538
====
3639

37-
. In your `{product} {my-app-config-file}` file, configure the `catalog.locations` section to point to the Software Template that you want to add. You might need to add `Template` to the global `catalog.rules.allow` list or add a granular rule to the location to allow for Software Templates ingestion, as shown in the following example::
40+
. In your {product} `{my-app-config-file}` file, configure the `catalog.locations` section to point to the Software Template that you want to add. You might need to add `Template` to the global `catalog.rules.allow` list or add a granular rule to the location to allow for Software Templates ingestion, as shown in the following example:
3841
+
3942
[source,yaml]
4043
----
@@ -47,11 +50,12 @@ catalog:
4750
- allow: [Template]
4851
# ...
4952
----
53+
+
5054
where:
5155

52-
`catalog.locations.type`:: If you are importing templates from a repository, such as GitHub or GitLab, use the `url` type.
53-
`catalog.locations.target`:: Specify the URL for the template.
54-
`catalog.locations.rules.allow`:: To allow new Software Templates to be added to the catalog, you must add a `Template` rule.
56+
`catalog.locations.type`:: Enter the `url` type if you are importing templates from a repository, such as GitHub or GitLab.
57+
`catalog.locations.target`:: Enter the URL for the template.
58+
`catalog.locations.rules.allow`:: Enter the `Template` rule to allow new Software Templates to be added to the catalog.
5559

5660
.Verification
5761

modules/tracking-component-origin-and-software-template-version/proc-viewing-software-template-dependencies.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ As a developer, you can track which entities were created from a specific Softwa
99
To view all components created from a specific template, complete the following steps:
1010

1111
. In the {product} navigation menu, click *Catalog*, use the filters to find and select the Software Template you wish to inspect.
12-
. In the Software Template detail page, click the *Dependencies* tab. This view lists all catalog entities (components, resources, systems, etc.) that reference this template, including any version information if configured.
12+
. In the Software Template detail page, click the *Dependencies* tab. This view lists all catalog entities such as components, resources, and systems that reference this template, including any version information if configured.

0 commit comments

Comments
 (0)