You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: If the function support a ConfigMap as functionConfig.
649
+
type: boolean
650
+
usage:
651
+
description: |
652
+
A URI pointing to a README.md that describe the details of how to
653
+
use the KRM function. It should at least cover what the function
654
+
does and what functionConfig does it support and it should give
655
+
detailed explanation about each field in the functionConfig.
656
+
type: string
657
+
examples:
658
+
description: |
659
+
A list of URIs that point to README.md files. At least one example
660
+
must be provided. Each README.md should cover an example. It
661
+
should at least cover how to get input resources, how to run it
662
+
and what is the expected output.
663
+
type: array
664
+
items:
665
+
type: string
666
+
license:
667
+
description: The license of the KRM function.
668
+
type: string
669
+
maintainers:
670
+
description: |
671
+
The maintainers for the function. It should only be used
672
+
when the maintainers are different from the ones in
673
+
`spec.maintainers`. When this field is specified, it
674
+
override `spec.maintainers`.
675
+
type: array
676
+
items:
677
+
type: string
678
+
runtime:
679
+
description: |
680
+
The runtime information about the KRM function. One and only one
681
+
of container and exec must be set.
682
+
type: object
683
+
properties:
684
+
container:
685
+
description: The runtime information for container-based KRM function.
686
+
type: object
687
+
required:
688
+
- image
689
+
properties:
690
+
image:
691
+
description: The image name of the KRM function.
692
+
type: string
693
+
sha256:
694
+
description: |
695
+
The digest of the image that can be verified against. It
696
+
is required only when the image is using semver.
697
+
type: string
698
+
requireNetwork:
699
+
description: If network is required to run this function.
700
+
type: boolean
701
+
requireStorageMount:
702
+
description: If storage mount is required to run this function.
703
+
type: boolean
704
+
exec:
705
+
description: The runtime information for exec-based KRM function.
706
+
type: object
707
+
required:
708
+
- platform
709
+
properties:
710
+
platforms:
711
+
description: Per platform runtime information.
712
+
type: array
713
+
items:
714
+
type: object
715
+
required:
716
+
- bin
717
+
- os
718
+
- arch
719
+
- uri
720
+
- sha256
721
+
properties:
722
+
bin:
723
+
description: The binary name.
724
+
type: string
725
+
os:
726
+
description: The target operation system to run the KRM function.
727
+
type: string
728
+
enum:
729
+
- linux
730
+
- darwin
731
+
- windows
732
+
arch:
733
+
description: The target archtechture to run the KRM function.
734
+
type: string
735
+
enum:
736
+
- amd64
737
+
- arm64
738
+
uri:
739
+
description: The location to download the binary.
740
+
type: string
741
+
sha256:
742
+
description: The degist of the binary that can be used to verify the binary.
743
+
type: string
744
+
home:
745
+
description: A URI pointing the home page of the KRM function.
746
+
type: string
747
+
maintainers:
748
+
description: The maintainers for the function.
749
+
type: array
750
+
items:
751
+
type: string
752
+
tags:
753
+
description: |
754
+
The tags (or keywords) of the function. e.g. mutator, validator,
755
+
generator, prefix, GCP.
756
+
type: array
757
+
items:
758
+
type: string
759
+
paths: {}
760
+
```
761
+
</details>
762
+
572
763
The catalog kind will have a YAML representation. This representation will contain metadata about the catalog, such as name labels, as well as a collection of functions. Each function entry will contain an apiVersion and kind, along with one or more references to a function provider (such as a container), as well as an optional information, such as Open API v3 definitions. Function provider references can contain https, git, or OCI references. Additionally, a provider can declare that it requires the use of network or storage mounts, which would otherwise be prohibited. The use of these requires [additional flags](https://github.com/kubernetes-sigs/kustomize/blob/1e1b9b484a836714b57b25c2cd47dda1780610e7/api/types/pluginrestrictions.go#L51-L55) on the command line.
573
764
574
765
When using OCI references, either a tag or digest reference can be provided. Exec functions must include an sha256 hash for verification purposes, although this can also be done by using an OCI digest reference. When a hash verification fails, or a verification hash has not been provided, Kustomize will emit an error to inform the user.
0 commit comments