@@ -12,10 +12,10 @@ signing mechanisms, input formats, and more, without modifying OCM itself.
1212
1313## Architecture Overview
1414
15- OCM uses a process- based plugin architecture. Each plugin runs as a standalone binary,
15+ OCM uses a process based plugin architecture. Each plugin runs as a standalone binary,
1616separate from the main OCM process. When OCM needs a capability provided by a plugin, it
17- starts the plugin on demand, communicates with it over a local connection (either domain socket or TCP)
18- , and shuts it down when it's no longer needed.
17+ starts the plugin on demand, communicates with it over a local connection (either domain socket or TCP),
18+ and shuts it down when it's no longer needed.
1919
2020The benefits of this design are isolation, language independence (although Go is heavily preferred and supported by
2121an SDK) and lazy loading.
@@ -26,7 +26,7 @@ perspective, once a plugin is installed, its features are available transparentl
2626additional configuration is required beyond installation.
2727
2828This does not mean that configuration cannot be provided! Plugins can have their own
29- configuration requirements that is provided to them through the ocmconfig configuration
29+ configuration requirements that are provided to them through the ` ocmconfig ` configuration
3030file using a specific ` type ` . For example:
3131
3232``` yaml
@@ -41,7 +41,7 @@ configurations:
4141
4242OCM distinguishes between two kinds of plugins:
4343
44- ### Internal (Built- in) Plugins
44+ ### Internal (Built in) Plugins
4545
4646Internal plugins are compiled directly into the OCM binary. They provide core functionality
4747such as OCI registry support. These plugins are always available and require no installation
@@ -59,12 +59,13 @@ External plugins are standalone binaries that you install separately. They exten
5959additional capabilities such as new repository types, credential backends, signing providers, and
6060so on.
6161
62- External plugins follow a standard lifecycle:
62+ External plugins follow this lifecycle:
6363
64- 1. **Install** the plugin binary into OCM's plugin directory.
65- 2. **OCM discovers** the plugin automatically on next use.
66- 3. **On demand**, OCM starts the plugin, queries its capabilities, and routes requests to it.
67- 4. **After idle timeout**, the plugin shuts itself down to free resources.
64+ - install the plugin binary into OCM's plugin directory
65+ - OCM discovers the plugin automatically on next use
66+ - OCM lazy starts the plugin, queries its capabilities, and routes requests to it
67+ - after idle timeout (the plugin isn't doing anything), it shuts itself down to free resources
68+ - if a new request comes in, the cycle starts again from the beginning
6869
6970## Plugin Types
7071
@@ -73,7 +74,7 @@ OCM supports several categories of plugins, each extending a different part of t
7374### Component Version Repository
7475
7576Adds support for storing and retrieving component versions from new repository backends.
76- For example, a plugin could add support for a proprietary artifact store or a cloud- specific
77+ For example, a plugin could add support for a proprietary artifact store or a cloud specific
7778registry.
7879
7980### Credential Repository
@@ -110,8 +111,8 @@ Extends the ability to list components in repositories that require custom enume
110111
111112## Plugin Registry
112113
113- Finding and installing plugins manually — by knowing exact component names and resource
114- identifiers — is not practical at scale. The OCM plugin registry solves this.
114+ Finding and installing plugins manually, by knowing exact component names and resource
115+ identifiers, impractical at scale. The OCM plugin registry solves this.
115116
116117The plugin registry works like a package manager for OCM plugins. It is itself an OCM
117118component version that contains references to all available plugins. This means it benefits
@@ -155,10 +156,10 @@ enforcing your organization's policies without manual steps.
155156### Specialized Build Inputs
156157
157158Your CI pipeline produces Helm charts that need to be packaged into component versions. An
158- ** input plugin** handles the Helm- specific packaging during ` ocm add resources ` , so the
159+ ** input plugin** handles the Helm specific packaging during ` ocm add resources ` , so the
159160chart is correctly processed before being stored.
160161
161- ### Multi- Registry Plugin Management
162+ ### Multi Registry Plugin Management
162163
163164Your organization maintains a private plugin registry for internal tools alongside the
164165public OCM registry. Both are configured in your OCM config, and ` ocm plugin registry list `
0 commit comments