Skip to content

Commit c3b8e2a

Browse files
[release-1.6] RHIDP-7175: OCI Image content update (#1196)
* Added content * Incorporated Armel's comments * Incorporated Armel's comments * Minor change * More refinement --------- Co-authored-by: Priyanka Abel <[email protected]>
1 parent ef39d4b commit c3b8e2a

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

modules/dynamic-plugins/proc-load-plugin-oci-image.adoc

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,33 @@
77
For more information about packaging a third-party plugin, see xref:assembly-package-publish-third-party-dynamic-plugin[].
88

99
.Procedure
10+
. To retrieve plugins from an authenticated registry, complete the following steps:
11+
.. Log in to the container image registry.
12+
+
13+
[source,yaml]
14+
----
15+
podman login <registry>
16+
----
17+
.. Verify the content of the `auth.json` file created after the login.
18+
+
19+
[source,yaml]
20+
----
21+
cat ${XDG_RUNTIME_DIR:-~/.config}/containers/auth.json
22+
----
23+
.. Create a secret file using the following example:
24+
+
25+
[source,yaml]
26+
----
27+
oc create secret generic _<secret_name>_ --from-file=auth.json=${XDG_RUNTIME_DIR:-~/.config}/containers/auth.json <1>
28+
----
29+
+
30+
** For an Operator-based deployment, replace _<secret_name>_ with `dynamic-plugins-registry-auth`.
31+
** For a Helm-based deployment, replace _<secret_name>_ with `<Helm_release_name>_-dynamic-plugins-registry-auth`.
32+
1033
. Define the plugin with the `oci://` prefix in the following format in `dynamic-plugins.yaml` file:
1134
+
1235
--
13-
`oci://<image-name>:<tag>!<plugin-name>`
36+
`oci://_<image_name>_:<tag>!_<plugin_name>_`
1437

1538
.Example configuration in `dynamic-plugins.yaml` file
1639
[source,yaml]
@@ -20,10 +43,7 @@ plugins:
2043
package: oci://quay.io/example/image:v0.0.1!backstage-plugin-myplugin
2144
----
2245
--
23-
24-
. Configure authentication for private registries by setting the `REGISTRY_AUTH_FILE` environment variable to the path of the registry configuration file. For example, `~/.config/containers/auth.json` or `~/.docker/config.json`.
25-
26-
. To perform an integrity check, use the image digest in place of the tag in the `dynamic-plugins.yaml` file as follows:
46+
. To perform an integrity check, use the image digest in place of the tag in the `dynamic-plugins.yaml` file as shown in the following example:
2747
+
2848
--
2949
.Example configuration in `dynamic-plugins.yaml` file
@@ -34,5 +54,4 @@ plugins:
3454
package: oci://quay.io/example/image@sha256:28036abec4dffc714394e4ee433f16a59493db8017795049c831be41c02eb5dc!backstage-plugin-myplugin
3555
----
3656
--
37-
3857
. To apply the changes, restart the {product-very-short} application.

0 commit comments

Comments
 (0)