Skip to content

Commit 62a993c

Browse files
committed
Fix user story headings/TOC, add unresolved around OCI section
Signed-off-by: Jeremy <[email protected]>
1 parent d4945c7 commit 62a993c

File tree

1 file changed

+14
-4
lines changed
  • keps/sig-cli/2906-kustomize-function-catalog

1 file changed

+14
-4
lines changed

keps/sig-cli/2906-kustomize-function-catalog/README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ tags, and then generate with `hack/update-toc.sh`.
8484
- [Story 3](#story-3)
8585
- [Story 4](#story-4)
8686
- [Story 5](#story-5)
87-
- [Story 5](#story-5-1)
8887
- [Story 6](#story-6)
88+
- [Story 7](#story-7)
8989
- [Notes/Constraints/Caveats (Optional)](#notesconstraintscaveats-optional)
9090
- [Risks and Mitigations](#risks-and-mitigations)
9191
- [Design Details](#design-details)
@@ -477,7 +477,7 @@ This official extension will be embedded within the Kustomize binary and require
477477

478478
Alternatively, this could be published as an external resource that can be pulled by Kustomize as would any other catalog. This would decouple the release cadence of Kustomize and the official extensions, but would introduce extra latency for the end user.
479479

480-
#### Story 5
480+
#### Story 6
481481

482482
As a KRM function developer at company Example Co, I want to contribute a KRM function to the official extension catalog.
483483

@@ -510,7 +510,7 @@ spec:
510510
image: docker.example.io/krm/mcguffin-function:v1.0.0
511511
```
512512

513-
#### Story 6
513+
#### Story 7
514514

515515
As a platform developer at enterprise company Example Co, I wish to publish a trusted function catalog containing functions published by multiple sources, with appropriate metadata:
516516

@@ -539,9 +539,17 @@ spec:
539539
provider:
540540
container:
541541
image: watermelon.gcr.io/krm-functions/salt-function:v1.0.0
542+
- apiVersion: example.com/v1
543+
kind: JavaApplication
544+
description: "A Kustomize function provider that can handle Java apps"
545+
definition: "https://example.com/java/definition"
546+
provider:
547+
container:
548+
image: example/module_providers/java:v1.0.0
549+
requireNetwork: true
550+
requireFilesystem: true
542551
```
543552

544-
545553
### Notes/Constraints/Caveats (Optional)
546554

547555
Not all registries currently support OCI Artifacts, which will constrain the use of that capability. Most major cloud providers and several open source projects, however, support this:
@@ -621,6 +629,7 @@ Once the module list and the catalogs for the resolved composition have been gen
621629

622630
### Use of OCI Artifacts
623631

632+
<<[UNRESOLVED]>>
624633
### OCI Artifacts
625634

626635
While this proposal is largely focused on the introduction of the new Catalog `kind`, the introduction of this kind enables additional distribution and trust mechanisms for non container based function providers and associated resources, like Open API v3 schemas through the use of OCI Artifacts.
@@ -641,6 +650,7 @@ In order to support pulling these resources, the ORAS library could be included
641650
Kustomize function providers that are packaged as OCI images will continue to use the existing OCI media types.
642651

643652
While out of scope of this KEP, the use of OCI artifacts enables additional verification use cases, like the signing and verification of function providers, definitions, and the catalog itself.
653+
<<[/UNRESOLVED]>>
644654

645655
### Test Plan
646656

0 commit comments

Comments
 (0)