diff --git a/istio/README.md b/istio/README.md new file mode 100644 index 00000000..6cba5ea7 --- /dev/null +++ b/istio/README.md @@ -0,0 +1,163 @@ +## Introduction + +`istio` is the Istio spec definition + +## Resource + +Code source and document is [here](https://github.com/kcl-lang/artifacthub/tree/main/istio) + +## Index + +- [Introduction](#introduction) +- [Resource](#resource) +- [Index](#index) +- [Schemas](#schemas) + - [ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0](#extensionsistioiov1alpha1wasmpluginspecmatchitems0) + - [Attributes](#attributes) + - [ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0PortsItems0](#extensionsistioiov1alpha1wasmpluginspecmatchitems0portsitems0) + - [Attributes](#attributes-1) + - [ExtensionsIstioIoV1alpha1WasmPluginSpecSelector](#extensionsistioiov1alpha1wasmpluginspecselector) + - [Attributes](#attributes-2) + - [ExtensionsIstioIoV1alpha1WasmPluginSpecTargetRef](#extensionsistioiov1alpha1wasmpluginspectargetref) + - [Attributes](#attributes-3) + - [ExtensionsIstioIoV1alpha1WasmPluginSpecVMConfig](#extensionsistioiov1alpha1wasmpluginspecvmconfig) + - [Attributes](#attributes-4) + - [IstioOperator](#istiooperator) + - [Attributes](#attributes-5) + - [WasmPlugin](#wasmplugin) + - [Attributes](#attributes-6) + - [ManagedFieldsEntry](#managedfieldsentry) + - [Attributes](#attributes-7) + - [ObjectMeta](#objectmeta) + - [Attributes](#attributes-8) + - [OwnerReference](#ownerreference) + - [Attributes](#attributes-9) + +## Schemas + +### ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0 + +extensions istio io v1alpha1 wasm plugin spec match items0 + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**mode**|"UNDEFINED" | "CLIENT" | "SERVER" | "CLIENT_AND_SERVER"|Criteria for selecting traffic by their direction.|| +|**ports**|[[ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0PortsItems0](#extensionsistioiov1alpha1wasmpluginspecmatchitems0portsitems0)]|Criteria for selecting traffic by their destination port.|| +### ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0PortsItems0 + +extensions istio io v1alpha1 wasm plugin spec match items0 ports items0 + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**number** `required`|int|number|| +### ExtensionsIstioIoV1alpha1WasmPluginSpecSelector + +Criteria used to select the specific set of pods/VMs on which this plugin configuration should be applied. + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**matchLabels**|{str:str}|One or more labels that indicate a specific set of pods/VMs on which a policy should be applied.|| +### ExtensionsIstioIoV1alpha1WasmPluginSpecTargetRef + +extensions istio io v1alpha1 wasm plugin spec target ref + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**group**|str|group|| +|**kind**|str|kind|| +|**name**|str|name|| +|**namespace**|str|namespace|| +### ExtensionsIstioIoV1alpha1WasmPluginSpecVMConfig + +Configuration for a Wasm VM. + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**env**|[]|Specifies environment variables to be injected to this VM.|| +### IstioOperator + +install istio io v1alpha1 istio operator + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**apiVersion** `required` `readOnly`|"install.istio.io/v1alpha1"|APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources|"install.istio.io/v1alpha1"| +|**kind** `required` `readOnly`|"IstioOperator"|Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds|"IstioOperator"| +|**metadata**|[ObjectMeta](#objectmeta)|metadata|| +### WasmPlugin + +extensions istio io v1alpha1 wasm plugin + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**apiVersion** `required` `readOnly`|"extensions.istio.io/v1alpha1"|APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources|"extensions.istio.io/v1alpha1"| +|**kind** `required` `readOnly`|"WasmPlugin"|Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds|"WasmPlugin"| +|**metadata**|[ObjectMeta](#objectmeta)|metadata|| +|**spec** `required`|any|spec|| +|**status**|any|status|| +### ManagedFieldsEntry + +ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to. + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**apiVersion**|str|APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.|| +|**fieldsType**|str|FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"|| +|**fieldsV1**|any|FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.|| +|**manager**|str|Manager is an identifier of the workflow managing these fields.|| +|**operation**|str|Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.|| +|**time**|str|Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply'|| +### ObjectMeta + +ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**annotations**|{str:str}|Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations|| +|**clusterName**|str|The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.|| +|**creationTimestamp**|str|CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata|| +|**deletionGracePeriodSeconds**|int|Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.|| +|**deletionTimestamp**|str|DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata|| +|**finalizers**|[str]|Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.|| +|**generateName**|str|GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency|| +|**generation**|int|A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.|| +|**labels**|{str:str}|Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels|| +|**managedFields**|[[ManagedFieldsEntry](#managedfieldsentry)]|ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.|| +|**name**|str|Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names|| +|**namespace**|str|Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces|| +|**ownerReferences**|[[OwnerReference](#ownerreference)]|List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.|| +|**resourceVersion**|str|An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency|| +|**selfLink**|str|SelfLink is a URL representing this object. Populated by the system. Read-only.

DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release.|| +|**uid**|str|UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids|| +### OwnerReference + +OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field. + +#### Attributes + +| name | type | description | default value | +| --- | --- | --- | --- | +|**apiVersion** `required`|str|API version of the referent.|| +|**blockOwnerDeletion**|bool|If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.|| +|**controller**|bool|If true, this reference points to the managing controller.|| +|**kind** `required`|str|Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds|| +|**name** `required`|str|Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names|| +|**uid** `required`|str|UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids|| + diff --git a/istio/extensions_istio_io_v1alpha1_wasm_plugin.k b/istio/extensions_istio_io_v1alpha1_wasm_plugin.k new file mode 100644 index 00000000..ff74deec --- /dev/null +++ b/istio/extensions_istio_io_v1alpha1_wasm_plugin.k @@ -0,0 +1,241 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import k8s.apimachinery.pkg.apis.meta.v1 + + +schema WasmPlugin: + """ + extensions istio io v1alpha1 wasm plugin + + Attributes + ---------- + apiVersion : str, default is "extensions.istio.io/v1alpha1", required + APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + kind : str, default is "WasmPlugin", required + Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + spec : ExtensionsIstioIoV1alpha1WasmPluginSpec, default is Undefined, required + spec + status : any, default is Undefined, optional + status + """ + + + apiVersion: "extensions.istio.io/v1alpha1" = "extensions.istio.io/v1alpha1" + + kind: "WasmPlugin" = "WasmPlugin" + + metadata?: v1.ObjectMeta + + spec: ExtensionsIstioIoV1alpha1WasmPluginSpec + + status?: any + + + check: + + +schema ExtensionsIstioIoV1alpha1WasmPluginSpec: + """ + Extend the functionality provided by the Istio proxy through WebAssembly filters. See more details at: https://istio.io/docs/reference/config/proxy_extensions/wasm-plugin.html + + Attributes + ---------- + failStrategy : str, default is Undefined, optional + Specifies the failure behavior for the plugin due to fatal errors. + imagePullPolicy : str, default is Undefined, optional + The pull behaviour to be applied when fetching Wasm module by either OCI image or http/https. + imagePullSecret : str, default is Undefined, optional + Credentials to use for OCI image pulling. + match : [ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0], default is Undefined, optional + Specifies the criteria to determine which traffic is passed to WasmPlugin. + phase : str, default is Undefined, optional + Determines where in the filter chain this `WasmPlugin` is to be injected. + pluginConfig : any, default is Undefined, optional + The configuration that will be passed on to the plugin. + pluginName : str, default is Undefined, optional + The plugin name to be used in the Envoy configuration (used to be called `rootID`). + priority : int, default is Undefined, optional + Determines ordering of `WasmPlugins` in the same `phase`. + selector : ExtensionsIstioIoV1alpha1WasmPluginSpecSelector, default is Undefined, optional + selector + sha256 : str, default is Undefined, optional + SHA256 checksum that will be used to verify Wasm module or OCI container. + targetRef : ExtensionsIstioIoV1alpha1WasmPluginSpecTargetRef, default is Undefined, optional + target ref + $type : str, default is Undefined, optional + Specifies the type of Wasm Extension to be used. + url : str, default is Undefined, required + URL of a Wasm module or OCI container. + verificationKey : str, default is Undefined, optional + verification key + vmConfig : ExtensionsIstioIoV1alpha1WasmPluginSpecVMConfig, default is Undefined, optional + vm config + """ + + + failStrategy?: "FAIL_CLOSE" | "FAIL_OPEN" + + imagePullPolicy?: "UNSPECIFIED_POLICY" | "IfNotPresent" | "Always" + + imagePullSecret?: str + + match?: [ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0] + + phase?: "UNSPECIFIED_PHASE" | "AUTHN" | "AUTHZ" | "STATS" + + pluginConfig?: any + + pluginName?: str + + priority?: int + + selector?: ExtensionsIstioIoV1alpha1WasmPluginSpecSelector + + sha256?: str + + targetRef?: ExtensionsIstioIoV1alpha1WasmPluginSpecTargetRef + + $type?: "UNSPECIFIED_PLUGIN_TYPE" | "HTTP" | "NETWORK" + + url: str + + verificationKey?: str + + vmConfig?: ExtensionsIstioIoV1alpha1WasmPluginSpecVMConfig + + + check: + len(imagePullSecret) <= 253 + len(imagePullSecret) >= 1 + len(pluginName) <= 256 + len(pluginName) >= 1 + matchPattern(sha256, (^$|^[a-f0-9]{64}$)) + len(url) >= 1 + + +schema ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0: + """ + extensions istio io v1alpha1 wasm plugin spec match items0 + + Attributes + ---------- + mode : str, default is Undefined, optional + Criteria for selecting traffic by their direction. + ports : [ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0PortsItems0], default is Undefined, optional + Criteria for selecting traffic by their destination port. + """ + + + mode?: "UNDEFINED" | "CLIENT" | "SERVER" | "CLIENT_AND_SERVER" + + ports?: [ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0PortsItems0] + + +schema ExtensionsIstioIoV1alpha1WasmPluginSpecMatchItems0PortsItems0: + """ + extensions istio io v1alpha1 wasm plugin spec match items0 ports items0 + + Attributes + ---------- + number : int, default is Undefined, required + number + """ + + + number: int + + + check: + number <= 65535 + number >= 1 + + +schema ExtensionsIstioIoV1alpha1WasmPluginSpecSelector: + """ + Criteria used to select the specific set of pods/VMs on which this plugin configuration should be applied. + + Attributes + ---------- + matchLabels : {str:str}, default is Undefined, optional + One or more labels that indicate a specific set of pods/VMs on which a policy should be applied. + """ + + + matchLabels?: {str:str} + + +schema ExtensionsIstioIoV1alpha1WasmPluginSpecTargetRef: + """ + extensions istio io v1alpha1 wasm plugin spec target ref + + Attributes + ---------- + group : str, default is Undefined, optional + group + kind : str, default is Undefined, optional + kind + name : str, default is Undefined, optional + name + namespace : str, default is Undefined, optional + namespace + """ + + + group?: str + + kind?: str + + name?: str + + namespace?: str + + +schema ExtensionsIstioIoV1alpha1WasmPluginSpecVMConfig: + """ + Configuration for a Wasm VM. + + Attributes + ---------- + env : [ExtensionsIstioIoV1alpha1WasmPluginSpecVMConfigEnvItems0], default is Undefined, optional + Specifies environment variables to be injected to this VM. + """ + + + env?: [ExtensionsIstioIoV1alpha1WasmPluginSpecVMConfigEnvItems0] + + + check: + + +schema ExtensionsIstioIoV1alpha1WasmPluginSpecVMConfigEnvItems0: + """ + extensions istio io v1alpha1 wasm plugin spec VM config env items0 + + Attributes + ---------- + name : str, default is Undefined, required + Name of the environment variable. + value : str, default is Undefined, optional + Value for the environment variable. + valueFrom : str, default is Undefined, optional + Source for the environment variable's value. + """ + + + name: str + + value?: str + + valueFrom?: "INLINE" | "HOST" + + + check: + len(name) <= 256 + len(name) >= 1 + len(value) <= 2048 + + diff --git a/istio/install_istio_io_v1alpha1_istio_operator.k b/istio/install_istio_io_v1alpha1_istio_operator.k new file mode 100644 index 00000000..cca825b2 --- /dev/null +++ b/istio/install_istio_io_v1alpha1_istio_operator.k @@ -0,0 +1,29 @@ +""" +This file was generated by the KCL auto-gen tool. DO NOT EDIT. +Editing this file might prove futile when you re-run the KCL auto-gen generate command. +""" +import k8s.apimachinery.pkg.apis.meta.v1 + + +schema IstioOperator: + """ + install istio io v1alpha1 istio operator + + Attributes + ---------- + apiVersion : str, default is "install.istio.io/v1alpha1", required + APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + kind : str, default is "IstioOperator", required + Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + metadata : v1.ObjectMeta, default is Undefined, optional + metadata + """ + + + apiVersion: "install.istio.io/v1alpha1" = "install.istio.io/v1alpha1" + + kind: "IstioOperator" = "IstioOperator" + + metadata?: v1.ObjectMeta + + diff --git a/istio/kcl.mod b/istio/kcl.mod new file mode 100644 index 00000000..1273efe6 --- /dev/null +++ b/istio/kcl.mod @@ -0,0 +1,8 @@ +[package] +name = "istio" +edition = "*" +version = "0.1.0" +description = "`istio` is the Istio spec definition" + +[dependencies] +k8s = "1.28" diff --git a/istio/kcl.mod.lock b/istio/kcl.mod.lock new file mode 100644 index 00000000..8c61a23b --- /dev/null +++ b/istio/kcl.mod.lock @@ -0,0 +1,9 @@ +[dependencies] + [dependencies.k8s] + name = "k8s" + full_name = "k8s_1.28" + version = "1.28" + sum = "aTxPUVZyr9MdiB3YdiY/8pCh9sC55yURnZdGlJsKG6Q=" + reg = "ghcr.io" + repo = "kcl-lang/k8s" + oci_tag = "1.28"