Prefetch RPM: use partials in examples

Allow to replace examples in downstream

Signed-off-by: Martin Basti <[email protected]>

Author: MartinBasti

modules/ROOT/pages/building/prefetching-dependencies.adoc

@@ -257,41 +257,40 @@ Cachi2 has a dev-preview package manager capable of fetching `rpm` dependencies.
 
 To prefetch dependencies for a component build, complete the following steps:
 
+. Have a Containerfile, for example:
++
+include::ROOT:partial$building/{context}-example-prefetch-rpm-containerfile.adoc[]
+
 . Create a `rpms.in.yaml` file in your git repository, with the following contents:
 
 +
-[source,yaml]
-----
-packages: [nethack] <1>
-contentOrigin:
-  repofiles: ["./fedora.repo"] <2>
-arches: [x86_64, aarch64] <3>
-----
+include::ROOT:partial$building/{context}-example-prefetch-rpm-rpms_in_yaml.adoc[]
 <1> The `*packages*` list is the list of packages you want to install in your Container. You don't have to declare transitive dependencies here. The rpm-lockfile-prototype tool will resolve them for you.
 <2> This should be a reference to a repo file, like those found in `/etc/yum.repos.d/`. This tells the tooling where to find your rpm and its dependencies.
 <3> The `arches` array allows you to specify which architectures the dependencies should be downloaded for. If you're building a multi-arch container this array is mandatory, otherwise the build task will fail.
++
+NOTE: The description of all options available for `rpms.in.yaml` can be found
+https://github.com/konflux-ci/rpm-lockfile-prototype?tab=readme-ov-file#whats-the-input_file[here].
 
-. Copy any necessary yum/dnf repo files into your git repository. If you are using a fedora rawhide base image, that looks like:
+. Copy any necessary yum/dnf repo files into your git repository. For example:
 
 +
-[source,console]
-----
-$ BASE_IMAGE=quay.io/fedora/fedora:rawhide
-$ podman run -it $BASE_IMAGE cat /etc/yum.repos.d/fedora.repo > fedora.repo
-----
+include::ROOT:partial$building/{context}-example-prefetch-rpm-copy-repo.adoc[]
 
 +
 NOTE: For every repository defined in your set of repo files, make sure to add the corresponding sources repo (or make sure to enable them, if they’re already present). Otherwise, the lockfile generator will not include any SRPMs in your lockfile, cachi2 won’t download any SRPMs and the source container for your build will be incomplete.
 
 . Run the following command to resolve your `rpms.in.yaml` file and produce a `rpms.lock.yaml` file.
 
 +
-[source,console]
-----
-$ BASE_IMAGE=quay.io/fedora/fedora:rawhide
-$ rpm-lockfile-prototype --image $BASE_IMAGE rpms.in.yaml <1>
-----
+include::ROOT:partial$building/{context}-example-prefetch-rpm-execute.adoc[]
 <1> The produced `rpms.lock.yaml` file will include only your requested dependency plus its transitive dependencies, minus any rpms that are already installed in the provided base image.
++
+Example of generated lockfile:
++
+include::ROOT:partial$building/{context}-example-prefetch-rpm-lockfile.adoc[]
++
+NOTE: The list of `arches.packages` is omitted for brevity.
 
 . Additionally, pass an extra parameter to the `prefetch-dependencies` task in the `.spec.pipelineSpec.tasks` section to indicate that "dev package managers" should be enabled.
 

modules/ROOT/partials/building/konflux-example-prefetch-rpm-containerfile.adoc

@@ -0,0 +1,7 @@
+[source,Dockerfile]
+----
+FROM quay.io/fedora/fedora:rawhide
+RUN dnf -y install cargo
+WORKDIR /workdir
+ENTRYPOINT ["cargo", "--version"]
+----

modules/ROOT/partials/building/konflux-example-prefetch-rpm-copy-repo.adoc

@@ -0,0 +1,5 @@
+[source,console]
+----
+$ BASE_IMAGE=quay.io/fedora/fedora:rawhide
+$ podman run -it $BASE_IMAGE cat /etc/yum.repos.d/fedora.repo > fedora.repo
+----

modules/ROOT/partials/building/konflux-example-prefetch-rpm-execute.adoc

@@ -0,0 +1,5 @@
+[source,console]
+----
+$ BASE_IMAGE=quay.io/fedora/fedora:rawhide
+$ rpm-lockfile-prototype --image $BASE_IMAGE rpms.in.yaml <1>
+----

modules/ROOT/partials/building/konflux-example-prefetch-rpm-lockfile.adoc

@@ -0,0 +1,14 @@
+[source,yaml]
+----
+lockfileVersion: 1
+lockfileVendor: fedora
+arches:
+- arch: aarch64
+  packages:
+    - ...
+  module_metadata: []
+- arch: x86_64
+  packages:
+    - ...
+  module_metadata: []
+----

modules/ROOT/partials/building/konflux-example-prefetch-rpm-rpms_in_yaml.adoc

@@ -0,0 +1,7 @@
+[source,yaml]
+----
+packages: [cargo] <1>
+contentOrigin:
+  repofiles: ["./fedora.repo"] <2>
+arches: [x86_64, aarch64] <3>
+----