|
2 | 2 |
|
3 | 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 | 4 |
|
5 | | -[id="community-plugins-migration-to-the-github-container-registry_{context}"] |
6 | | -= Community plugins migration to the GitHub Container Registry |
| 5 | +[id="community-plugins_{context}"] |
| 6 | += {company-name} community supported plugins |
7 | 7 |
|
8 | 8 | [role="_abstract"] |
9 | | -Starting with {product} 1.9, community-supported plugins are no longer distributed as bundled wrappers in the {product-short} container image. Update your dynamic plugins configuration to use the new GitHub Container Registry paths. |
| 9 | +{company-name} provides community support for the following %%COMMUNITY_TABLE_COUNT%% dynamic plugins in `ghcr.io`. |
10 | 10 |
|
11 | | -[IMPORTANT] |
12 | | -==== |
13 | | -*Breaking Change in {product-very-short} 1.9* |
14 | | -
|
15 | | -These plugins are now built using GitHub Actions and published exclusively to the GitHub Container Registry (ghcr.io). |
16 | | -
|
17 | | -If you use the plugins listed in this section, you must update your dynamic plugins configuration (in `dynamic-plugins-default.yaml`, your ConfigMap or CustomResource) to use the new `oci://ghcr.io/...` paths. |
18 | | -==== |
19 | | - |
20 | | -== What changed |
21 | | - |
22 | | -In {product-short} 1.8 and earlier, community plugins were: |
23 | | - |
24 | | -* Wrapped and bundled in the {product-short} container image. |
25 | | -* Referenced by using local paths, such as `./dynamic-plugins/dist/<plugin-name>`. |
26 | | - |
27 | | -Starting with {product-short} 1.9, community plugins are: |
28 | | - |
29 | | -* Built using GitHub Actions from the link:https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays] repository. |
30 | | -* Published to `ghcr.io/redhat-developer/rhdh-plugin-export-overlays`. |
31 | | -* Referenced by using OCI registry paths, such as `oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/<oci-artifact-name>:<tag>`. |
32 | | -+ |
33 | | -include::{docdir}/artifacts/snip-tag-for-sha256-tip.adoc[] |
34 | | - |
35 | | -== Migration steps |
36 | | - |
37 | | -To migrate your configuration: |
38 | | - |
39 | | -. Identify plugins in your ConfigMap or CustomResource that use local paths starting with `./dynamic-plugins/dist/`. |
40 | | -. Find the corresponding `ghcr.io` path in the following migration table: |
41 | | -+ |
42 | | -[source,yaml] |
43 | | ----- |
44 | | -# Before ({product-very-short} 1.8 and earlier) |
45 | | -plugins: |
46 | | - - package: ./dynamic-plugins/dist/backstage-community-plugin-jenkins |
47 | | - disabled: false |
48 | | -
|
49 | | -# After ({product-very-short} 1.9+) |
50 | | -plugins: |
51 | | - - package: oci://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/backstage-community-plugin-jenkins:bs_1.45.3__0.26.0 |
52 | | - disabled: false |
53 | | ----- |
54 | 11 |
|
55 | | -. Update your configuration to use the new OCI registry path. |
56 | | - |
57 | | - |
58 | | -== Understanding the tag format |
59 | | - |
60 | | -The `ghcr.io` image tags use the following format: `bs_<backstage-version>__<plugin-version>` |
61 | | - |
62 | | -Example: `bs_1.45.3__0.26.0`: |
63 | | -where |
64 | | -* `bs_1.45.3`: Built against {backstage} version 1.45.3 |
65 | | -* `0.26.0`: Node.js-packaged {backstage} plugin, version 0.26.0 |
66 | | - |
67 | | -See {dynamic-plugins-reference-book-link}#determining-tag-values[Determining Tag Values] |
68 | | - |
69 | | -== Community plugins migration table |
70 | | - |
71 | | -The following table lists all %%MIGRATION_COUNT%% community-supported plugins that have been migrated from bundled wrappers to `ghcr.io`. |
72 | 12 |
|
73 | 13 | [NOTE] |
74 | 14 | ==== |
75 | 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] |
76 | 16 | ==== |
77 | 17 |
|
78 | | -include::{docdir}/artifacts/snip-tag-for-sha256-tip.adoc[] |
79 | | - |
80 | | -[cols="1,2,3,4", options="header"] |
| 18 | +[cols="1,2,3", options="header"] |
81 | 19 | |=== |
82 | 20 | |Plugin Name |
83 | 21 | |Plugin Version |
84 | | -|Old Path ({product-very-short} 1.8) |
85 | | -|New Path ({product-very-short} 1.9+) |
| 22 | +|Path ({product-very-short}) |
86 | 23 |
|
87 | | -%%MIGRATION_TABLE%% |
| 24 | +%%COMMUNITY_TABLE_CONTENT%% |
88 | 25 | |=== |
89 | 26 |
|
90 | | -== Plugins remaining bundled in {product-very-short} 1.9 |
91 | | - |
92 | | -The following plugins remain bundled in 1.9 while transitioning to `ghcr.io` distribution in a future release: |
93 | | - |
94 | | -[cols="1,2,3,4", options="header"] |
95 | | -|=== |
96 | | -|Plugin Name |
97 | | -|Plugin Version |
98 | | -|Current Path ({product-very-short} 1.9) |
99 | | -|Future Path ({product-very-short} 1.10+) |
100 | | - |
101 | | -%%BUNDLED_PLUGINS%% |
102 | | -|=== |
103 | 27 |
|
104 | 28 | == Troubleshooting |
105 | 29 |
|
106 | | -*Plugin not loading after migration* |
| 30 | +*Plugin not loading* |
107 | 31 |
|
108 | 32 | If a plugin fails to load, perform the following checks: |
109 | 33 |
|
110 | 34 | . Verify the `ghcr.io` path is correct and the image tag or digest exists. |
111 | 35 | . Confirm your cluster has network access to `ghcr.io`. |
112 | 36 | . Review {product-short} logs for OCI pull errors. |
113 | 37 |
|
114 | | -include::{docdir}/artifacts/snip-tag-for-sha256-tip.adoc[] |
115 | | - |
116 | 38 | *Determining tag values* |
117 | 39 |
|
118 | | -include::{docdir}/artifacts/snip-tag-for-OCI-package-paths.adoc[] |
| 40 | +include::../../artifacts/snip-tag-for-OCI-package-paths.adoc[] |
119 | 41 |
|
120 | 42 | *Determining SHA256 digests* |
121 | 43 |
|
|
0 commit comments