Skip to content

Commit 94bea87

Browse files
committed
chore: release-1.10: refactor community table docs and update script
Signed-off-by: Kim Tsao <ktsao@redhat.com>
1 parent a8cd9be commit 94bea87

5 files changed

Lines changed: 111 additions & 203 deletions

File tree

modules/extend_dynamic-plugins-reference/ref-community-plugins-migration-to-the-github-container-registry.template.adoc

Lines changed: 0 additions & 143 deletions
This file was deleted.

modules/extend_dynamic-plugins-reference/ref-community-plugins-migration-to-the-github-container-registry.adoc renamed to modules/extend_dynamic-plugins-reference/ref-community-plugins.adoc

File renamed without changes.
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
:_mod-docs-content-type: REFERENCE
2+
3+
// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
4+
5+
[id="community-plugins_{context}"]
6+
= {company-name} community supported plugins
7+
8+
[role="_abstract"]
9+
{company-name} provides community support for the following %%COMMUNITY_TABLE_COUNT%% dynamic plugins in `ghcr.io`.
10+
11+
12+
13+
[NOTE]
14+
====
15+
Replace `<tag>` with the version tag corresponding to your {product-short} version. See {dynamic-plugins-reference-book-link}#determining-tag-values[Determining Tag Values]
16+
====
17+
18+
[cols="1,2,3", options="header"]
19+
|===
20+
|Plugin Name
21+
|Plugin Version
22+
|Path ({product-very-short})
23+
24+
%%COMMUNITY_TABLE_CONTENT%%
25+
|===
26+
27+
28+
== Troubleshooting
29+
30+
*Plugin not loading*
31+
32+
If a plugin fails to load, perform the following checks:
33+
34+
. Verify the `ghcr.io` path is correct and the image tag or digest exists.
35+
. Confirm your cluster has network access to `ghcr.io`.
36+
. Review {product-short} logs for OCI pull errors.
37+
38+
*Determining tag values*
39+
40+
include::../../artifacts/snip-tag-for-OCI-package-paths.adoc[]
41+
42+
*Determining SHA256 digests*
43+
44+
You can look up the SHA256 digest using the Skopeo CLI or by searching in the {product-very-short} Plugin Export Overlays repository.
45+
46+
*Skopeo CLI*
47+
48+
Ensure you have `skopeo` and `jq` installed.
49+
50+
. Locate the plugin path in the {dynamic-plugins-reference-book-link}[{dynamic-plugins-reference-book-title}].
51+
. Run the following command, replacing the plugin path prefix `oci://` with `docker://`:
52+
+
53+
[source,bash]
54+
----
55+
skopeo inspect docker://<plugin-path>:<tag> | jq '.Digest'
56+
----
57+
58+
*{product-very-short} Plugin Export Overlays Repo*
59+
60+
Go to the link:https://github.com/orgs/redhat-developer/packages?tab=packages&q=[plugin packages list in the rhdh-plugin-export-overlays repository]. Search for your plugin and select the tag that is associated with this release.
61+
62+
63+
== Additional resources
64+
65+
* link:https://github.com/redhat-developer/rhdh-plugin-export-overlays[{product-very-short} Plugin Export Overlays GitHub repository]

0 commit comments

Comments
 (0)