docs.konghq.com icon indicating copy to clipboard operation
docs.konghq.com copied to clipboard

feat: add OCI plugin distribution docs

Open johnharris85 opened this issue 10 months ago • 7 comments

Description

Added docs around using an OCI registry and OSS tooling to sign and distribute custom plugins.

Testing instructions

Preview link: https://deploy-preview-7245--kongdocs.netlify.app/gateway/latest/plugin-development/distribution/#via-oci-artefacts

Checklist

johnharris85 avatar Apr 16 '24 22:04 johnharris85

Deploy Preview for kongdocs ready!

Name Link
Latest commit c0d83565309b73b0f8b3c8e2b752f048a1e99194
Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/663a09ac2223bd0008af4a98
Deploy Preview https://deploy-preview-7245--kongdocs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

Lighthouse
9 paths audited
Performance: 93 (🟢 up 2 from production)
Accessibility: 93 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Apr 16 '24 22:04 netlify[bot]

The flow matches what I expected. I'd like @rspurgeon to review and see how it fits in to the new custom plugin docs

mheap avatar Apr 22 '24 12:04 mheap

Can we add a link directly to the preview build of the page? I can't find the updated doc in unreleased or 3.6

rspurgeon avatar Apr 22 '24 13:04 rspurgeon

Can we add a link directly to the preview build of the page? I can't find the updated doc in unreleased or 3.6

Updated

johnharris85 avatar Apr 22 '24 14:04 johnharris85

The flow matches what I expected. I'd like @rspurgeon to review and see how it fits in to the new custom plugin docs

@mheap @johnharris85 im a little bit curious about this flow. If im a user with say 4-5 custom plugin

  1. i need to create separate ci pipelines per plugin
  2. need to find a way to get this deployed and unpacked (if its a k8s based, init container, and if its a vm then based on the deployment system or some other way)

where as if we go with the bundling of image, i can just live with a single CI/CD pipeline and can still control versioning via image tag. Apart from artifact storage and signing, there is still lot of steps involved from a consumer pov. Are we eventually opening door to options like manageable plugin registry or some ?

sentinelleader avatar Apr 29 '24 21:04 sentinelleader

@rspurgeon have you had time to review this?

Guaris avatar May 01 '24 19:05 Guaris

@rspurgeon have you had time to review this?

@Guaris I made one comment about the title of the document only. The Plugin dev guide quickstart references this page, i'm not sure if this will result in a new URL for this page and we need to update that PR as well.

https://github.com/Kong/docs.konghq.com/pull/7068

rspurgeon avatar May 01 '24 19:05 rspurgeon