infra/crds-catalog
1
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

auto-update crds catalog

Browse Source
This commit is contained in:
Drone Shipper 2024-05-14 11:44:32 +00:00
parent b403b6e2a8
commit e6acab9dbc
50 changed files with 15270 additions and 939 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11857
_definitions.json.toolkit.fluxcd.io/_definitions.json__definitions.json Normal file
View File

File diff suppressed because it is too large Load Diff

7
_definitions.json.toolkit.fluxcd.io/all-anyOf.json Normal file
View File

@ -0,0 +1,7 @@
{
"anyOf": [
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/_definitions.json.toolkit.fluxcd.io/_definitions.json__definitions.json"
}
]
}

7
_definitions.json.toolkit.fluxcd.io/all-oneOf.json Normal file
View File

@ -0,0 +1,7 @@
{
"oneOf": [
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/_definitions.json.toolkit.fluxcd.io/_definitions.json__definitions.json"
}
]
}

7
all.json.toolkit.fluxcd.io/all-anyOf.json Normal file
View File

@ -0,0 +1,7 @@
{
"anyOf": [
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/all.json.toolkit.fluxcd.io/all.json_all.json"
}
]
}

7
all.json.toolkit.fluxcd.io/all-oneOf.json Normal file
View File

@ -0,0 +1,7 @@
{
"oneOf": [
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/all.json.toolkit.fluxcd.io/all.json_all.json"
}
]
}

103
all.json.toolkit.fluxcd.io/all.json_all.json Normal file
View File

@ -0,0 +1,103 @@
{
"oneOf": [
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1beta1.Alert"
},
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1beta2.Alert"
},
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1beta3.Alert"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta1.Bucket"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta2.Bucket"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1.GitRepository"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta1.GitRepository"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta2.GitRepository"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1.HelmChart"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta1.HelmChart"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta2.HelmChart"
},
{
"$ref": "_definitions.json#/definitions/helm.toolkit.fluxcd.io.v2.HelmRelease"
},
{
"$ref": "_definitions.json#/definitions/helm.toolkit.fluxcd.io.v2beta1.HelmRelease"
},
{
"$ref": "_definitions.json#/definitions/helm.toolkit.fluxcd.io.v2beta2.HelmRelease"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1.HelmRepository"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta1.HelmRepository"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta2.HelmRepository"
},
{
"$ref": "_definitions.json#/definitions/image.toolkit.fluxcd.io.v1beta1.ImagePolicy"
},
{
"$ref": "_definitions.json#/definitions/image.toolkit.fluxcd.io.v1beta2.ImagePolicy"
},
{
"$ref": "_definitions.json#/definitions/image.toolkit.fluxcd.io.v1beta1.ImageRepository"
},
{
"$ref": "_definitions.json#/definitions/image.toolkit.fluxcd.io.v1beta2.ImageRepository"
},
{
"$ref": "_definitions.json#/definitions/image.toolkit.fluxcd.io.v1beta1.ImageUpdateAutomation"
},
{
"$ref": "_definitions.json#/definitions/image.toolkit.fluxcd.io.v1beta2.ImageUpdateAutomation"
},
{
"$ref": "_definitions.json#/definitions/kustomize.toolkit.fluxcd.io.v1.Kustomization"
},
{
"$ref": "_definitions.json#/definitions/kustomize.toolkit.fluxcd.io.v1beta1.Kustomization"
},
{
"$ref": "_definitions.json#/definitions/kustomize.toolkit.fluxcd.io.v1beta2.Kustomization"
},
{
"$ref": "_definitions.json#/definitions/source.toolkit.fluxcd.io.v1beta2.OCIRepository"
},
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1beta1.Provider"
},
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1beta2.Provider"
},
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1beta3.Provider"
},
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1.Receiver"
},
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1beta1.Receiver"
},
{
"$ref": "_definitions.json#/definitions/notification.toolkit.fluxcd.io.v1beta2.Receiver"
}
]
}

3
helm.toolkit.fluxcd.io/all-anyOf.json
View File

@ -1,5 +1,8 @@
{ {
"anyOf": [ "anyOf": [
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/helm.toolkit.fluxcd.io/helmrelease_v2.json"
},
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/helm.toolkit.fluxcd.io/helmrelease_v2beta1.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/helm.toolkit.fluxcd.io/helmrelease_v2beta1.json"
}, },

3
helm.toolkit.fluxcd.io/all-oneOf.json
View File

@ -1,5 +1,8 @@
{ {
"oneOf": [ "oneOf": [
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/helm.toolkit.fluxcd.io/helmrelease_v2.json"
},
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/helm.toolkit.fluxcd.io/helmrelease_v2beta1.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/helm.toolkit.fluxcd.io/helmrelease_v2beta1.json"
}, },

1042
helm.toolkit.fluxcd.io/helmrelease_v2.json Normal file
View File

File diff suppressed because it is too large Load Diff

294
helm.toolkit.fluxcd.io/helmrelease_v2beta1.json
View File

@ -2,11 +2,11 @@
"description": "HelmRelease is the Schema for the helmreleases API", "description": "HelmRelease is the Schema for the helmreleases API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,7 +16,7 @@
"description": "HelmReleaseSpec defines the desired state of a Helm release.", "description": "HelmReleaseSpec defines the desired state of a Helm release.",
"properties": { "properties": {
"chart": { "chart": {
"description": "Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease.", "description": "Chart defines the template of the v1beta2.HelmChart that should be created\nfor this HelmRelease.",
"properties": { "properties": {
"metadata": { "metadata": {
"description": "ObjectMeta holds the template for metadata like labels and annotations.", "description": "ObjectMeta holds the template for metadata like labels and annotations.",
@ -25,14 +25,14 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/",
"type": "object" "type": "object"
}, },
"labels": { "labels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
"type": "object" "type": "object"
} }
}, },
@ -47,13 +47,13 @@
"type": "string" "type": "string"
}, },
"interval": { "interval": {
"description": "Interval at which to check the v1beta2.Source for updates. Defaults to 'HelmReleaseSpec.Interval'.", "description": "Interval at which to check the v1beta2.Source for updates. Defaults to\n'HelmReleaseSpec.Interval'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"reconcileStrategy": { "reconcileStrategy": {
"default": "ChartVersion", "default": "ChartVersion",
"description": "Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.", "description": "Determines what enables the creation of a new artifact. Valid values are\n('ChartVersion', 'Revision').\nSee the documentation of the values for an explanation on their behavior.\nDefaults to ChartVersion when omitted.",
"enum": [ "enum": [
"ChartVersion", "ChartVersion",
"Revision" "Revision"
@ -96,18 +96,18 @@
"additionalProperties": false "additionalProperties": false
}, },
"valuesFile": { "valuesFile": {
"description": "Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted.", "description": "Alternative values file to use as the default chart values, expected to\nbe a relative path in the SourceRef. Deprecated in favor of ValuesFiles,\nfor backwards compatibility the file defined here is merged before the\nValuesFiles items. Ignored when omitted.",
"type": "string" "type": "string"
}, },
"valuesFiles": { "valuesFiles": {
"description": "Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted.", "description": "Alternative list of values files to use as the chart values (values.yaml\nis not included by default), expected to be a relative path in the SourceRef.\nValues files are merged in the order of this list with the last file overriding\nthe first. Ignored when omitted.",
"items": { "items": {
"type": "string" "type": "string"
}, },
"type": "array" "type": "array"
}, },
"verify": { "verify": {
"description": "Verify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic. This field is only supported for OCI sources. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified.", "description": "Verify contains the secret name containing the trusted public keys\nused to verify the signature and specifies which provider to use to check\nwhether OCI image is authentic.\nThis field is only supported for OCI sources.\nChart dependencies, which are not bundled in the umbrella chart artifact, are not verified.",
"properties": { "properties": {
"provider": { "provider": {
"default": "cosign", "default": "cosign",
@ -118,7 +118,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Kubernetes Secret containing the trusted public keys.", "description": "SecretRef specifies the Kubernetes Secret containing the\ntrusted public keys.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -140,7 +140,7 @@
}, },
"version": { "version": {
"default": "*", "default": "*",
"description": "Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted.", "description": "Version semver expression, ignored for charts from v1beta2.GitRepository and\nv1beta2.Bucket sources. Defaults to latest when omitted.",
"type": "string" "type": "string"
} }
}, },
@ -158,10 +158,45 @@
"type": "object", "type": "object",
"additionalProperties": false "additionalProperties": false
}, },
"chartRef": {
"description": "ChartRef holds a reference to a source controller resource containing the\nHelm chart artifact.\n\n\nNote: this field is provisional to the v2 API, and not actively used\nby v2beta1 HelmReleases.",
"properties": {
"apiVersion": {
"description": "APIVersion of the referent.",
"type": "string"
},
"kind": {
"description": "Kind of the referent.",
"enum": [
"OCIRepository",
"HelmChart"
],
"type": "string"
},
"name": {
"description": "Name of the referent.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"namespace": {
"description": "Namespace of the referent, defaults to the namespace of the Kubernetes\nresource object that contains the reference.",
"maxLength": 63,
"minLength": 1,
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object",
"additionalProperties": false
},
"dependsOn": { "dependsOn": {
"description": "DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled.", "description": "DependsOn may contain a meta.NamespacedObjectReference slice with\nreferences to HelmRelease resources that must be ready before this HelmRelease\ncan be reconciled.",
"items": { "items": {
"description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any namespace.", "description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any\nnamespace.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -181,37 +216,37 @@
"type": "array" "type": "array"
}, },
"driftDetection": { "driftDetection": {
"description": "DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases.", "description": "DriftDetection holds the configuration for detecting and handling\ndifferences between the manifest in the Helm storage and the resources\ncurrently existing in the cluster.\n\n\nNote: this field is provisional to the v2beta2 API, and not actively used\nby v2beta1 HelmReleases.",
"properties": { "properties": {
"ignore": { "ignore": {
"description": "Ignore contains a list of rules for specifying which changes to ignore during diffing.", "description": "Ignore contains a list of rules for specifying which changes to ignore\nduring diffing.",
"items": { "items": {
"description": "IgnoreRule defines a rule to selectively disregard specific changes during the drift detection process.", "description": "IgnoreRule defines a rule to selectively disregard specific changes during\nthe drift detection process.",
"properties": { "properties": {
"paths": { "paths": {
"description": "Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object.", "description": "Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from\nconsideration in a Kubernetes object.",
"items": { "items": {
"type": "string" "type": "string"
}, },
"type": "array" "type": "array"
}, },
"target": { "target": {
"description": "Target is a selector for specifying Kubernetes objects to which this rule applies. If Target is not set, the Paths will be ignored for all Kubernetes objects within the manifest of the Helm release.", "description": "Target is a selector for specifying Kubernetes objects to which this\nrule applies.\nIf Target is not set, the Paths will be ignored for all Kubernetes\nobjects within the manifest of the Helm release.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -223,7 +258,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -240,7 +275,7 @@
"type": "array" "type": "array"
}, },
"mode": { "mode": {
"description": "Mode defines how differences should be handled between the Helm manifest and the manifest currently applied to the cluster. If not explicitly set, it defaults to DiffModeDisabled.", "description": "Mode defines how differences should be handled between the Helm manifest\nand the manifest currently applied to the cluster.\nIf not explicitly set, it defaults to DiffModeDisabled.",
"enum": [ "enum": [
"enabled", "enabled",
"warn", "warn",
@ -256,7 +291,7 @@
"description": "Install holds the configuration for Helm install actions for this HelmRelease.", "description": "Install holds the configuration for Helm install actions for this HelmRelease.",
"properties": { "properties": {
"crds": { "crds": {
"description": "CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Create` and if omitted CRDs are installed but not updated. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n By default, CRDs are applied (installed) during Helm install action. With this option users can opt-in to CRD replace existing CRDs on Helm install actions, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.", "description": "CRDs upgrade CRDs from the Helm Chart's crds directory according\nto the CRD upgrade policy provided here. Valid values are `Skip`,\n`Create` or `CreateReplace`. Default is `Create` and if omitted\nCRDs are installed but not updated.\n\n\nSkip: do neither install nor replace (update) any CRDs.\n\n\nCreate: new CRDs are created, existing CRDs are neither updated nor deleted.\n\n\nCreateReplace: new CRDs are created, existing CRDs are updated (replaced)\nbut not deleted.\n\n\nBy default, CRDs are applied (installed) during Helm install action.\nWith this option users can opt-in to CRD replace existing CRDs on Helm\ninstall actions, which is not (yet) natively supported by Helm.\nhttps://helm.sh/docs/chart_best_practices/custom_resource_definitions.",
"enum": [ "enum": [
"Skip", "Skip",
"Create", "Create",
@ -265,7 +300,7 @@
"type": "string" "type": "string"
}, },
"createNamespace": { "createNamespace": {
"description": "CreateNamespace tells the Helm install action to create the HelmReleaseSpec.TargetNamespace if it does not exist yet. On uninstall, the namespace will not be garbage collected.", "description": "CreateNamespace tells the Helm install action to create the\nHelmReleaseSpec.TargetNamespace if it does not exist yet.\nOn uninstall, the namespace will not be garbage collected.",
"type": "boolean" "type": "boolean"
}, },
"disableHooks": { "disableHooks": {
@ -273,30 +308,30 @@
"type": "boolean" "type": "boolean"
}, },
"disableOpenAPIValidation": { "disableOpenAPIValidation": {
"description": "DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema.", "description": "DisableOpenAPIValidation prevents the Helm install action from validating\nrendered templates against the Kubernetes OpenAPI Schema.",
"type": "boolean" "type": "boolean"
}, },
"disableWait": { "disableWait": {
"description": "DisableWait disables the waiting for resources to be ready after a Helm install has been performed.", "description": "DisableWait disables the waiting for resources to be ready after a Helm\ninstall has been performed.",
"type": "boolean" "type": "boolean"
}, },
"disableWaitForJobs": { "disableWaitForJobs": {
"description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed.", "description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm\ninstall has been performed.",
"type": "boolean" "type": "boolean"
}, },
"remediation": { "remediation": {
"description": "Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action.", "description": "Remediation holds the remediation configuration for when the Helm install\naction for the HelmRelease fails. The default is to not perform any action.",
"properties": { "properties": {
"ignoreTestFailures": { "ignoreTestFailures": {
"description": "IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to 'Test.IgnoreFailures'.", "description": "IgnoreTestFailures tells the controller to skip remediation when the Helm\ntests are run after an install action but fail. Defaults to\n'Test.IgnoreFailures'.",
"type": "boolean" "type": "boolean"
}, },
"remediateLastFailure": { "remediateLastFailure": {
"description": "RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false'.", "description": "RemediateLastFailure tells the controller to remediate the last failure, when\nno retries remain. Defaults to 'false'.",
"type": "boolean" "type": "boolean"
}, },
"retries": { "retries": {
"description": "Retries is the number of retries that should be attempted on failures before bailing. Remediation, using an uninstall, is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries.", "description": "Retries is the number of retries that should be attempted on failures before\nbailing. Remediation, using an uninstall, is performed between each attempt.\nDefaults to '0', a negative integer equals to unlimited retries.",
"type": "integer" "type": "integer"
} }
}, },
@ -304,15 +339,15 @@
"additionalProperties": false "additionalProperties": false
}, },
"replace": { "replace": {
"description": "Replace tells the Helm install action to re-use the 'ReleaseName', but only if that name is a deleted release which remains in the history.", "description": "Replace tells the Helm install action to re-use the 'ReleaseName', but only\nif that name is a deleted release which remains in the history.",
"type": "boolean" "type": "boolean"
}, },
"skipCRDs": { "skipCRDs": {
"description": "SkipCRDs tells the Helm install action to not install any CRDs. By default, CRDs are installed if not already present. \n Deprecated use CRD policy (`crds`) attribute with value `Skip` instead.", "description": "SkipCRDs tells the Helm install action to not install any CRDs. By default,\nCRDs are installed if not already present.\n\n\nDeprecated use CRD policy (`crds`) attribute with value `Skip` instead.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm install action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like\nJobs for hooks) during the performance of a Helm install action. Defaults to\n'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -321,15 +356,15 @@
"additionalProperties": false "additionalProperties": false
}, },
"interval": { "interval": {
"description": "Interval at which to reconcile the Helm release. This interval is approximate and may be subject to jitter to ensure efficient use of resources.", "description": "Interval at which to reconcile the Helm release.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"kubeConfig": { "kubeConfig": {
"description": "KubeConfig for reconciling the HelmRelease on a remote cluster. When used in combination with HelmReleaseSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when HelmReleaseSpec.ServiceAccountName is empty.", "description": "KubeConfig for reconciling the HelmRelease on a remote cluster.\nWhen used in combination with HelmReleaseSpec.ServiceAccountName,\nforces the controller to act on behalf of that Service Account at the\ntarget cluster.\nIf the --default-service-account flag is set, its value will be used as\na controller level fallback for when HelmReleaseSpec.ServiceAccountName\nis empty.",
"properties": { "properties": {
"secretRef": { "secretRef": {
"description": "SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources.", "description": "SecretRef holds the name of a secret that contains a key with\nthe kubeconfig file as the value. If no key is set, the key will default\nto 'value'.\nIt is recommended that the kubeconfig is self-contained, and the secret\nis regularly updated if credentials such as a cloud-access-token expire.\nCloud specific `cmd-path` auth helpers will not function without adding\nbinaries and credentials to the Pod that is responsible for reconciling\nKubernetes resources.",
"properties": { "properties": {
"key": { "key": {
"description": "Key in the Secret, when not specified an implementation-specific default key is used.", "description": "Key in the Secret, when not specified an implementation-specific default key is used.",
@ -354,15 +389,15 @@
"additionalProperties": false "additionalProperties": false
}, },
"maxHistory": { "maxHistory": {
"description": "MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use '0' for an unlimited number of revisions; defaults to '10'.", "description": "MaxHistory is the number of revisions saved by Helm for this HelmRelease.\nUse '0' for an unlimited number of revisions; defaults to '10'.",
"type": "integer" "type": "integer"
}, },
"persistentClient": { "persistentClient": {
"description": "PersistentClient tells the controller to use a persistent Kubernetes client for this release. When enabled, the client will be reused for the duration of the reconciliation, instead of being created and destroyed for each (step of a) Helm action. \n This can improve performance, but may cause issues with some Helm charts that for example do create Custom Resource Definitions during installation outside Helm's CRD lifecycle hooks, which are then not observed to be available by e.g. post-install hooks. \n If not set, it defaults to true.", "description": "PersistentClient tells the controller to use a persistent Kubernetes\nclient for this release. When enabled, the client will be reused for the\nduration of the reconciliation, instead of being created and destroyed\nfor each (step of a) Helm action.\n\n\nThis can improve performance, but may cause issues with some Helm charts\nthat for example do create Custom Resource Definitions during installation\noutside Helm's CRD lifecycle hooks, which are then not observed to be\navailable by e.g. post-install hooks.\n\n\nIf not set, it defaults to true.",
"type": "boolean" "type": "boolean"
}, },
"postRenderers": { "postRenderers": {
"description": "PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition.", "description": "PostRenderers holds an array of Helm PostRenderers, which will be applied in order\nof their definition.",
"items": { "items": {
"description": "PostRenderer contains a Helm PostRenderer specification.", "description": "PostRenderer contains a Helm PostRenderer specification.",
"properties": { "properties": {
@ -370,12 +405,12 @@
"description": "Kustomization to apply as PostRenderer.", "description": "Kustomization to apply as PostRenderer.",
"properties": { "properties": {
"images": { "images": {
"description": "Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.", "description": "Images is a list of (image name, new name, new tag or digest)\nfor changing image names, tags or digests. This can also be achieved with a\npatch, but this operator is simpler to specify.",
"items": { "items": {
"description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.", "description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.",
"properties": { "properties": {
"digest": { "digest": {
"description": "Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored.", "description": "Digest is the value used to replace the original image tag.\nIf digest is present NewTag value is ignored.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -400,31 +435,31 @@
"type": "array" "type": "array"
}, },
"patches": { "patches": {
"description": "Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.", "description": "Strategic merge and JSON patches, defined as inline YAML objects,\ncapable of targeting objects based on kind, label and annotation selectors.",
"items": { "items": {
"description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should be applied to.", "description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should\nbe applied to.",
"properties": { "properties": {
"patch": { "patch": {
"description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects.", "description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with\nan array of operation objects.",
"type": "string" "type": "string"
}, },
"target": { "target": {
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -436,7 +471,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -460,14 +495,14 @@
"patch": { "patch": {
"description": "Patch contains the JSON6902 patch document with an array of operation objects.", "description": "Patch contains the JSON6902 patch document with an array of operation objects.",
"items": { "items": {
"description": "JSON6902 is a JSON6902 operation object. https://datatracker.ietf.org/doc/html/rfc6902#section-4", "description": "JSON6902 is a JSON6902 operation object.\nhttps://datatracker.ietf.org/doc/html/rfc6902#section-4",
"properties": { "properties": {
"from": { "from": {
"description": "From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.", "description": "From contains a JSON-pointer value that references a location within the target document where the operation is\nperformed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.",
"type": "string" "type": "string"
}, },
"op": { "op": {
"description": "Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4", "description": "Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or\n\"test\".\nhttps://datatracker.ietf.org/doc/html/rfc6902#section-4",
"enum": [ "enum": [
"test", "test",
"remove", "remove",
@ -479,11 +514,11 @@
"type": "string" "type": "string"
}, },
"path": { "path": {
"description": "Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op.", "description": "Path contains the JSON-pointer value that references a location within the target document where the operation\nis performed. The meaning of the value depends on the value of Op.",
"type": "string" "type": "string"
}, },
"value": { "value": {
"description": "Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.", "description": "Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into\naccount by all operations.",
"x-kubernetes-preserve-unknown-fields": true "x-kubernetes-preserve-unknown-fields": true
} }
}, },
@ -500,19 +535,19 @@
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -524,7 +559,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -559,7 +594,7 @@
"type": "array" "type": "array"
}, },
"releaseName": { "releaseName": {
"description": "ReleaseName used for the Helm release. Defaults to a composition of '[TargetNamespace-]Name'.", "description": "ReleaseName used for the Helm release. Defaults to a composition of\n'[TargetNamespace-]Name'.",
"maxLength": 53, "maxLength": 53,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -568,7 +603,7 @@
"description": "Rollback holds the configuration for Helm rollback actions for this HelmRelease.", "description": "Rollback holds the configuration for Helm rollback actions for this HelmRelease.",
"properties": { "properties": {
"cleanupOnFail": { "cleanupOnFail": {
"description": "CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails.", "description": "CleanupOnFail allows deletion of new resources created during the Helm\nrollback action when it fails.",
"type": "boolean" "type": "boolean"
}, },
"disableHooks": { "disableHooks": {
@ -576,11 +611,11 @@
"type": "boolean" "type": "boolean"
}, },
"disableWait": { "disableWait": {
"description": "DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed.", "description": "DisableWait disables the waiting for resources to be ready after a Helm\nrollback has been performed.",
"type": "boolean" "type": "boolean"
}, },
"disableWaitForJobs": { "disableWaitForJobs": {
"description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed.", "description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm\nrollback has been performed.",
"type": "boolean" "type": "boolean"
}, },
"force": { "force": {
@ -592,7 +627,7 @@
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm rollback action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like\nJobs for hooks) during the performance of a Helm rollback action. Defaults to\n'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -601,21 +636,21 @@
"additionalProperties": false "additionalProperties": false
}, },
"serviceAccountName": { "serviceAccountName": {
"description": "The name of the Kubernetes service account to impersonate when reconciling this HelmRelease.", "description": "The name of the Kubernetes service account to impersonate\nwhen reconciling this HelmRelease.",
"type": "string" "type": "string"
}, },
"storageNamespace": { "storageNamespace": {
"description": "StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease.", "description": "StorageNamespace used for the Helm storage.\nDefaults to the namespace of the HelmRelease.",
"maxLength": 63, "maxLength": 63,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false.", "description": "Suspend tells the controller to suspend reconciliation for this HelmRelease,\nit does not apply to already started reconciliations. Defaults to false.",
"type": "boolean" "type": "boolean"
}, },
"targetNamespace": { "targetNamespace": {
"description": "TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease.", "description": "TargetNamespace to target when performing operations for the HelmRelease.\nDefaults to the namespace of the HelmRelease.",
"maxLength": 63, "maxLength": 63,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -624,15 +659,15 @@
"description": "Test holds the configuration for Helm test actions for this HelmRelease.", "description": "Test holds the configuration for Helm test actions for this HelmRelease.",
"properties": { "properties": {
"enable": { "enable": {
"description": "Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed.", "description": "Enable enables Helm test actions for this HelmRelease after an Helm install\nor upgrade action has been performed.",
"type": "boolean" "type": "boolean"
}, },
"ignoreFailures": { "ignoreFailures": {
"description": "IgnoreFailures tells the controller to skip remediation when the Helm tests are run but fail. Can be overwritten for tests run after install or upgrade actions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'.", "description": "IgnoreFailures tells the controller to skip remediation when the Helm tests\nare run but fail. Can be overwritten for tests run after install or upgrade\nactions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation during\nthe performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -641,7 +676,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to '5m0s'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs\nfor hooks) during the performance of a Helm action. Defaults to '5m0s'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
@ -650,7 +685,7 @@
"properties": { "properties": {
"deletionPropagation": { "deletionPropagation": {
"default": "background", "default": "background",
"description": "DeletionPropagation specifies the deletion propagation policy when a Helm uninstall is performed.", "description": "DeletionPropagation specifies the deletion propagation policy when\na Helm uninstall is performed.",
"enum": [ "enum": [
"background", "background",
"foreground", "foreground",
@ -663,15 +698,15 @@
"type": "boolean" "type": "boolean"
}, },
"disableWait": { "disableWait": {
"description": "DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed.", "description": "DisableWait disables waiting for all the resources to be deleted after\na Helm uninstall is performed.",
"type": "boolean" "type": "boolean"
}, },
"keepHistory": { "keepHistory": {
"description": "KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history.", "description": "KeepHistory tells Helm to remove all associated resources and mark the\nrelease as deleted, but retain the release history.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm uninstall action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like\nJobs for hooks) during the performance of a Helm uninstall action. Defaults\nto 'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -683,11 +718,11 @@
"description": "Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.", "description": "Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.",
"properties": { "properties": {
"cleanupOnFail": { "cleanupOnFail": {
"description": "CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails.", "description": "CleanupOnFail allows deletion of new resources created during the Helm\nupgrade action when it fails.",
"type": "boolean" "type": "boolean"
}, },
"crds": { "crds": {
"description": "CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Skip` and if omitted CRDs are neither installed nor upgraded. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n By default, CRDs are not applied during Helm upgrade action. With this option users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.", "description": "CRDs upgrade CRDs from the Helm Chart's crds directory according\nto the CRD upgrade policy provided here. Valid values are `Skip`,\n`Create` or `CreateReplace`. Default is `Skip` and if omitted\nCRDs are neither installed nor upgraded.\n\n\nSkip: do neither install nor replace (update) any CRDs.\n\n\nCreate: new CRDs are created, existing CRDs are neither updated nor deleted.\n\n\nCreateReplace: new CRDs are created, existing CRDs are updated (replaced)\nbut not deleted.\n\n\nBy default, CRDs are not applied during Helm upgrade action. With this\noption users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm.\nhttps://helm.sh/docs/chart_best_practices/custom_resource_definitions.",
"enum": [ "enum": [
"Skip", "Skip",
"Create", "Create",
@ -700,15 +735,15 @@
"type": "boolean" "type": "boolean"
}, },
"disableOpenAPIValidation": { "disableOpenAPIValidation": {
"description": "DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema.", "description": "DisableOpenAPIValidation prevents the Helm upgrade action from validating\nrendered templates against the Kubernetes OpenAPI Schema.",
"type": "boolean" "type": "boolean"
}, },
"disableWait": { "disableWait": {
"description": "DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed.", "description": "DisableWait disables the waiting for resources to be ready after a Helm\nupgrade has been performed.",
"type": "boolean" "type": "boolean"
}, },
"disableWaitForJobs": { "disableWaitForJobs": {
"description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed.", "description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm\nupgrade has been performed.",
"type": "boolean" "type": "boolean"
}, },
"force": { "force": {
@ -716,22 +751,22 @@
"type": "boolean" "type": "boolean"
}, },
"preserveValues": { "preserveValues": {
"description": "PreserveValues will make Helm reuse the last release's values and merge in overrides from 'Values'. Setting this flag makes the HelmRelease non-declarative.", "description": "PreserveValues will make Helm reuse the last release's values and merge in\noverrides from 'Values'. Setting this flag makes the HelmRelease\nnon-declarative.",
"type": "boolean" "type": "boolean"
}, },
"remediation": { "remediation": {
"description": "Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action.", "description": "Remediation holds the remediation configuration for when the Helm upgrade\naction for the HelmRelease fails. The default is to not perform any action.",
"properties": { "properties": {
"ignoreTestFailures": { "ignoreTestFailures": {
"description": "IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to 'Test.IgnoreFailures'.", "description": "IgnoreTestFailures tells the controller to skip remediation when the Helm\ntests are run after an upgrade action but fail.\nDefaults to 'Test.IgnoreFailures'.",
"type": "boolean" "type": "boolean"
}, },
"remediateLastFailure": { "remediateLastFailure": {
"description": "RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false' unless 'Retries' is greater than 0.", "description": "RemediateLastFailure tells the controller to remediate the last failure, when\nno retries remain. Defaults to 'false' unless 'Retries' is greater than 0.",
"type": "boolean" "type": "boolean"
}, },
"retries": { "retries": {
"description": "Retries is the number of retries that should be attempted on failures before bailing. Remediation, using 'Strategy', is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries.", "description": "Retries is the number of retries that should be attempted on failures before\nbailing. Remediation, using 'Strategy', is performed between each attempt.\nDefaults to '0', a negative integer equals to unlimited retries.",
"type": "integer" "type": "integer"
}, },
"strategy": { "strategy": {
@ -747,7 +782,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm upgrade action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like\nJobs for hooks) during the performance of a Helm upgrade action. Defaults to\n'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -760,9 +795,9 @@
"x-kubernetes-preserve-unknown-fields": true "x-kubernetes-preserve-unknown-fields": true
}, },
"valuesFrom": { "valuesFrom": {
"description": "ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged.", "description": "ValuesFrom holds references to resources containing Helm values for this HelmRelease,\nand information about how they should be merged.",
"items": { "items": {
"description": "ValuesReference contains a reference to a resource containing Helm values, and optionally the key they can be found at.", "description": "ValuesReference contains a reference to a resource containing Helm values,\nand optionally the key they can be found at.",
"properties": { "properties": {
"kind": { "kind": {
"description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').", "description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').",
@ -773,23 +808,23 @@
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the values referent. Should reside in the same namespace as the referring resource.", "description": "Name of the values referent. Should reside in the same namespace as the\nreferring resource.",
"maxLength": 253, "maxLength": 253,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"optional": { "optional": {
"description": "Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure.", "description": "Optional marks this ValuesReference as optional. When set, a not found error\nfor the values reference is ignored, but any ValuesKey, TargetPath or\ntransient error will still result in a reconciliation failure.",
"type": "boolean" "type": "boolean"
}, },
"targetPath": { "targetPath": {
"description": "TargetPath is the YAML dot notation path the value should be merged at. When set, the ValuesKey is expected to be a single flat value. Defaults to 'None', which results in the values getting merged at the root.", "description": "TargetPath is the YAML dot notation path the value should be merged at. When\nset, the ValuesKey is expected to be a single flat value. Defaults to 'None',\nwhich results in the values getting merged at the root.",
"maxLength": 250, "maxLength": 250,
"pattern": "^([a-zA-Z0-9_\\-.\\\\\\/]|\\[[0-9]{1,5}\\])+$", "pattern": "^([a-zA-Z0-9_\\-.\\\\\\/]|\\[[0-9]{1,5}\\])+$",
"type": "string" "type": "string"
}, },
"valuesKey": { "valuesKey": {
"description": "ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to 'values.yaml'. When set, must be a valid Data Key, consisting of alphanumeric characters, '-', '_' or '.'.", "description": "ValuesKey is the data key where the values.yaml or a specific value can be\nfound at. Defaults to 'values.yaml'.\nWhen set, must be a valid Data Key, consisting of alphanumeric characters,\n'-', '_' or '.'.",
"maxLength": 253, "maxLength": 253,
"pattern": "^[\\-._a-zA-Z0-9]+$", "pattern": "^[\\-._a-zA-Z0-9]+$",
"type": "string" "type": "string"
@ -806,7 +841,6 @@
} }
}, },
"required": [ "required": [
"chart",
"interval" "interval"
], ],
"type": "object", "type": "object",
@ -821,26 +855,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the HelmRelease.", "description": "Conditions holds the conditions for the HelmRelease.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -856,7 +890,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -875,21 +909,25 @@
"type": "array" "type": "array"
}, },
"failures": { "failures": {
"description": "Failures is the reconciliation failure count against the latest desired state. It is reset after a successful reconciliation.", "description": "Failures is the reconciliation failure count against the latest desired\nstate. It is reset after a successful reconciliation.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"helmChart": { "helmChart": {
"description": "HelmChart is the namespaced name of the HelmChart resource created by the controller for the HelmRelease.", "description": "HelmChart is the namespaced name of the HelmChart resource created by\nthe controller for the HelmRelease.",
"type": "string" "type": "string"
}, },
"history": { "history": {
"description": "History holds the history of Helm releases performed for this HelmRelease up to the last successfully completed release. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases.", "description": "History holds the history of Helm releases performed for this HelmRelease\nup to the last successfully completed release.\n\n\nNote: this field is provisional to the v2beta2 API, and not actively used\nby v2beta1 HelmReleases.",
"items": { "items": {
"description": "Snapshot captures a point-in-time copy of the status information for a Helm release, as managed by the controller.", "description": "Snapshot captures a point-in-time copy of the status information for a Helm release,\nas managed by the controller.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "APIVersion is the API version of the Snapshot. Provisional: when the calculation method of the Digest field is changed, this field will be used to distinguish between the old and new methods.", "description": "APIVersion is the API version of the Snapshot.\nProvisional: when the calculation method of the Digest field is changed,\nthis field will be used to distinguish between the old and new methods.",
"type": "string"
},
"appVersion": {
"description": "AppVersion is the chart app version of the release object in storage.",
"type": "string" "type": "string"
}, },
"chartName": { "chartName": {
@ -897,11 +935,11 @@
"type": "string" "type": "string"
}, },
"chartVersion": { "chartVersion": {
"description": "ChartVersion is the chart version of the release object in storage.", "description": "ChartVersion is the chart version of the release object in\nstorage.",
"type": "string" "type": "string"
}, },
"configDigest": { "configDigest": {
"description": "ConfigDigest is the checksum of the config (better known as \"values\") of the release object in storage. It has the format of `<algo>:<checksum>`.", "description": "ConfigDigest is the checksum of the config (better known as\n\"values\") of the release object in storage.\nIt has the format of `<algo>:<checksum>`.",
"type": "string" "type": "string"
}, },
"deleted": { "deleted": {
@ -910,7 +948,7 @@
"type": "string" "type": "string"
}, },
"digest": { "digest": {
"description": "Digest is the checksum of the release object in storage. It has the format of `<algo>:<checksum>`.", "description": "Digest is the checksum of the release object in storage.\nIt has the format of `<algo>:<checksum>`.",
"type": "string" "type": "string"
}, },
"firstDeployed": { "firstDeployed": {
@ -931,13 +969,17 @@
"description": "Namespace is the namespace the release is deployed to.", "description": "Namespace is the namespace the release is deployed to.",
"type": "string" "type": "string"
}, },
"ociDigest": {
"description": "OCIDigest is the digest of the OCI artifact associated with the release.",
"type": "string"
},
"status": { "status": {
"description": "Status is the current state of the release.", "description": "Status is the current state of the release.",
"type": "string" "type": "string"
}, },
"testHooks": { "testHooks": {
"additionalProperties": { "additionalProperties": {
"description": "TestHookStatus holds the status information for a test hook as observed to be run by the controller.", "description": "TestHookStatus holds the status information for a test hook as observed\nto be run by the controller.",
"properties": { "properties": {
"lastCompleted": { "lastCompleted": {
"description": "LastCompleted is the time the test hook last completed.", "description": "LastCompleted is the time the test hook last completed.",
@ -957,7 +999,7 @@
"type": "object", "type": "object",
"additionalProperties": false "additionalProperties": false
}, },
"description": "TestHooks is the list of test hooks for the release as observed to be run by the controller.", "description": "TestHooks is the list of test hooks for the release as observed to be\nrun by the controller.",
"type": "object" "type": "object"
}, },
"version": { "version": {
@ -983,7 +1025,7 @@
"type": "array" "type": "array"
}, },
"installFailures": { "installFailures": {
"description": "InstallFailures is the install failure count against the latest desired state. It is reset after a successful reconciliation.", "description": "InstallFailures is the install failure count against the latest desired\nstate. It is reset after a successful reconciliation.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
@ -992,16 +1034,16 @@
"type": "string" "type": "string"
}, },
"lastAttemptedConfigDigest": { "lastAttemptedConfigDigest": {
"description": "LastAttemptedConfigDigest is the digest for the config (better known as \"values\") of the last reconciliation attempt. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases.", "description": "LastAttemptedConfigDigest is the digest for the config (better known as\n\"values\") of the last reconciliation attempt.\n\n\nNote: this field is provisional to the v2beta2 API, and not actively used\nby v2beta1 HelmReleases.",
"type": "string" "type": "string"
}, },
"lastAttemptedGeneration": { "lastAttemptedGeneration": {
"description": "LastAttemptedGeneration is the last generation the controller attempted to reconcile. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases.", "description": "LastAttemptedGeneration is the last generation the controller attempted\nto reconcile.\n\n\nNote: this field is provisional to the v2beta2 API, and not actively used\nby v2beta1 HelmReleases.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"lastAttemptedReleaseAction": { "lastAttemptedReleaseAction": {
"description": "LastAttemptedReleaseAction is the last release action performed for this HelmRelease. It is used to determine the active remediation strategy. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases.", "description": "LastAttemptedReleaseAction is the last release action performed for this\nHelmRelease. It is used to determine the active remediation strategy.\n\n\nNote: this field is provisional to the v2beta2 API, and not actively used\nby v2beta1 HelmReleases.",
"type": "string" "type": "string"
}, },
"lastAttemptedRevision": { "lastAttemptedRevision": {
@ -1009,19 +1051,19 @@
"type": "string" "type": "string"
}, },
"lastAttemptedValuesChecksum": { "lastAttemptedValuesChecksum": {
"description": "LastAttemptedValuesChecksum is the SHA1 checksum of the values of the last reconciliation attempt.", "description": "LastAttemptedValuesChecksum is the SHA1 checksum of the values of the last\nreconciliation attempt.",
"type": "string" "type": "string"
}, },
"lastHandledForceAt": { "lastHandledForceAt": {
"description": "LastHandledForceAt holds the value of the most recent force request value, so a change of the annotation value can be detected. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases.", "description": "LastHandledForceAt holds the value of the most recent force request\nvalue, so a change of the annotation value can be detected.\n\n\nNote: this field is provisional to the v2beta2 API, and not actively used\nby v2beta1 HelmReleases.",
"type": "string" "type": "string"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"lastHandledResetAt": { "lastHandledResetAt": {
"description": "LastHandledResetAt holds the value of the most recent reset request value, so a change of the annotation value can be detected. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases.", "description": "LastHandledResetAt holds the value of the most recent reset request\nvalue, so a change of the annotation value can be detected.\n\n\nNote: this field is provisional to the v2beta2 API, and not actively used\nby v2beta1 HelmReleases.",
"type": "string" "type": "string"
}, },
"lastReleaseRevision": { "lastReleaseRevision": {
@ -1033,12 +1075,16 @@
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"observedPostRenderersDigest": {
"description": "ObservedPostRenderersDigest is the digest for the post-renderers of\nthe last successful reconciliation attempt.",
"type": "string"
},
"storageNamespace": { "storageNamespace": {
"description": "StorageNamespace is the namespace of the Helm release storage for the current release. \n Note: this field is provisional to the v2beta2 API, and not actively used by v2beta1 HelmReleases.", "description": "StorageNamespace is the namespace of the Helm release storage for the\ncurrent release.\n\n\nNote: this field is provisional to the v2beta2 API, and not actively used\nby v2beta1 HelmReleases.",
"type": "string" "type": "string"
}, },
"upgradeFailures": { "upgradeFailures": {
"description": "UpgradeFailures is the upgrade failure count against the latest desired state. It is reset after a successful reconciliation.", "description": "UpgradeFailures is the upgrade failure count against the latest desired\nstate. It is reset after a successful reconciliation.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
} }

319
helm.toolkit.fluxcd.io/helmrelease_v2beta2.json
View File

@ -2,11 +2,11 @@
"description": "HelmRelease is the Schema for the helmreleases API", "description": "HelmRelease is the Schema for the helmreleases API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,7 +16,7 @@
"description": "HelmReleaseSpec defines the desired state of a Helm release.", "description": "HelmReleaseSpec defines the desired state of a Helm release.",
"properties": { "properties": {
"chart": { "chart": {
"description": "Chart defines the template of the v1beta2.HelmChart that should be created for this HelmRelease.", "description": "Chart defines the template of the v1beta2.HelmChart that should be created\nfor this HelmRelease.",
"properties": { "properties": {
"metadata": { "metadata": {
"description": "ObjectMeta holds the template for metadata like labels and annotations.", "description": "ObjectMeta holds the template for metadata like labels and annotations.",
@ -25,14 +25,14 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/",
"type": "object" "type": "object"
}, },
"labels": { "labels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "Map of string keys and values that can be used to organize and categorize (scope and select) objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/",
"type": "object" "type": "object"
} }
}, },
@ -48,14 +48,18 @@
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"ignoreMissingValuesFiles": {
"description": "IgnoreMissingValuesFiles controls whether to silently ignore missing values files rather than failing.",
"type": "boolean"
},
"interval": { "interval": {
"description": "Interval at which to check the v1.Source for updates. Defaults to 'HelmReleaseSpec.Interval'.", "description": "Interval at which to check the v1.Source for updates. Defaults to\n'HelmReleaseSpec.Interval'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"reconcileStrategy": { "reconcileStrategy": {
"default": "ChartVersion", "default": "ChartVersion",
"description": "Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.", "description": "Determines what enables the creation of a new artifact. Valid values are\n('ChartVersion', 'Revision').\nSee the documentation of the values for an explanation on their behavior.\nDefaults to ChartVersion when omitted.",
"enum": [ "enum": [
"ChartVersion", "ChartVersion",
"Revision" "Revision"
@ -98,29 +102,30 @@
"additionalProperties": false "additionalProperties": false
}, },
"valuesFile": { "valuesFile": {
"description": "Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted.", "description": "Alternative values file to use as the default chart values, expected to\nbe a relative path in the SourceRef. Deprecated in favor of ValuesFiles,\nfor backwards compatibility the file defined here is merged before the\nValuesFiles items. Ignored when omitted.",
"type": "string" "type": "string"
}, },
"valuesFiles": { "valuesFiles": {
"description": "Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted.", "description": "Alternative list of values files to use as the chart values (values.yaml\nis not included by default), expected to be a relative path in the SourceRef.\nValues files are merged in the order of this list with the last file overriding\nthe first. Ignored when omitted.",
"items": { "items": {
"type": "string" "type": "string"
}, },
"type": "array" "type": "array"
}, },
"verify": { "verify": {
"description": "Verify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic. This field is only supported for OCI sources. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified.", "description": "Verify contains the secret name containing the trusted public keys\nused to verify the signature and specifies which provider to use to check\nwhether OCI image is authentic.\nThis field is only supported for OCI sources.\nChart dependencies, which are not bundled in the umbrella chart artifact,\nare not verified.",
"properties": { "properties": {
"provider": { "provider": {
"default": "cosign", "default": "cosign",
"description": "Provider specifies the technology used to sign the OCI Helm chart.", "description": "Provider specifies the technology used to sign the OCI Helm chart.",
"enum": [ "enum": [
"cosign" "cosign",
"notation"
], ],
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Kubernetes Secret containing the trusted public keys.", "description": "SecretRef specifies the Kubernetes Secret containing the\ntrusted public keys.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -142,7 +147,7 @@
}, },
"version": { "version": {
"default": "*", "default": "*",
"description": "Version semver expression, ignored for charts from v1beta2.GitRepository and v1beta2.Bucket sources. Defaults to latest when omitted.", "description": "Version semver expression, ignored for charts from v1beta2.GitRepository and\nv1beta2.Bucket sources. Defaults to latest when omitted.",
"type": "string" "type": "string"
} }
}, },
@ -160,10 +165,45 @@
"type": "object", "type": "object",
"additionalProperties": false "additionalProperties": false
}, },
"chartRef": {
"description": "ChartRef holds a reference to a source controller resource containing the\nHelm chart artifact.\n\n\nNote: this field is provisional to the v2 API, and not actively used\nby v2beta2 HelmReleases.",
"properties": {
"apiVersion": {
"description": "APIVersion of the referent.",
"type": "string"
},
"kind": {
"description": "Kind of the referent.",
"enum": [
"OCIRepository",
"HelmChart"
],
"type": "string"
},
"name": {
"description": "Name of the referent.",
"maxLength": 253,
"minLength": 1,
"type": "string"
},
"namespace": {
"description": "Namespace of the referent, defaults to the namespace of the Kubernetes\nresource object that contains the reference.",
"maxLength": 63,
"minLength": 1,
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object",
"additionalProperties": false
},
"dependsOn": { "dependsOn": {
"description": "DependsOn may contain a meta.NamespacedObjectReference slice with references to HelmRelease resources that must be ready before this HelmRelease can be reconciled.", "description": "DependsOn may contain a meta.NamespacedObjectReference slice with\nreferences to HelmRelease resources that must be ready before this HelmRelease\ncan be reconciled.",
"items": { "items": {
"description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any namespace.", "description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any\nnamespace.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -183,37 +223,37 @@
"type": "array" "type": "array"
}, },
"driftDetection": { "driftDetection": {
"description": "DriftDetection holds the configuration for detecting and handling differences between the manifest in the Helm storage and the resources currently existing in the cluster.", "description": "DriftDetection holds the configuration for detecting and handling\ndifferences between the manifest in the Helm storage and the resources\ncurrently existing in the cluster.",
"properties": { "properties": {
"ignore": { "ignore": {
"description": "Ignore contains a list of rules for specifying which changes to ignore during diffing.", "description": "Ignore contains a list of rules for specifying which changes to ignore\nduring diffing.",
"items": { "items": {
"description": "IgnoreRule defines a rule to selectively disregard specific changes during the drift detection process.", "description": "IgnoreRule defines a rule to selectively disregard specific changes during\nthe drift detection process.",
"properties": { "properties": {
"paths": { "paths": {
"description": "Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from consideration in a Kubernetes object.", "description": "Paths is a list of JSON Pointer (RFC 6901) paths to be excluded from\nconsideration in a Kubernetes object.",
"items": { "items": {
"type": "string" "type": "string"
}, },
"type": "array" "type": "array"
}, },
"target": { "target": {
"description": "Target is a selector for specifying Kubernetes objects to which this rule applies. If Target is not set, the Paths will be ignored for all Kubernetes objects within the manifest of the Helm release.", "description": "Target is a selector for specifying Kubernetes objects to which this\nrule applies.\nIf Target is not set, the Paths will be ignored for all Kubernetes\nobjects within the manifest of the Helm release.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -225,7 +265,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -242,7 +282,7 @@
"type": "array" "type": "array"
}, },
"mode": { "mode": {
"description": "Mode defines how differences should be handled between the Helm manifest and the manifest currently applied to the cluster. If not explicitly set, it defaults to DiffModeDisabled.", "description": "Mode defines how differences should be handled between the Helm manifest\nand the manifest currently applied to the cluster.\nIf not explicitly set, it defaults to DiffModeDisabled.",
"enum": [ "enum": [
"enabled", "enabled",
"warn", "warn",
@ -258,7 +298,7 @@
"description": "Install holds the configuration for Helm install actions for this HelmRelease.", "description": "Install holds the configuration for Helm install actions for this HelmRelease.",
"properties": { "properties": {
"crds": { "crds": {
"description": "CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Create` and if omitted CRDs are installed but not updated. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n By default, CRDs are applied (installed) during Helm install action. With this option users can opt in to CRD replace existing CRDs on Helm install actions, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.", "description": "CRDs upgrade CRDs from the Helm Chart's crds directory according\nto the CRD upgrade policy provided here. Valid values are `Skip`,\n`Create` or `CreateReplace`. Default is `Create` and if omitted\nCRDs are installed but not updated.\n\n\nSkip: do neither install nor replace (update) any CRDs.\n\n\nCreate: new CRDs are created, existing CRDs are neither updated nor deleted.\n\n\nCreateReplace: new CRDs are created, existing CRDs are updated (replaced)\nbut not deleted.\n\n\nBy default, CRDs are applied (installed) during Helm install action.\nWith this option users can opt in to CRD replace existing CRDs on Helm\ninstall actions, which is not (yet) natively supported by Helm.\nhttps://helm.sh/docs/chart_best_practices/custom_resource_definitions.",
"enum": [ "enum": [
"Skip", "Skip",
"Create", "Create",
@ -267,7 +307,7 @@
"type": "string" "type": "string"
}, },
"createNamespace": { "createNamespace": {
"description": "CreateNamespace tells the Helm install action to create the HelmReleaseSpec.TargetNamespace if it does not exist yet. On uninstall, the namespace will not be garbage collected.", "description": "CreateNamespace tells the Helm install action to create the\nHelmReleaseSpec.TargetNamespace if it does not exist yet.\nOn uninstall, the namespace will not be garbage collected.",
"type": "boolean" "type": "boolean"
}, },
"disableHooks": { "disableHooks": {
@ -275,30 +315,30 @@
"type": "boolean" "type": "boolean"
}, },
"disableOpenAPIValidation": { "disableOpenAPIValidation": {
"description": "DisableOpenAPIValidation prevents the Helm install action from validating rendered templates against the Kubernetes OpenAPI Schema.", "description": "DisableOpenAPIValidation prevents the Helm install action from validating\nrendered templates against the Kubernetes OpenAPI Schema.",
"type": "boolean" "type": "boolean"
}, },
"disableWait": { "disableWait": {
"description": "DisableWait disables the waiting for resources to be ready after a Helm install has been performed.", "description": "DisableWait disables the waiting for resources to be ready after a Helm\ninstall has been performed.",
"type": "boolean" "type": "boolean"
}, },
"disableWaitForJobs": { "disableWaitForJobs": {
"description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm install has been performed.", "description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm\ninstall has been performed.",
"type": "boolean" "type": "boolean"
}, },
"remediation": { "remediation": {
"description": "Remediation holds the remediation configuration for when the Helm install action for the HelmRelease fails. The default is to not perform any action.", "description": "Remediation holds the remediation configuration for when the Helm install\naction for the HelmRelease fails. The default is to not perform any action.",
"properties": { "properties": {
"ignoreTestFailures": { "ignoreTestFailures": {
"description": "IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an install action but fail. Defaults to 'Test.IgnoreFailures'.", "description": "IgnoreTestFailures tells the controller to skip remediation when the Helm\ntests are run after an install action but fail. Defaults to\n'Test.IgnoreFailures'.",
"type": "boolean" "type": "boolean"
}, },
"remediateLastFailure": { "remediateLastFailure": {
"description": "RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false'.", "description": "RemediateLastFailure tells the controller to remediate the last failure, when\nno retries remain. Defaults to 'false'.",
"type": "boolean" "type": "boolean"
}, },
"retries": { "retries": {
"description": "Retries is the number of retries that should be attempted on failures before bailing. Remediation, using an uninstall, is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries.", "description": "Retries is the number of retries that should be attempted on failures before\nbailing. Remediation, using an uninstall, is performed between each attempt.\nDefaults to '0', a negative integer equals to unlimited retries.",
"type": "integer" "type": "integer"
} }
}, },
@ -306,15 +346,15 @@
"additionalProperties": false "additionalProperties": false
}, },
"replace": { "replace": {
"description": "Replace tells the Helm install action to re-use the 'ReleaseName', but only if that name is a deleted release which remains in the history.", "description": "Replace tells the Helm install action to re-use the 'ReleaseName', but only\nif that name is a deleted release which remains in the history.",
"type": "boolean" "type": "boolean"
}, },
"skipCRDs": { "skipCRDs": {
"description": "SkipCRDs tells the Helm install action to not install any CRDs. By default, CRDs are installed if not already present. \n Deprecated use CRD policy (`crds`) attribute with value `Skip` instead.", "description": "SkipCRDs tells the Helm install action to not install any CRDs. By default,\nCRDs are installed if not already present.\n\n\nDeprecated use CRD policy (`crds`) attribute with value `Skip` instead.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm install action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like\nJobs for hooks) during the performance of a Helm install action. Defaults to\n'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -328,10 +368,10 @@
"type": "string" "type": "string"
}, },
"kubeConfig": { "kubeConfig": {
"description": "KubeConfig for reconciling the HelmRelease on a remote cluster. When used in combination with HelmReleaseSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when HelmReleaseSpec.ServiceAccountName is empty.", "description": "KubeConfig for reconciling the HelmRelease on a remote cluster.\nWhen used in combination with HelmReleaseSpec.ServiceAccountName,\nforces the controller to act on behalf of that Service Account at the\ntarget cluster.\nIf the --default-service-account flag is set, its value will be used as\na controller level fallback for when HelmReleaseSpec.ServiceAccountName\nis empty.",
"properties": { "properties": {
"secretRef": { "secretRef": {
"description": "SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources.", "description": "SecretRef holds the name of a secret that contains a key with\nthe kubeconfig file as the value. If no key is set, the key will default\nto 'value'.\nIt is recommended that the kubeconfig is self-contained, and the secret\nis regularly updated if credentials such as a cloud-access-token expire.\nCloud specific `cmd-path` auth helpers will not function without adding\nbinaries and credentials to the Pod that is responsible for reconciling\nKubernetes resources.",
"properties": { "properties": {
"key": { "key": {
"description": "Key in the Secret, when not specified an implementation-specific default key is used.", "description": "Key in the Secret, when not specified an implementation-specific default key is used.",
@ -356,15 +396,15 @@
"additionalProperties": false "additionalProperties": false
}, },
"maxHistory": { "maxHistory": {
"description": "MaxHistory is the number of revisions saved by Helm for this HelmRelease. Use '0' for an unlimited number of revisions; defaults to '5'.", "description": "MaxHistory is the number of revisions saved by Helm for this HelmRelease.\nUse '0' for an unlimited number of revisions; defaults to '5'.",
"type": "integer" "type": "integer"
}, },
"persistentClient": { "persistentClient": {
"description": "PersistentClient tells the controller to use a persistent Kubernetes client for this release. When enabled, the client will be reused for the duration of the reconciliation, instead of being created and destroyed for each (step of a) Helm action. \n This can improve performance, but may cause issues with some Helm charts that for example do create Custom Resource Definitions during installation outside Helm's CRD lifecycle hooks, which are then not observed to be available by e.g. post-install hooks. \n If not set, it defaults to true.", "description": "PersistentClient tells the controller to use a persistent Kubernetes\nclient for this release. When enabled, the client will be reused for the\nduration of the reconciliation, instead of being created and destroyed\nfor each (step of a) Helm action.\n\n\nThis can improve performance, but may cause issues with some Helm charts\nthat for example do create Custom Resource Definitions during installation\noutside Helm's CRD lifecycle hooks, which are then not observed to be\navailable by e.g. post-install hooks.\n\n\nIf not set, it defaults to true.",
"type": "boolean" "type": "boolean"
}, },
"postRenderers": { "postRenderers": {
"description": "PostRenderers holds an array of Helm PostRenderers, which will be applied in order of their definition.", "description": "PostRenderers holds an array of Helm PostRenderers, which will be applied in order\nof their definition.",
"items": { "items": {
"description": "PostRenderer contains a Helm PostRenderer specification.", "description": "PostRenderer contains a Helm PostRenderer specification.",
"properties": { "properties": {
@ -372,12 +412,12 @@
"description": "Kustomization to apply as PostRenderer.", "description": "Kustomization to apply as PostRenderer.",
"properties": { "properties": {
"images": { "images": {
"description": "Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.", "description": "Images is a list of (image name, new name, new tag or digest)\nfor changing image names, tags or digests. This can also be achieved with a\npatch, but this operator is simpler to specify.",
"items": { "items": {
"description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.", "description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.",
"properties": { "properties": {
"digest": { "digest": {
"description": "Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored.", "description": "Digest is the value used to replace the original image tag.\nIf digest is present NewTag value is ignored.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -402,31 +442,31 @@
"type": "array" "type": "array"
}, },
"patches": { "patches": {
"description": "Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.", "description": "Strategic merge and JSON patches, defined as inline YAML objects,\ncapable of targeting objects based on kind, label and annotation selectors.",
"items": { "items": {
"description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should be applied to.", "description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should\nbe applied to.",
"properties": { "properties": {
"patch": { "patch": {
"description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects.", "description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with\nan array of operation objects.",
"type": "string" "type": "string"
}, },
"target": { "target": {
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -438,7 +478,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -455,21 +495,21 @@
"type": "array" "type": "array"
}, },
"patchesJson6902": { "patchesJson6902": {
"description": "JSON 6902 patches, defined as inline YAML objects. Deprecated: use Patches instead.", "description": "JSON 6902 patches, defined as inline YAML objects.\nDeprecated: use Patches instead.",
"items": { "items": {
"description": "JSON6902Patch contains a JSON6902 patch and the target the patch should be applied to.", "description": "JSON6902Patch contains a JSON6902 patch and the target the patch should be applied to.",
"properties": { "properties": {
"patch": { "patch": {
"description": "Patch contains the JSON6902 patch document with an array of operation objects.", "description": "Patch contains the JSON6902 patch document with an array of operation objects.",
"items": { "items": {
"description": "JSON6902 is a JSON6902 operation object. https://datatracker.ietf.org/doc/html/rfc6902#section-4", "description": "JSON6902 is a JSON6902 operation object.\nhttps://datatracker.ietf.org/doc/html/rfc6902#section-4",
"properties": { "properties": {
"from": { "from": {
"description": "From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.", "description": "From contains a JSON-pointer value that references a location within the target document where the operation is\nperformed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.",
"type": "string" "type": "string"
}, },
"op": { "op": {
"description": "Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4", "description": "Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or\n\"test\".\nhttps://datatracker.ietf.org/doc/html/rfc6902#section-4",
"enum": [ "enum": [
"test", "test",
"remove", "remove",
@ -481,11 +521,11 @@
"type": "string" "type": "string"
}, },
"path": { "path": {
"description": "Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op.", "description": "Path contains the JSON-pointer value that references a location within the target document where the operation\nis performed. The meaning of the value depends on the value of Op.",
"type": "string" "type": "string"
}, },
"value": { "value": {
"description": "Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.", "description": "Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into\naccount by all operations.",
"x-kubernetes-preserve-unknown-fields": true "x-kubernetes-preserve-unknown-fields": true
} }
}, },
@ -502,19 +542,19 @@
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -526,7 +566,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -544,7 +584,7 @@
"type": "array" "type": "array"
}, },
"patchesStrategicMerge": { "patchesStrategicMerge": {
"description": "Strategic merge patches, defined as inline YAML objects. Deprecated: use Patches instead.", "description": "Strategic merge patches, defined as inline YAML objects.\nDeprecated: use Patches instead.",
"items": { "items": {
"x-kubernetes-preserve-unknown-fields": true "x-kubernetes-preserve-unknown-fields": true
}, },
@ -561,7 +601,7 @@
"type": "array" "type": "array"
}, },
"releaseName": { "releaseName": {
"description": "ReleaseName used for the Helm release. Defaults to a composition of '[TargetNamespace-]Name'.", "description": "ReleaseName used for the Helm release. Defaults to a composition of\n'[TargetNamespace-]Name'.",
"maxLength": 53, "maxLength": 53,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -570,7 +610,7 @@
"description": "Rollback holds the configuration for Helm rollback actions for this HelmRelease.", "description": "Rollback holds the configuration for Helm rollback actions for this HelmRelease.",
"properties": { "properties": {
"cleanupOnFail": { "cleanupOnFail": {
"description": "CleanupOnFail allows deletion of new resources created during the Helm rollback action when it fails.", "description": "CleanupOnFail allows deletion of new resources created during the Helm\nrollback action when it fails.",
"type": "boolean" "type": "boolean"
}, },
"disableHooks": { "disableHooks": {
@ -578,11 +618,11 @@
"type": "boolean" "type": "boolean"
}, },
"disableWait": { "disableWait": {
"description": "DisableWait disables the waiting for resources to be ready after a Helm rollback has been performed.", "description": "DisableWait disables the waiting for resources to be ready after a Helm\nrollback has been performed.",
"type": "boolean" "type": "boolean"
}, },
"disableWaitForJobs": { "disableWaitForJobs": {
"description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm rollback has been performed.", "description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm\nrollback has been performed.",
"type": "boolean" "type": "boolean"
}, },
"force": { "force": {
@ -594,7 +634,7 @@
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm rollback action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like\nJobs for hooks) during the performance of a Helm rollback action. Defaults to\n'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -603,23 +643,23 @@
"additionalProperties": false "additionalProperties": false
}, },
"serviceAccountName": { "serviceAccountName": {
"description": "The name of the Kubernetes service account to impersonate when reconciling this HelmRelease.", "description": "The name of the Kubernetes service account to impersonate\nwhen reconciling this HelmRelease.",
"maxLength": 253, "maxLength": 253,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"storageNamespace": { "storageNamespace": {
"description": "StorageNamespace used for the Helm storage. Defaults to the namespace of the HelmRelease.", "description": "StorageNamespace used for the Helm storage.\nDefaults to the namespace of the HelmRelease.",
"maxLength": 63, "maxLength": 63,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend reconciliation for this HelmRelease, it does not apply to already started reconciliations. Defaults to false.", "description": "Suspend tells the controller to suspend reconciliation for this HelmRelease,\nit does not apply to already started reconciliations. Defaults to false.",
"type": "boolean" "type": "boolean"
}, },
"targetNamespace": { "targetNamespace": {
"description": "TargetNamespace to target when performing operations for the HelmRelease. Defaults to the namespace of the HelmRelease.", "description": "TargetNamespace to target when performing operations for the HelmRelease.\nDefaults to the namespace of the HelmRelease.",
"maxLength": 63, "maxLength": 63,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -628,7 +668,7 @@
"description": "Test holds the configuration for Helm test actions for this HelmRelease.", "description": "Test holds the configuration for Helm test actions for this HelmRelease.",
"properties": { "properties": {
"enable": { "enable": {
"description": "Enable enables Helm test actions for this HelmRelease after an Helm install or upgrade action has been performed.", "description": "Enable enables Helm test actions for this HelmRelease after an Helm install\nor upgrade action has been performed.",
"type": "boolean" "type": "boolean"
}, },
"filters": { "filters": {
@ -656,11 +696,11 @@
"type": "array" "type": "array"
}, },
"ignoreFailures": { "ignoreFailures": {
"description": "IgnoreFailures tells the controller to skip remediation when the Helm tests are run but fail. Can be overwritten for tests run after install or upgrade actions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'.", "description": "IgnoreFailures tells the controller to skip remediation when the Helm tests\nare run but fail. Can be overwritten for tests run after install or upgrade\nactions in 'Install.IgnoreTestFailures' and 'Upgrade.IgnoreTestFailures'.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation during the performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation during\nthe performance of a Helm test action. Defaults to 'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -669,7 +709,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to '5m0s'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs\nfor hooks) during the performance of a Helm action. Defaults to '5m0s'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
@ -678,7 +718,7 @@
"properties": { "properties": {
"deletionPropagation": { "deletionPropagation": {
"default": "background", "default": "background",
"description": "DeletionPropagation specifies the deletion propagation policy when a Helm uninstall is performed.", "description": "DeletionPropagation specifies the deletion propagation policy when\na Helm uninstall is performed.",
"enum": [ "enum": [
"background", "background",
"foreground", "foreground",
@ -691,15 +731,15 @@
"type": "boolean" "type": "boolean"
}, },
"disableWait": { "disableWait": {
"description": "DisableWait disables waiting for all the resources to be deleted after a Helm uninstall is performed.", "description": "DisableWait disables waiting for all the resources to be deleted after\na Helm uninstall is performed.",
"type": "boolean" "type": "boolean"
}, },
"keepHistory": { "keepHistory": {
"description": "KeepHistory tells Helm to remove all associated resources and mark the release as deleted, but retain the release history.", "description": "KeepHistory tells Helm to remove all associated resources and mark the\nrelease as deleted, but retain the release history.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm uninstall action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like\nJobs for hooks) during the performance of a Helm uninstall action. Defaults\nto 'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -711,11 +751,11 @@
"description": "Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.", "description": "Upgrade holds the configuration for Helm upgrade actions for this HelmRelease.",
"properties": { "properties": {
"cleanupOnFail": { "cleanupOnFail": {
"description": "CleanupOnFail allows deletion of new resources created during the Helm upgrade action when it fails.", "description": "CleanupOnFail allows deletion of new resources created during the Helm\nupgrade action when it fails.",
"type": "boolean" "type": "boolean"
}, },
"crds": { "crds": {
"description": "CRDs upgrade CRDs from the Helm Chart's crds directory according to the CRD upgrade policy provided here. Valid values are `Skip`, `Create` or `CreateReplace`. Default is `Skip` and if omitted CRDs are neither installed nor upgraded. \n Skip: do neither install nor replace (update) any CRDs. \n Create: new CRDs are created, existing CRDs are neither updated nor deleted. \n CreateReplace: new CRDs are created, existing CRDs are updated (replaced) but not deleted. \n By default, CRDs are not applied during Helm upgrade action. With this option users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm. https://helm.sh/docs/chart_best_practices/custom_resource_definitions.", "description": "CRDs upgrade CRDs from the Helm Chart's crds directory according\nto the CRD upgrade policy provided here. Valid values are `Skip`,\n`Create` or `CreateReplace`. Default is `Skip` and if omitted\nCRDs are neither installed nor upgraded.\n\n\nSkip: do neither install nor replace (update) any CRDs.\n\n\nCreate: new CRDs are created, existing CRDs are neither updated nor deleted.\n\n\nCreateReplace: new CRDs are created, existing CRDs are updated (replaced)\nbut not deleted.\n\n\nBy default, CRDs are not applied during Helm upgrade action. With this\noption users can opt-in to CRD upgrade, which is not (yet) natively supported by Helm.\nhttps://helm.sh/docs/chart_best_practices/custom_resource_definitions.",
"enum": [ "enum": [
"Skip", "Skip",
"Create", "Create",
@ -728,15 +768,15 @@
"type": "boolean" "type": "boolean"
}, },
"disableOpenAPIValidation": { "disableOpenAPIValidation": {
"description": "DisableOpenAPIValidation prevents the Helm upgrade action from validating rendered templates against the Kubernetes OpenAPI Schema.", "description": "DisableOpenAPIValidation prevents the Helm upgrade action from validating\nrendered templates against the Kubernetes OpenAPI Schema.",
"type": "boolean" "type": "boolean"
}, },
"disableWait": { "disableWait": {
"description": "DisableWait disables the waiting for resources to be ready after a Helm upgrade has been performed.", "description": "DisableWait disables the waiting for resources to be ready after a Helm\nupgrade has been performed.",
"type": "boolean" "type": "boolean"
}, },
"disableWaitForJobs": { "disableWaitForJobs": {
"description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm upgrade has been performed.", "description": "DisableWaitForJobs disables waiting for jobs to complete after a Helm\nupgrade has been performed.",
"type": "boolean" "type": "boolean"
}, },
"force": { "force": {
@ -744,22 +784,22 @@
"type": "boolean" "type": "boolean"
}, },
"preserveValues": { "preserveValues": {
"description": "PreserveValues will make Helm reuse the last release's values and merge in overrides from 'Values'. Setting this flag makes the HelmRelease non-declarative.", "description": "PreserveValues will make Helm reuse the last release's values and merge in\noverrides from 'Values'. Setting this flag makes the HelmRelease\nnon-declarative.",
"type": "boolean" "type": "boolean"
}, },
"remediation": { "remediation": {
"description": "Remediation holds the remediation configuration for when the Helm upgrade action for the HelmRelease fails. The default is to not perform any action.", "description": "Remediation holds the remediation configuration for when the Helm upgrade\naction for the HelmRelease fails. The default is to not perform any action.",
"properties": { "properties": {
"ignoreTestFailures": { "ignoreTestFailures": {
"description": "IgnoreTestFailures tells the controller to skip remediation when the Helm tests are run after an upgrade action but fail. Defaults to 'Test.IgnoreFailures'.", "description": "IgnoreTestFailures tells the controller to skip remediation when the Helm\ntests are run after an upgrade action but fail.\nDefaults to 'Test.IgnoreFailures'.",
"type": "boolean" "type": "boolean"
}, },
"remediateLastFailure": { "remediateLastFailure": {
"description": "RemediateLastFailure tells the controller to remediate the last failure, when no retries remain. Defaults to 'false' unless 'Retries' is greater than 0.", "description": "RemediateLastFailure tells the controller to remediate the last failure, when\nno retries remain. Defaults to 'false' unless 'Retries' is greater than 0.",
"type": "boolean" "type": "boolean"
}, },
"retries": { "retries": {
"description": "Retries is the number of retries that should be attempted on failures before bailing. Remediation, using 'Strategy', is performed between each attempt. Defaults to '0', a negative integer equals to unlimited retries.", "description": "Retries is the number of retries that should be attempted on failures before\nbailing. Remediation, using 'Strategy', is performed between each attempt.\nDefaults to '0', a negative integer equals to unlimited retries.",
"type": "integer" "type": "integer"
}, },
"strategy": { "strategy": {
@ -775,7 +815,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"timeout": { "timeout": {
"description": "Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm upgrade action. Defaults to 'HelmReleaseSpec.Timeout'.", "description": "Timeout is the time to wait for any individual Kubernetes operation (like\nJobs for hooks) during the performance of a Helm upgrade action. Defaults to\n'HelmReleaseSpec.Timeout'.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
} }
@ -788,9 +828,9 @@
"x-kubernetes-preserve-unknown-fields": true "x-kubernetes-preserve-unknown-fields": true
}, },
"valuesFrom": { "valuesFrom": {
"description": "ValuesFrom holds references to resources containing Helm values for this HelmRelease, and information about how they should be merged.", "description": "ValuesFrom holds references to resources containing Helm values for this HelmRelease,\nand information about how they should be merged.",
"items": { "items": {
"description": "ValuesReference contains a reference to a resource containing Helm values, and optionally the key they can be found at.", "description": "ValuesReference contains a reference to a resource containing Helm values,\nand optionally the key they can be found at.",
"properties": { "properties": {
"kind": { "kind": {
"description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').", "description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').",
@ -801,23 +841,23 @@
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the values referent. Should reside in the same namespace as the referring resource.", "description": "Name of the values referent. Should reside in the same namespace as the\nreferring resource.",
"maxLength": 253, "maxLength": 253,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"optional": { "optional": {
"description": "Optional marks this ValuesReference as optional. When set, a not found error for the values reference is ignored, but any ValuesKey, TargetPath or transient error will still result in a reconciliation failure.", "description": "Optional marks this ValuesReference as optional. When set, a not found error\nfor the values reference is ignored, but any ValuesKey, TargetPath or\ntransient error will still result in a reconciliation failure.",
"type": "boolean" "type": "boolean"
}, },
"targetPath": { "targetPath": {
"description": "TargetPath is the YAML dot notation path the value should be merged at. When set, the ValuesKey is expected to be a single flat value. Defaults to 'None', which results in the values getting merged at the root.", "description": "TargetPath is the YAML dot notation path the value should be merged at. When\nset, the ValuesKey is expected to be a single flat value. Defaults to 'None',\nwhich results in the values getting merged at the root.",
"maxLength": 250, "maxLength": 250,
"pattern": "^([a-zA-Z0-9_\\-.\\\\\\/]|\\[[0-9]{1,5}\\])+$", "pattern": "^([a-zA-Z0-9_\\-.\\\\\\/]|\\[[0-9]{1,5}\\])+$",
"type": "string" "type": "string"
}, },
"valuesKey": { "valuesKey": {
"description": "ValuesKey is the data key where the values.yaml or a specific value can be found at. Defaults to 'values.yaml'.", "description": "ValuesKey is the data key where the values.yaml or a specific value can be\nfound at. Defaults to 'values.yaml'.",
"maxLength": 253, "maxLength": 253,
"pattern": "^[\\-._a-zA-Z0-9]+$", "pattern": "^[\\-._a-zA-Z0-9]+$",
"type": "string" "type": "string"
@ -834,10 +874,15 @@
} }
}, },
"required": [ "required": [
"chart",
"interval" "interval"
], ],
"type": "object", "type": "object",
"x-kubernetes-validations": [
{
"message": "either chart or chartRef must be set",
"rule": "(has(self.chart) && !has(self.chartRef)) || (!has(self.chart) && has(self.chartRef))"
}
],
"additionalProperties": false "additionalProperties": false
}, },
"status": { "status": {
@ -849,26 +894,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the HelmRelease.", "description": "Conditions holds the conditions for the HelmRelease.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -884,7 +929,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -903,21 +948,25 @@
"type": "array" "type": "array"
}, },
"failures": { "failures": {
"description": "Failures is the reconciliation failure count against the latest desired state. It is reset after a successful reconciliation.", "description": "Failures is the reconciliation failure count against the latest desired\nstate. It is reset after a successful reconciliation.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"helmChart": { "helmChart": {
"description": "HelmChart is the namespaced name of the HelmChart resource created by the controller for the HelmRelease.", "description": "HelmChart is the namespaced name of the HelmChart resource created by\nthe controller for the HelmRelease.",
"type": "string" "type": "string"
}, },
"history": { "history": {
"description": "History holds the history of Helm releases performed for this HelmRelease up to the last successfully completed release.", "description": "History holds the history of Helm releases performed for this HelmRelease\nup to the last successfully completed release.",
"items": { "items": {
"description": "Snapshot captures a point-in-time copy of the status information for a Helm release, as managed by the controller.", "description": "Snapshot captures a point-in-time copy of the status information for a Helm release,\nas managed by the controller.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "APIVersion is the API version of the Snapshot. Provisional: when the calculation method of the Digest field is changed, this field will be used to distinguish between the old and new methods.", "description": "APIVersion is the API version of the Snapshot.\nProvisional: when the calculation method of the Digest field is changed,\nthis field will be used to distinguish between the old and new methods.",
"type": "string"
},
"appVersion": {
"description": "AppVersion is the chart app version of the release object in storage.",
"type": "string" "type": "string"
}, },
"chartName": { "chartName": {
@ -925,11 +974,11 @@
"type": "string" "type": "string"
}, },
"chartVersion": { "chartVersion": {
"description": "ChartVersion is the chart version of the release object in storage.", "description": "ChartVersion is the chart version of the release object in\nstorage.",
"type": "string" "type": "string"
}, },
"configDigest": { "configDigest": {
"description": "ConfigDigest is the checksum of the config (better known as \"values\") of the release object in storage. It has the format of `<algo>:<checksum>`.", "description": "ConfigDigest is the checksum of the config (better known as\n\"values\") of the release object in storage.\nIt has the format of `<algo>:<checksum>`.",
"type": "string" "type": "string"
}, },
"deleted": { "deleted": {
@ -938,7 +987,7 @@
"type": "string" "type": "string"
}, },
"digest": { "digest": {
"description": "Digest is the checksum of the release object in storage. It has the format of `<algo>:<checksum>`.", "description": "Digest is the checksum of the release object in storage.\nIt has the format of `<algo>:<checksum>`.",
"type": "string" "type": "string"
}, },
"firstDeployed": { "firstDeployed": {
@ -959,13 +1008,17 @@
"description": "Namespace is the namespace the release is deployed to.", "description": "Namespace is the namespace the release is deployed to.",
"type": "string" "type": "string"
}, },
"ociDigest": {
"description": "OCIDigest is the digest of the OCI artifact associated with the release.",
"type": "string"
},
"status": { "status": {
"description": "Status is the current state of the release.", "description": "Status is the current state of the release.",
"type": "string" "type": "string"
}, },
"testHooks": { "testHooks": {
"additionalProperties": { "additionalProperties": {
"description": "TestHookStatus holds the status information for a test hook as observed to be run by the controller.", "description": "TestHookStatus holds the status information for a test hook as observed\nto be run by the controller.",
"properties": { "properties": {
"lastCompleted": { "lastCompleted": {
"description": "LastCompleted is the time the test hook last completed.", "description": "LastCompleted is the time the test hook last completed.",
@ -985,7 +1038,7 @@
"type": "object", "type": "object",
"additionalProperties": false "additionalProperties": false
}, },
"description": "TestHooks is the list of test hooks for the release as observed to be run by the controller.", "description": "TestHooks is the list of test hooks for the release as observed to be\nrun by the controller.",
"type": "object" "type": "object"
}, },
"version": { "version": {
@ -1011,25 +1064,25 @@
"type": "array" "type": "array"
}, },
"installFailures": { "installFailures": {
"description": "InstallFailures is the install failure count against the latest desired state. It is reset after a successful reconciliation.", "description": "InstallFailures is the install failure count against the latest desired\nstate. It is reset after a successful reconciliation.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"lastAppliedRevision": { "lastAppliedRevision": {
"description": "LastAppliedRevision is the revision of the last successfully applied source. Deprecated: the revision can now be found in the History.", "description": "LastAppliedRevision is the revision of the last successfully applied\nsource.\nDeprecated: the revision can now be found in the History.",
"type": "string" "type": "string"
}, },
"lastAttemptedConfigDigest": { "lastAttemptedConfigDigest": {
"description": "LastAttemptedConfigDigest is the digest for the config (better known as \"values\") of the last reconciliation attempt.", "description": "LastAttemptedConfigDigest is the digest for the config (better known as\n\"values\") of the last reconciliation attempt.",
"type": "string" "type": "string"
}, },
"lastAttemptedGeneration": { "lastAttemptedGeneration": {
"description": "LastAttemptedGeneration is the last generation the controller attempted to reconcile.", "description": "LastAttemptedGeneration is the last generation the controller attempted\nto reconcile.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"lastAttemptedReleaseAction": { "lastAttemptedReleaseAction": {
"description": "LastAttemptedReleaseAction is the last release action performed for this HelmRelease. It is used to determine the active remediation strategy.", "description": "LastAttemptedReleaseAction is the last release action performed for this\nHelmRelease. It is used to determine the active remediation strategy.",
"enum": [ "enum": [
"install", "install",
"upgrade" "upgrade"
@ -1037,27 +1090,31 @@
"type": "string" "type": "string"
}, },
"lastAttemptedRevision": { "lastAttemptedRevision": {
"description": "LastAttemptedRevision is the Source revision of the last reconciliation attempt.", "description": "LastAttemptedRevision is the Source revision of the last reconciliation\nattempt. For OCIRepository sources, the 12 first characters of the digest are\nappended to the chart version e.g. \"1.2.3+1234567890ab\".",
"type": "string"
},
"lastAttemptedRevisionDigest": {
"description": "LastAttemptedRevisionDigest is the digest of the last reconciliation attempt.\nThis is only set for OCIRepository sources.",
"type": "string" "type": "string"
}, },
"lastAttemptedValuesChecksum": { "lastAttemptedValuesChecksum": {
"description": "LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last reconciliation attempt. Deprecated: Use LastAttemptedConfigDigest instead.", "description": "LastAttemptedValuesChecksum is the SHA1 checksum for the values of the last\nreconciliation attempt.\nDeprecated: Use LastAttemptedConfigDigest instead.",
"type": "string" "type": "string"
}, },
"lastHandledForceAt": { "lastHandledForceAt": {
"description": "LastHandledForceAt holds the value of the most recent force request value, so a change of the annotation value can be detected.", "description": "LastHandledForceAt holds the value of the most recent force request\nvalue, so a change of the annotation value can be detected.",
"type": "string" "type": "string"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"lastHandledResetAt": { "lastHandledResetAt": {
"description": "LastHandledResetAt holds the value of the most recent reset request value, so a change of the annotation value can be detected.", "description": "LastHandledResetAt holds the value of the most recent reset request\nvalue, so a change of the annotation value can be detected.",
"type": "string" "type": "string"
}, },
"lastReleaseRevision": { "lastReleaseRevision": {
"description": "LastReleaseRevision is the revision of the last successful Helm release. Deprecated: Use History instead.", "description": "LastReleaseRevision is the revision of the last successful Helm release.\nDeprecated: Use History instead.",
"type": "integer" "type": "integer"
}, },
"observedGeneration": { "observedGeneration": {
@ -1065,14 +1122,18 @@
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"observedPostRenderersDigest": {
"description": "ObservedPostRenderersDigest is the digest for the post-renderers of\nthe last successful reconciliation attempt.",
"type": "string"
},
"storageNamespace": { "storageNamespace": {
"description": "StorageNamespace is the namespace of the Helm release storage for the current release.", "description": "StorageNamespace is the namespace of the Helm release storage for the\ncurrent release.",
"maxLength": 63, "maxLength": 63,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"upgradeFailures": { "upgradeFailures": {
"description": "UpgradeFailures is the upgrade failure count against the latest desired state. It is reset after a successful reconciliation.", "description": "UpgradeFailures is the upgrade failure count against the latest desired\nstate. It is reset after a successful reconciliation.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
} }

3
image.toolkit.fluxcd.io/all-anyOf.json
View File

@ -14,6 +14,9 @@
}, },
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/image.toolkit.fluxcd.io/imageupdateautomation_v1beta1.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/image.toolkit.fluxcd.io/imageupdateautomation_v1beta1.json"
},
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/image.toolkit.fluxcd.io/imageupdateautomation_v1beta2.json"
} }
] ]
} }

3
image.toolkit.fluxcd.io/all-oneOf.json
View File

@ -14,6 +14,9 @@
}, },
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/image.toolkit.fluxcd.io/imageupdateautomation_v1beta1.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/image.toolkit.fluxcd.io/imageupdateautomation_v1beta1.json"
},
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/image.toolkit.fluxcd.io/imageupdateautomation_v1beta2.json"
} }
] ]
} }

38
image.toolkit.fluxcd.io/imagepolicy_v1beta1.json
View File

@ -2,28 +2,28 @@
"description": "ImagePolicy is the Schema for the imagepolicies API", "description": "ImagePolicy is the Schema for the imagepolicies API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "ImagePolicySpec defines the parameters for calculating the ImagePolicy", "description": "ImagePolicySpec defines the parameters for calculating the\nImagePolicy",
"properties": { "properties": {
"filterTags": { "filterTags": {
"description": "FilterTags enables filtering for only a subset of tags based on a set of rules. If no rules are provided, all the tags from the repository will be ordered and compared.", "description": "FilterTags enables filtering for only a subset of tags based on a set of\nrules. If no rules are provided, all the tags from the repository will be\nordered and compared.",
"properties": { "properties": {
"extract": { "extract": {
"description": "Extract allows a capture group to be extracted from the specified regular expression pattern, useful before tag evaluation.", "description": "Extract allows a capture group to be extracted from the specified regular\nexpression pattern, useful before tag evaluation.",
"type": "string" "type": "string"
}, },
"pattern": { "pattern": {
"description": "Pattern specifies a regular expression pattern used to filter for image tags.", "description": "Pattern specifies a regular expression pattern used to filter for image\ntags.",
"type": "string" "type": "string"
} }
}, },
@ -31,7 +31,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"imageRepositoryRef": { "imageRepositoryRef": {
"description": "ImageRepositoryRef points at the object specifying the image being scanned", "description": "ImageRepositoryRef points at the object specifying the image\nbeing scanned",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -49,14 +49,14 @@
"additionalProperties": false "additionalProperties": false
}, },
"policy": { "policy": {
"description": "Policy gives the particulars of the policy to be followed in selecting the most recent image", "description": "Policy gives the particulars of the policy to be followed in\nselecting the most recent image",
"properties": { "properties": {
"alphabetical": { "alphabetical": {
"description": "Alphabetical set of rules to use for alphabetical ordering of the tags.", "description": "Alphabetical set of rules to use for alphabetical ordering of the tags.",
"properties": { "properties": {
"order": { "order": {
"default": "asc", "default": "asc",
"description": "Order specifies the sorting order of the tags. Given the letters of the alphabet as tags, ascending order would select Z, and descending order would select A.", "description": "Order specifies the sorting order of the tags. Given the letters of the\nalphabet as tags, ascending order would select Z, and descending order\nwould select A.",
"enum": [ "enum": [
"asc", "asc",
"desc" "desc"
@ -72,7 +72,7 @@
"properties": { "properties": {
"order": { "order": {
"default": "asc", "default": "asc",
"description": "Order specifies the sorting order of the tags. Given the integer values from 0 to 9 as tags, ascending order would select 9, and descending order would select 0.", "description": "Order specifies the sorting order of the tags. Given the integer values\nfrom 0 to 9 as tags, ascending order would select 9, and descending order\nwould select 0.",
"enum": [ "enum": [
"asc", "asc",
"desc" "desc"
@ -84,10 +84,10 @@
"additionalProperties": false "additionalProperties": false
}, },
"semver": { "semver": {
"description": "SemVer gives a semantic version range to check against the tags available.", "description": "SemVer gives a semantic version range to check against the tags\navailable.",
"properties": { "properties": {
"range": { "range": {
"description": "Range gives a semver range for the image tag; the highest version within the range that's a tag yields the latest image.", "description": "Range gives a semver range for the image tag; the highest\nversion within the range that's a tag yields the latest image.",
"type": "string" "type": "string"
} }
}, },
@ -117,26 +117,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -152,7 +152,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -171,7 +171,7 @@
"type": "array" "type": "array"
}, },
"latestImage": { "latestImage": {
"description": "LatestImage gives the first in the list of images scanned by the image repository, when filtered and ordered according to the policy.", "description": "LatestImage gives the first in the list of images scanned by\nthe image repository, when filtered and ordered according to\nthe policy.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {

40
image.toolkit.fluxcd.io/imagepolicy_v1beta2.json
View File

@ -2,28 +2,28 @@
"description": "ImagePolicy is the Schema for the imagepolicies API", "description": "ImagePolicy is the Schema for the imagepolicies API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "ImagePolicySpec defines the parameters for calculating the ImagePolicy.", "description": "ImagePolicySpec defines the parameters for calculating the\nImagePolicy.",
"properties": { "properties": {
"filterTags": { "filterTags": {
"description": "FilterTags enables filtering for only a subset of tags based on a set of rules. If no rules are provided, all the tags from the repository will be ordered and compared.", "description": "FilterTags enables filtering for only a subset of tags based on a set of\nrules. If no rules are provided, all the tags from the repository will be\nordered and compared.",
"properties": { "properties": {
"extract": { "extract": {
"description": "Extract allows a capture group to be extracted from the specified regular expression pattern, useful before tag evaluation.", "description": "Extract allows a capture group to be extracted from the specified regular\nexpression pattern, useful before tag evaluation.",
"type": "string" "type": "string"
}, },
"pattern": { "pattern": {
"description": "Pattern specifies a regular expression pattern used to filter for image tags.", "description": "Pattern specifies a regular expression pattern used to filter for image\ntags.",
"type": "string" "type": "string"
} }
}, },
@ -31,7 +31,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"imageRepositoryRef": { "imageRepositoryRef": {
"description": "ImageRepositoryRef points at the object specifying the image being scanned", "description": "ImageRepositoryRef points at the object specifying the image\nbeing scanned",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -49,14 +49,14 @@
"additionalProperties": false "additionalProperties": false
}, },
"policy": { "policy": {
"description": "Policy gives the particulars of the policy to be followed in selecting the most recent image", "description": "Policy gives the particulars of the policy to be followed in\nselecting the most recent image",
"properties": { "properties": {
"alphabetical": { "alphabetical": {
"description": "Alphabetical set of rules to use for alphabetical ordering of the tags.", "description": "Alphabetical set of rules to use for alphabetical ordering of the tags.",
"properties": { "properties": {
"order": { "order": {
"default": "asc", "default": "asc",
"description": "Order specifies the sorting order of the tags. Given the letters of the alphabet as tags, ascending order would select Z, and descending order would select A.", "description": "Order specifies the sorting order of the tags. Given the letters of the\nalphabet as tags, ascending order would select Z, and descending order\nwould select A.",
"enum": [ "enum": [
"asc", "asc",
"desc" "desc"
@ -72,7 +72,7 @@
"properties": { "properties": {
"order": { "order": {
"default": "asc", "default": "asc",
"description": "Order specifies the sorting order of the tags. Given the integer values from 0 to 9 as tags, ascending order would select 9, and descending order would select 0.", "description": "Order specifies the sorting order of the tags. Given the integer values\nfrom 0 to 9 as tags, ascending order would select 9, and descending order\nwould select 0.",
"enum": [ "enum": [
"asc", "asc",
"desc" "desc"
@ -84,10 +84,10 @@
"additionalProperties": false "additionalProperties": false
}, },
"semver": { "semver": {
"description": "SemVer gives a semantic version range to check against the tags available.", "description": "SemVer gives a semantic version range to check against the tags\navailable.",
"properties": { "properties": {
"range": { "range": {
"description": "Range gives a semver range for the image tag; the highest version within the range that's a tag yields the latest image.", "description": "Range gives a semver range for the image tag; the highest\nversion within the range that's a tag yields the latest image.",
"type": "string" "type": "string"
} }
}, },
@ -117,26 +117,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -152,7 +152,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -171,7 +171,7 @@
"type": "array" "type": "array"
}, },
"latestImage": { "latestImage": {
"description": "LatestImage gives the first in the list of images scanned by the image repository, when filtered and ordered according to the policy.", "description": "LatestImage gives the first in the list of images scanned by\nthe image repository, when filtered and ordered according to\nthe policy.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
@ -179,7 +179,7 @@
"type": "integer" "type": "integer"
}, },
"observedPreviousImage": { "observedPreviousImage": {
"description": "ObservedPreviousImage is the observed previous LatestImage. It is used to keep track of the previous and current images.", "description": "ObservedPreviousImage is the observed previous LatestImage. It is used\nto keep track of the previous and current images.",
"type": "string" "type": "string"
} }
}, },

44
image.toolkit.fluxcd.io/imagerepository_v1beta1.json
View File

@ -2,32 +2,32 @@
"description": "ImageRepository is the Schema for the imagerepositories API", "description": "ImageRepository is the Schema for the imagerepositories API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "ImageRepositorySpec defines the parameters for scanning an image repository, e.g., `fluxcd/flux`.", "description": "ImageRepositorySpec defines the parameters for scanning an image\nrepository, e.g., `fluxcd/flux`.",
"properties": { "properties": {
"accessFrom": { "accessFrom": {
"description": "AccessFrom defines an ACL for allowing cross-namespace references to the ImageRepository object based on the caller's namespace labels.", "description": "AccessFrom defines an ACL for allowing cross-namespace references\nto the ImageRepository object based on the caller's namespace labels.",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -44,7 +44,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"certSecretRef": { "certSecretRef": {
"description": "CertSecretRef can be given the name of a secret containing either or both of \n - a PEM-encoded client certificate (`certFile`) and private key (`keyFile`); - a PEM-encoded CA certificate (`caFile`) \n and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate.", "description": "CertSecretRef can be given the name of a secret containing\neither or both of\n\n\n - a PEM-encoded client certificate (`certFile`) and private\n key (`keyFile`);\n - a PEM-encoded CA certificate (`caFile`)\n\n\n and whichever are supplied, will be used for connecting to the\n registry. The client cert and key are useful if you are\n authenticating with a certificate; the CA cert is useful if\n you are using a self-signed server certificate.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -58,7 +58,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"exclusionList": { "exclusionList": {
"description": "ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database.", "description": "ExclusionList is a list of regex strings used to exclude certain tags\nfrom being stored in the database.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -69,12 +69,12 @@
"type": "string" "type": "string"
}, },
"interval": { "interval": {
"description": "Interval is the length of time to wait between scans of the image repository.", "description": "Interval is the length of time to wait between\nscans of the image repository.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef can be given the name of a secret containing credentials to use for the image registry. The secret should be created with `kubectl create secret docker-registry`, or the equivalent.", "description": "SecretRef can be given the name of a secret containing\ncredentials to use for the image registry. The secret should be\ncreated with `kubectl create secret docker-registry`, or the\nequivalent.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -88,16 +88,16 @@
"additionalProperties": false "additionalProperties": false
}, },
"serviceAccountName": { "serviceAccountName": {
"description": "ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets.", "description": "ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate\nthe image pull if the service account has attached pull secrets.",
"maxLength": 253, "maxLength": 253,
"type": "string" "type": "string"
}, },
"suspend": { "suspend": {
"description": "This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false.", "description": "This flag tells the controller to suspend subsequent image scans.\nIt does not apply to already started scans. Defaults to false.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout for image scanning. Defaults to 'Interval' duration.", "description": "Timeout for image scanning.\nDefaults to 'Interval' duration.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m))+$",
"type": "string" "type": "string"
} }
@ -112,31 +112,31 @@
"description": "ImageRepositoryStatus defines the observed state of ImageRepository", "description": "ImageRepositoryStatus defines the observed state of ImageRepository",
"properties": { "properties": {
"canonicalImageName": { "canonicalImageName": {
"description": "CanonicalName is the name of the image repository with all the implied bits made explicit; e.g., `docker.io/library/alpine` rather than `alpine`.", "description": "CanonicalName is the name of the image repository with all the\nimplied bits made explicit; e.g., `docker.io/library/alpine`\nrather than `alpine`.",
"type": "string" "type": "string"
}, },
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -152,7 +152,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -171,7 +171,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"lastScanResult": { "lastScanResult": {

48
image.toolkit.fluxcd.io/imagerepository_v1beta2.json
View File

@ -2,32 +2,32 @@
"description": "ImageRepository is the Schema for the imagerepositories API", "description": "ImageRepository is the Schema for the imagerepositories API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "ImageRepositorySpec defines the parameters for scanning an image repository, e.g., `fluxcd/flux`.", "description": "ImageRepositorySpec defines the parameters for scanning an image\nrepository, e.g., `fluxcd/flux`.",
"properties": { "properties": {
"accessFrom": { "accessFrom": {
"description": "AccessFrom defines an ACL for allowing cross-namespace references to the ImageRepository object based on the caller's namespace labels.", "description": "AccessFrom defines an ACL for allowing cross-namespace references\nto the ImageRepository object based on the caller's namespace labels.",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -44,7 +44,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"certSecretRef": { "certSecretRef": {
"description": "CertSecretRef can be given the name of a Secret containing either or both of \n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \n and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate. The Secret must be of type `Opaque` or `kubernetes.io/tls`. \n Note: Support for the `caFile`, `certFile` and `keyFile` keys has been deprecated.", "description": "CertSecretRef can be given the name of a Secret containing\neither or both of\n\n\n- a PEM-encoded client certificate (`tls.crt`) and private\nkey (`tls.key`);\n- a PEM-encoded CA certificate (`ca.crt`)\n\n\nand whichever are supplied, will be used for connecting to the\nregistry. The client cert and key are useful if you are\nauthenticating with a certificate; the CA cert is useful if\nyou are using a self-signed server certificate. The Secret must\nbe of type `Opaque` or `kubernetes.io/tls`.\n\n\nNote: Support for the `caFile`, `certFile` and `keyFile` keys has\nbeen deprecated.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -61,7 +61,7 @@
"default": [ "default": [
"^.*\\.sig$" "^.*\\.sig$"
], ],
"description": "ExclusionList is a list of regex strings used to exclude certain tags from being stored in the database.", "description": "ExclusionList is a list of regex strings used to exclude certain tags\nfrom being stored in the database.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -77,13 +77,13 @@
"type": "boolean" "type": "boolean"
}, },
"interval": { "interval": {
"description": "Interval is the length of time to wait between scans of the image repository.", "description": "Interval is the length of time to wait between\nscans of the image repository.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"provider": { "provider": {
"default": "generic", "default": "generic",
"description": "The provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. When not specified, defaults to 'generic'.", "description": "The provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'.\nWhen not specified, defaults to 'generic'.",
"enum": [ "enum": [
"generic", "generic",
"aws", "aws",
@ -93,7 +93,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef can be given the name of a secret containing credentials to use for the image registry. The secret should be created with `kubectl create secret docker-registry`, or the equivalent.", "description": "SecretRef can be given the name of a secret containing\ncredentials to use for the image registry. The secret should be\ncreated with `kubectl create secret docker-registry`, or the\nequivalent.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -107,16 +107,16 @@
"additionalProperties": false "additionalProperties": false
}, },
"serviceAccountName": { "serviceAccountName": {
"description": "ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets.", "description": "ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate\nthe image pull if the service account has attached pull secrets.",
"maxLength": 253, "maxLength": 253,
"type": "string" "type": "string"
}, },
"suspend": { "suspend": {
"description": "This flag tells the controller to suspend subsequent image scans. It does not apply to already started scans. Defaults to false.", "description": "This flag tells the controller to suspend subsequent image scans.\nIt does not apply to already started scans. Defaults to false.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout for image scanning. Defaults to 'Interval' duration.", "description": "Timeout for image scanning.\nDefaults to 'Interval' duration.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m))+$",
"type": "string" "type": "string"
} }
@ -131,31 +131,31 @@
"description": "ImageRepositoryStatus defines the observed state of ImageRepository", "description": "ImageRepositoryStatus defines the observed state of ImageRepository",
"properties": { "properties": {
"canonicalImageName": { "canonicalImageName": {
"description": "CanonicalName is the name of the image repository with all the implied bits made explicit; e.g., `docker.io/library/alpine` rather than `alpine`.", "description": "CanonicalName is the name of the image repository with all the\nimplied bits made explicit; e.g., `docker.io/library/alpine`\nrather than `alpine`.",
"type": "string" "type": "string"
}, },
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -171,7 +171,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -190,7 +190,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"lastScanResult": { "lastScanResult": {
@ -217,7 +217,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"observedExclusionList": { "observedExclusionList": {
"description": "ObservedExclusionList is a list of observed exclusion list. It reflects the exclusion rules used for the observed scan result in spec.lastScanResult.", "description": "ObservedExclusionList is a list of observed exclusion list. It reflects\nthe exclusion rules used for the observed scan result in\nspec.lastScanResult.",
"items": { "items": {
"type": "string" "type": "string"
}, },

56
image.toolkit.fluxcd.io/imageupdateautomation_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "ImageUpdateAutomation is the Schema for the imageupdateautomations API", "description": "ImageUpdateAutomation is the Schema for the imageupdateautomations API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,24 +16,24 @@
"description": "ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation", "description": "ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation",
"properties": { "properties": {
"git": { "git": {
"description": "GitSpec contains all the git-specific definitions. This is technically optional, but in practice mandatory until there are other kinds of source allowed.", "description": "GitSpec contains all the git-specific definitions. This is\ntechnically optional, but in practice mandatory until there are\nother kinds of source allowed.",
"properties": { "properties": {
"checkout": { "checkout": {
"description": "Checkout gives the parameters for cloning the git repository, ready to make changes. If not present, the `spec.ref` field from the referenced `GitRepository` or its default will be used.", "description": "Checkout gives the parameters for cloning the git repository,\nready to make changes. If not present, the `spec.ref` field from the\nreferenced `GitRepository` or its default will be used.",
"properties": { "properties": {
"ref": { "ref": {
"description": "Reference gives a branch, tag or commit to clone from the Git repository.", "description": "Reference gives a branch, tag or commit to clone from the Git\nrepository.",
"properties": { "properties": {
"branch": { "branch": {
"description": "Branch to check out, defaults to 'master' if no other field is defined.", "description": "Branch to check out, defaults to 'master' if no other field is defined.",
"type": "string" "type": "string"
}, },
"commit": { "commit": {
"description": "Commit SHA to check out, takes precedence over all reference fields. \n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist.", "description": "Commit SHA to check out, takes precedence over all reference fields.\n\n\nThis can be combined with Branch to shallow clone the branch, in which\nthe commit is expected to exist.",
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\"", "description": "Name of the reference to check out; takes precedence over Branch, Tag and SemVer.\n\n\nIt must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description\nExamples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\"",
"type": "string" "type": "string"
}, },
"semver": { "semver": {
@ -59,7 +59,7 @@
"description": "Commit specifies how to commit to the git repository.", "description": "Commit specifies how to commit to the git repository.",
"properties": { "properties": {
"author": { "author": {
"description": "Author gives the email and optionally the name to use as the author of commits.", "description": "Author gives the email and optionally the name to use as the\nauthor of commits.",
"properties": { "properties": {
"email": { "email": {
"description": "Email gives the email to provide when making a commit.", "description": "Email gives the email to provide when making a commit.",
@ -77,14 +77,14 @@
"additionalProperties": false "additionalProperties": false
}, },
"messageTemplate": { "messageTemplate": {
"description": "MessageTemplate provides a template for the commit message, into which will be interpolated the details of the change made.", "description": "MessageTemplate provides a template for the commit message,\ninto which will be interpolated the details of the change made.",
"type": "string" "type": "string"
}, },
"signingKey": { "signingKey": {
"description": "SigningKey provides the option to sign commits with a GPG key", "description": "SigningKey provides the option to sign commits with a GPG key",
"properties": { "properties": {
"secretRef": { "secretRef": {
"description": "SecretRef holds the name to a secret that contains a 'git.asc' key corresponding to the ASCII Armored file containing the GPG signing keypair as the value. It must be in the same namespace as the ImageUpdateAutomation.", "description": "SecretRef holds the name to a secret that contains a 'git.asc' key\ncorresponding to the ASCII Armored file containing the GPG signing\nkeypair as the value. It must be in the same namespace as the\nImageUpdateAutomation.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -109,21 +109,21 @@
"additionalProperties": false "additionalProperties": false
}, },
"push": { "push": {
"description": "Push specifies how and where to push commits made by the automation. If missing, commits are pushed (back) to `.spec.checkout.branch` or its default.", "description": "Push specifies how and where to push commits made by the\nautomation. If missing, commits are pushed (back) to\n`.spec.checkout.branch` or its default.",
"properties": { "properties": {
"branch": { "branch": {
"description": "Branch specifies that commits should be pushed to the branch named. The branch is created using `.spec.checkout.branch` as the starting point, if it doesn't already exist.", "description": "Branch specifies that commits should be pushed to the branch\nnamed. The branch is created using `.spec.checkout.branch` as the\nstarting point, if it doesn't already exist.",
"type": "string" "type": "string"
}, },
"options": { "options": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "Options specifies the push options that are sent to the Git server when performing a push operation. For details, see: https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt", "description": "Options specifies the push options that are sent to the Git\nserver when performing a push operation. For details, see:\nhttps://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt",
"type": "object" "type": "object"
}, },
"refspec": { "refspec": {
"description": "Refspec specifies the Git Refspec to use for a push operation. If both Branch and Refspec are provided, then the commit is pushed to the branch and also using the specified refspec. For more details about Git Refspecs, see: https://git-scm.com/book/en/v2/Git-Internals-The-Refspec", "description": "Refspec specifies the Git Refspec to use for a push operation.\nIf both Branch and Refspec are provided, then the commit is pushed\nto the branch and also using the specified refspec.\nFor more details about Git Refspecs, see:\nhttps://git-scm.com/book/en/v2/Git-Internals-The-Refspec",
"type": "string" "type": "string"
} }
}, },
@ -138,12 +138,12 @@
"additionalProperties": false "additionalProperties": false
}, },
"interval": { "interval": {
"description": "Interval gives an lower bound for how often the automation run should be attempted.", "description": "Interval gives an lower bound for how often the automation\nrun should be attempted.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"sourceRef": { "sourceRef": {
"description": "SourceRef refers to the resource giving access details to a git repository.", "description": "SourceRef refers to the resource giving access details\nto a git repository.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent.", "description": "API version of the referent.",
@ -174,17 +174,17 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to not run this automation, until it is unset (or set to false). Defaults to false.", "description": "Suspend tells the controller to not run this automation, until\nit is unset (or set to false). Defaults to false.",
"type": "boolean" "type": "boolean"
}, },
"update": { "update": {
"default": { "default": {
"strategy": "Setters" "strategy": "Setters"
}, },
"description": "Update gives the specification for how to update the files in the repository. This can be left empty, to use the default value.", "description": "Update gives the specification for how to update the files in\nthe repository. This can be left empty, to use the default\nvalue.",
"properties": { "properties": {
"path": { "path": {
"description": "Path to the directory containing the manifests to be updated. Defaults to 'None', which translates to the root path of the GitRepositoryRef.", "description": "Path to the directory containing the manifests to be updated.\nDefaults to 'None', which translates to the root path\nof the GitRepositoryRef.",
"type": "string" "type": "string"
}, },
"strategy": { "strategy": {
@ -218,26 +218,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -253,7 +253,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -272,16 +272,16 @@
"type": "array" "type": "array"
}, },
"lastAutomationRunTime": { "lastAutomationRunTime": {
"description": "LastAutomationRunTime records the last time the controller ran this automation through to completion (even if no updates were made).", "description": "LastAutomationRunTime records the last time the controller ran\nthis automation through to completion (even if no updates were\nmade).",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"lastPushCommit": { "lastPushCommit": {
"description": "LastPushCommit records the SHA1 of the last commit made by the controller, for this automation object", "description": "LastPushCommit records the SHA1 of the last commit made by the\ncontroller, for this automation object",
"type": "string" "type": "string"
}, },
"lastPushTime": { "lastPushTime": {

376
image.toolkit.fluxcd.io/imageupdateautomation_v1beta2.json Normal file
View File

@ -0,0 +1,376 @@
{
"description": "ImageUpdateAutomation is the Schema for the imageupdateautomations API",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "ImageUpdateAutomationSpec defines the desired state of ImageUpdateAutomation",
"properties": {
"git": {
"description": "GitSpec contains all the git-specific definitions. This is\ntechnically optional, but in practice mandatory until there are\nother kinds of source allowed.",
"properties": {
"checkout": {
"description": "Checkout gives the parameters for cloning the git repository,\nready to make changes. If not present, the `spec.ref` field from the\nreferenced `GitRepository` or its default will be used.",
"properties": {
"ref": {
"description": "Reference gives a branch, tag or commit to clone from the Git\nrepository.",
"properties": {
"branch": {
"description": "Branch to check out, defaults to 'master' if no other field is defined.",
"type": "string"
},
"commit": {
"description": "Commit SHA to check out, takes precedence over all reference fields.\n\n\nThis can be combined with Branch to shallow clone the branch, in which\nthe commit is expected to exist.",
"type": "string"
},
"name": {
"description": "Name of the reference to check out; takes precedence over Branch, Tag and SemVer.\n\n\nIt must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description\nExamples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\"",
"type": "string"
},
"semver": {
"description": "SemVer tag expression to check out, takes precedence over Tag.",
"type": "string"
},
"tag": {
"description": "Tag to check out, takes precedence over Branch.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"ref"
],
"type": "object",
"additionalProperties": false
},
"commit": {
"description": "Commit specifies how to commit to the git repository.",
"properties": {
"author": {
"description": "Author gives the email and optionally the name to use as the\nauthor of commits.",
"properties": {
"email": {
"description": "Email gives the email to provide when making a commit.",
"type": "string"
},
"name": {
"description": "Name gives the name to provide when making a commit.",
"type": "string"
}
},
"required": [
"email"
],
"type": "object",
"additionalProperties": false
},
"messageTemplate": {
"description": "MessageTemplate provides a template for the commit message,\ninto which will be interpolated the details of the change made.",
"type": "string"
},
"signingKey": {
"description": "SigningKey provides the option to sign commits with a GPG key",
"properties": {
"secretRef": {
"description": "SecretRef holds the name to a secret that contains a 'git.asc' key\ncorresponding to the ASCII Armored file containing the GPG signing\nkeypair as the value. It must be in the same namespace as the\nImageUpdateAutomation.",
"properties": {
"name": {
"description": "Name of the referent.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"author"
],
"type": "object",
"additionalProperties": false
},
"push": {
"description": "Push specifies how and where to push commits made by the\nautomation. If missing, commits are pushed (back) to\n`.spec.checkout.branch` or its default.",
"properties": {
"branch": {
"description": "Branch specifies that commits should be pushed to the branch\nnamed. The branch is created using `.spec.checkout.branch` as the\nstarting point, if it doesn't already exist.",
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "Options specifies the push options that are sent to the Git\nserver when performing a push operation. For details, see:\nhttps://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt",
"type": "object"
},
"refspec": {
"description": "Refspec specifies the Git Refspec to use for a push operation.\nIf both Branch and Refspec are provided, then the commit is pushed\nto the branch and also using the specified refspec.\nFor more details about Git Refspecs, see:\nhttps://git-scm.com/book/en/v2/Git-Internals-The-Refspec",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"required": [
"commit"
],
"type": "object",
"additionalProperties": false
},
"interval": {
"description": "Interval gives an lower bound for how often the automation\nrun should be attempted.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string"
},
"policySelector": {
"description": "PolicySelector allows to filter applied policies based on labels.\nBy default includes all policies in namespace.",
"properties": {
"matchExpressions": {
"description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.",
"items": {
"description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.",
"properties": {
"key": {
"description": "key is the label key that the selector applies to.",
"type": "string"
},
"operator": {
"description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.",
"type": "string"
},
"values": {
"description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.",
"items": {
"type": "string"
},
"type": "array",
"x-kubernetes-list-type": "atomic"
}
},
"required": [
"key",
"operator"
],
"type": "object",
"additionalProperties": false
},
"type": "array",
"x-kubernetes-list-type": "atomic"
},
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"x-kubernetes-map-type": "atomic",
"additionalProperties": false
},
"sourceRef": {
"description": "SourceRef refers to the resource giving access details\nto a git repository.",
"properties": {
"apiVersion": {
"description": "API version of the referent.",
"type": "string"
},
"kind": {
"default": "GitRepository",
"description": "Kind of the referent.",
"enum": [
"GitRepository"
],
"type": "string"
},
"name": {
"description": "Name of the referent.",
"type": "string"
},
"namespace": {
"description": "Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference.",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object",
"additionalProperties": false
},
"suspend": {
"description": "Suspend tells the controller to not run this automation, until\nit is unset (or set to false). Defaults to false.",
"type": "boolean"
},
"update": {
"default": {
"strategy": "Setters"
},
"description": "Update gives the specification for how to update the files in\nthe repository. This can be left empty, to use the default\nvalue.",
"properties": {
"path": {
"description": "Path to the directory containing the manifests to be updated.\nDefaults to 'None', which translates to the root path\nof the GitRepositoryRef.",
"type": "string"
},
"strategy": {
"default": "Setters",
"description": "Strategy names the strategy to be used.",
"enum": [
"Setters"
],
"type": "string"
}
},
"required": [
"strategy"
],
"type": "object",
"additionalProperties": false
}
},
"required": [
"interval",
"sourceRef"
],
"type": "object",
"additionalProperties": false
},
"status": {
"default": {
"observedGeneration": -1
},
"description": "ImageUpdateAutomationStatus defines the observed state of ImageUpdateAutomation",
"properties": {
"conditions": {
"items": {
"description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": {
"lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768,
"type": "string"
},
"observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64",
"minimum": 0,
"type": "integer"
},
"reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
"type": "string"
},
"status": {
"description": "status of the condition, one of True, False, Unknown.",
"enum": [
"True",
"False",
"Unknown"
],
"type": "string"
},
"type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string"
}
},
"required": [
"lastTransitionTime",
"message",
"reason",
"status",
"type"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"lastAutomationRunTime": {
"description": "LastAutomationRunTime records the last time the controller ran\nthis automation through to completion (even if no updates were\nmade).",
"format": "date-time",
"type": "string"
},
"lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string"
},
"lastPushCommit": {
"description": "LastPushCommit records the SHA1 of the last commit made by the\ncontroller, for this automation object",
"type": "string"
},
"lastPushTime": {
"description": "LastPushTime records the time of the last pushed change.",
"format": "date-time",
"type": "string"
},
"observedGeneration": {
"format": "int64",
"type": "integer"
},
"observedPolicies": {
"additionalProperties": {
"description": "ImageRef represents an image reference.",
"properties": {
"name": {
"description": "Name is the bare image's name.",
"type": "string"
},
"tag": {
"description": "Tag is the image's tag.",
"type": "string"
}
},
"required": [
"name",
"tag"
],
"type": "object",
"additionalProperties": false
},
"description": "ObservedPolicies is the list of observed ImagePolicies that were\nconsidered by the ImageUpdateAutomation update process.",
"type": "object"
},
"observedSourceRevision": {
"description": "ObservedPolicies []ObservedPolicy `json:\"observedPolicies,omitempty\"`\nObservedSourceRevision is the last observed source revision. This can be\nused to determine if the source has been updated since last observation.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object"
}

102
kustomize.toolkit.fluxcd.io/kustomization_v1.json
View File

@ -2,21 +2,21 @@
"description": "Kustomization is the Schema for the kustomizations API.", "description": "Kustomization is the Schema for the kustomizations API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize.", "description": "KustomizationSpec defines the configuration to calculate the desired state\nfrom a Source using Kustomize.",
"properties": { "properties": {
"commonMetadata": { "commonMetadata": {
"description": "CommonMetadata specifies the common labels and annotations that are applied to all resources. Any existing label or annotation will be overridden if its key matches a common one.", "description": "CommonMetadata specifies the common labels and annotations that are\napplied to all resources. Any existing label or annotation will be\noverridden if its key matches a common one.",
"properties": { "properties": {
"annotations": { "annotations": {
"additionalProperties": { "additionalProperties": {
@ -75,9 +75,9 @@
"additionalProperties": false "additionalProperties": false
}, },
"dependsOn": { "dependsOn": {
"description": "DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled.", "description": "DependsOn may contain a meta.NamespacedObjectReference slice\nwith references to Kustomization resources that must be ready before this\nKustomization can be reconciled.",
"items": { "items": {
"description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any namespace.", "description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any\nnamespace.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -98,13 +98,13 @@
}, },
"force": { "force": {
"default": false, "default": false,
"description": "Force instructs the controller to recreate resources when patching fails due to an immutable field change.", "description": "Force instructs the controller to recreate resources\nwhen patching fails due to an immutable field change.",
"type": "boolean" "type": "boolean"
}, },
"healthChecks": { "healthChecks": {
"description": "A list of resources to be included in the health assessment.", "description": "A list of resources to be included in the health assessment.",
"items": { "items": {
"description": "NamespacedObjectKindReference contains enough information to locate the typed referenced Kubernetes resource object in any namespace.", "description": "NamespacedObjectKindReference contains enough information to locate the typed referenced Kubernetes resource object\nin any namespace.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent, if not specified the Kubernetes preferred version will be used.", "description": "API version of the referent, if not specified the Kubernetes preferred version will be used.",
@ -133,12 +133,12 @@
"type": "array" "type": "array"
}, },
"images": { "images": {
"description": "Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.", "description": "Images is a list of (image name, new name, new tag or digest)\nfor changing image names, tags or digests. This can also be achieved with a\npatch, but this operator is simpler to specify.",
"items": { "items": {
"description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.", "description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.",
"properties": { "properties": {
"digest": { "digest": {
"description": "Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored.", "description": "Digest is the value used to replace the original image tag.\nIf digest is present NewTag value is ignored.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -163,15 +163,15 @@
"type": "array" "type": "array"
}, },
"interval": { "interval": {
"description": "The interval at which to reconcile the Kustomization. This interval is approximate and may be subject to jitter to ensure efficient use of resources.", "description": "The interval at which to reconcile the Kustomization.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"kubeConfig": { "kubeConfig": {
"description": "The KubeConfig for reconciling the Kustomization on a remote cluster. When used in combination with KustomizationSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when KustomizationSpec.ServiceAccountName is empty.", "description": "The KubeConfig for reconciling the Kustomization on a remote cluster.\nWhen used in combination with KustomizationSpec.ServiceAccountName,\nforces the controller to act on behalf of that Service Account at the\ntarget cluster.\nIf the --default-service-account flag is set, its value will be used as\na controller level fallback for when KustomizationSpec.ServiceAccountName\nis empty.",
"properties": { "properties": {
"secretRef": { "secretRef": {
"description": "SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources.", "description": "SecretRef holds the name of a secret that contains a key with\nthe kubeconfig file as the value. If no key is set, the key will default\nto 'value'.\nIt is recommended that the kubeconfig is self-contained, and the secret\nis regularly updated if credentials such as a cloud-access-token expire.\nCloud specific `cmd-path` auth helpers will not function without adding\nbinaries and credentials to the Pod that is responsible for reconciling\nKubernetes resources.",
"properties": { "properties": {
"key": { "key": {
"description": "Key in the Secret, when not specified an implementation-specific default key is used.", "description": "Key in the Secret, when not specified an implementation-specific default key is used.",
@ -195,32 +195,44 @@
"type": "object", "type": "object",
"additionalProperties": false "additionalProperties": false
}, },
"namePrefix": {
"description": "NamePrefix will prefix the names of all managed resources.",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"nameSuffix": {
"description": "NameSuffix will suffix the names of all managed resources.",
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"patches": { "patches": {
"description": "Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.", "description": "Strategic merge and JSON patches, defined as inline YAML objects,\ncapable of targeting objects based on kind, label and annotation selectors.",
"items": { "items": {
"description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should be applied to.", "description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should\nbe applied to.",
"properties": { "properties": {
"patch": { "patch": {
"description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects.", "description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with\nan array of operation objects.",
"type": "string" "type": "string"
}, },
"target": { "target": {
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -232,7 +244,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -249,23 +261,23 @@
"type": "array" "type": "array"
}, },
"path": { "path": {
"description": "Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef.", "description": "Path to the directory containing the kustomization.yaml file, or the\nset of plain YAMLs a kustomization.yaml should be generated for.\nDefaults to 'None', which translates to the root path of the SourceRef.",
"type": "string" "type": "string"
}, },
"postBuild": { "postBuild": {
"description": "PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay.", "description": "PostBuild describes which actions to perform on the YAML manifest\ngenerated by building the kustomize overlay.",
"properties": { "properties": {
"substitute": { "substitute": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}.", "description": "Substitute holds a map of key/value pairs.\nThe variables defined in your YAML manifests that match any of the keys\ndefined in the map will be substituted with the set value.\nIncludes support for bash string replacement functions\ne.g. ${var:=default}, ${var:position} and ${var/substring/replacement}.",
"type": "object" "type": "object"
}, },
"substituteFrom": { "substituteFrom": {
"description": "SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names, and they must match the vars declared in the manifests for the substitution to happen.", "description": "SubstituteFrom holds references to ConfigMaps and Secrets containing\nthe variables and their values to be substituted in the YAML manifests.\nThe ConfigMap and the Secret data keys represent the var names, and they\nmust match the vars declared in the manifests for the substitution to\nhappen.",
"items": { "items": {
"description": "SubstituteReference contains a reference to a resource containing the variables name and value.", "description": "SubstituteReference contains a reference to a resource containing\nthe variables name and value.",
"properties": { "properties": {
"kind": { "kind": {
"description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').", "description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').",
@ -276,14 +288,14 @@
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the values referent. Should reside in the same namespace as the referring resource.", "description": "Name of the values referent. Should reside in the same namespace as the\nreferring resource.",
"maxLength": 253, "maxLength": 253,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"optional": { "optional": {
"default": false, "default": false,
"description": "Optional indicates whether the referenced resource must exist, or whether to tolerate its absence. If true and the referenced resource is absent, proceed as if the resource was present but empty, without any variables defined.", "description": "Optional indicates whether the referenced resource must exist, or whether to\ntolerate its absence. If true and the referenced resource is absent, proceed\nas if the resource was present but empty, without any variables defined.",
"type": "boolean" "type": "boolean"
} }
}, },
@ -305,12 +317,12 @@
"type": "boolean" "type": "boolean"
}, },
"retryInterval": { "retryInterval": {
"description": "The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures.", "description": "The interval at which to retry a previously failed reconciliation.\nWhen not specified, the controller uses the KustomizationSpec.Interval\nvalue to retry failures.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"serviceAccountName": { "serviceAccountName": {
"description": "The name of the Kubernetes service account to impersonate when reconciling this Kustomization.", "description": "The name of the Kubernetes service account to impersonate\nwhen reconciling this Kustomization.",
"type": "string" "type": "string"
}, },
"sourceRef": { "sourceRef": {
@ -334,7 +346,7 @@
"type": "string" "type": "string"
}, },
"namespace": { "namespace": {
"description": "Namespace of the referent, defaults to the namespace of the Kubernetes resource object that contains the reference.", "description": "Namespace of the referent, defaults to the namespace of the Kubernetes\nresource object that contains the reference.",
"type": "string" "type": "string"
} }
}, },
@ -346,22 +358,22 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false.", "description": "This flag tells the controller to suspend subsequent kustomize executions,\nit does not apply to already started executions. Defaults to false.",
"type": "boolean" "type": "boolean"
}, },
"targetNamespace": { "targetNamespace": {
"description": "TargetNamespace sets or overrides the namespace in the kustomization.yaml file.", "description": "TargetNamespace sets or overrides the namespace in the\nkustomization.yaml file.",
"maxLength": 63, "maxLength": 63,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"timeout": { "timeout": {
"description": "Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration.", "description": "Timeout for validation, apply and health checking operations.\nDefaults to 'Interval' duration.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"wait": { "wait": {
"description": "Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false.", "description": "Wait instructs the controller to check the health of all the reconciled\nresources. When enabled, the HealthChecks are ignored. Defaults to false.",
"type": "boolean" "type": "boolean"
} }
}, },
@ -381,26 +393,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -416,7 +428,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -435,7 +447,7 @@
"type": "array" "type": "array"
}, },
"inventory": { "inventory": {
"description": "Inventory contains the list of Kubernetes resource object references that have been successfully applied.", "description": "Inventory contains the list of Kubernetes resource object references that\nhave been successfully applied.",
"properties": { "properties": {
"entries": { "entries": {
"description": "Entries of Kubernetes resource object references.", "description": "Entries of Kubernetes resource object references.",
@ -443,7 +455,7 @@
"description": "ResourceRef contains the information necessary to locate a resource within a cluster.", "description": "ResourceRef contains the information necessary to locate a resource within a cluster.",
"properties": { "properties": {
"id": { "id": {
"description": "ID is the string representation of the Kubernetes resource object's metadata, in the format '<namespace>_<name>_<group>_<kind>'.", "description": "ID is the string representation of the Kubernetes resource object's metadata,\nin the format '<namespace>_<name>_<group>_<kind>'.",
"type": "string" "type": "string"
}, },
"v": { "v": {
@ -468,7 +480,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"lastAppliedRevision": { "lastAppliedRevision": {
"description": "The last successfully applied revision. Equals the Revision of the applied Artifact from the referenced Source.", "description": "The last successfully applied revision.\nEquals the Revision of the applied Artifact from the referenced Source.",
"type": "string" "type": "string"
}, },
"lastAttemptedRevision": { "lastAttemptedRevision": {
@ -476,7 +488,7 @@
"type": "string" "type": "string"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {

98
kustomize.toolkit.fluxcd.io/kustomization_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "Kustomization is the Schema for the kustomizations API.", "description": "Kustomization is the Schema for the kustomizations API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -47,9 +47,9 @@
"additionalProperties": false "additionalProperties": false
}, },
"dependsOn": { "dependsOn": {
"description": "DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled.", "description": "DependsOn may contain a meta.NamespacedObjectReference slice\nwith references to Kustomization resources that must be ready before this\nKustomization can be reconciled.",
"items": { "items": {
"description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any namespace.", "description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any\nnamespace.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -70,13 +70,13 @@
}, },
"force": { "force": {
"default": false, "default": false,
"description": "Force instructs the controller to recreate resources when patching fails due to an immutable field change.", "description": "Force instructs the controller to recreate resources\nwhen patching fails due to an immutable field change.",
"type": "boolean" "type": "boolean"
}, },
"healthChecks": { "healthChecks": {
"description": "A list of resources to be included in the health assessment.", "description": "A list of resources to be included in the health assessment.",
"items": { "items": {
"description": "NamespacedObjectKindReference contains enough information to locate the typed referenced Kubernetes resource object in any namespace.", "description": "NamespacedObjectKindReference contains enough information to locate the typed referenced Kubernetes resource object\nin any namespace.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent, if not specified the Kubernetes preferred version will be used.", "description": "API version of the referent, if not specified the Kubernetes preferred version will be used.",
@ -105,12 +105,12 @@
"type": "array" "type": "array"
}, },
"images": { "images": {
"description": "Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.", "description": "Images is a list of (image name, new name, new tag or digest)\nfor changing image names, tags or digests. This can also be achieved with a\npatch, but this operator is simpler to specify.",
"items": { "items": {
"description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.", "description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.",
"properties": { "properties": {
"digest": { "digest": {
"description": "Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored.", "description": "Digest is the value used to replace the original image tag.\nIf digest is present NewTag value is ignored.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -139,10 +139,10 @@
"type": "string" "type": "string"
}, },
"kubeConfig": { "kubeConfig": {
"description": "The KubeConfig for reconciling the Kustomization on a remote cluster. When specified, KubeConfig takes precedence over ServiceAccountName.", "description": "The KubeConfig for reconciling the Kustomization on a remote cluster.\nWhen specified, KubeConfig takes precedence over ServiceAccountName.",
"properties": { "properties": {
"secretRef": { "secretRef": {
"description": "SecretRef holds the name to a secret that contains a 'value' key with the kubeconfig file as the value. It must be in the same namespace as the Kustomization. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling the Kustomization.", "description": "SecretRef holds the name to a secret that contains a 'value' key with\nthe kubeconfig file as the value. It must be in the same namespace as\nthe Kustomization.\nIt is recommended that the kubeconfig is self-contained, and the secret\nis regularly updated if credentials such as a cloud-access-token expire.\nCloud specific `cmd-path` auth helpers will not function without adding\nbinaries and credentials to the Pod that is responsible for reconciling\nthe Kustomization.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -160,31 +160,31 @@
"additionalProperties": false "additionalProperties": false
}, },
"patches": { "patches": {
"description": "Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.", "description": "Strategic merge and JSON patches, defined as inline YAML objects,\ncapable of targeting objects based on kind, label and annotation selectors.",
"items": { "items": {
"description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should be applied to.", "description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should\nbe applied to.",
"properties": { "properties": {
"patch": { "patch": {
"description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects.", "description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with\nan array of operation objects.",
"type": "string" "type": "string"
}, },
"target": { "target": {
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -196,7 +196,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -220,14 +220,14 @@
"patch": { "patch": {
"description": "Patch contains the JSON6902 patch document with an array of operation objects.", "description": "Patch contains the JSON6902 patch document with an array of operation objects.",
"items": { "items": {
"description": "JSON6902 is a JSON6902 operation object. https://datatracker.ietf.org/doc/html/rfc6902#section-4", "description": "JSON6902 is a JSON6902 operation object.\nhttps://datatracker.ietf.org/doc/html/rfc6902#section-4",
"properties": { "properties": {
"from": { "from": {
"description": "From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.", "description": "From contains a JSON-pointer value that references a location within the target document where the operation is\nperformed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.",
"type": "string" "type": "string"
}, },
"op": { "op": {
"description": "Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4", "description": "Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or\n\"test\".\nhttps://datatracker.ietf.org/doc/html/rfc6902#section-4",
"enum": [ "enum": [
"test", "test",
"remove", "remove",
@ -239,11 +239,11 @@
"type": "string" "type": "string"
}, },
"path": { "path": {
"description": "Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op.", "description": "Path contains the JSON-pointer value that references a location within the target document where the operation\nis performed. The meaning of the value depends on the value of Op.",
"type": "string" "type": "string"
}, },
"value": { "value": {
"description": "Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.", "description": "Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into\naccount by all operations.",
"x-kubernetes-preserve-unknown-fields": true "x-kubernetes-preserve-unknown-fields": true
} }
}, },
@ -260,19 +260,19 @@
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -284,7 +284,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -309,23 +309,23 @@
"type": "array" "type": "array"
}, },
"path": { "path": {
"description": "Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef.", "description": "Path to the directory containing the kustomization.yaml file, or the\nset of plain YAMLs a kustomization.yaml should be generated for.\nDefaults to 'None', which translates to the root path of the SourceRef.",
"type": "string" "type": "string"
}, },
"postBuild": { "postBuild": {
"description": "PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay.", "description": "PostBuild describes which actions to perform on the YAML manifest\ngenerated by building the kustomize overlay.",
"properties": { "properties": {
"substitute": { "substitute": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}.", "description": "Substitute holds a map of key/value pairs.\nThe variables defined in your YAML manifests\nthat match any of the keys defined in the map\nwill be substituted with the set value.\nIncludes support for bash string replacement functions\ne.g. ${var:=default}, ${var:position} and ${var/substring/replacement}.",
"type": "object" "type": "object"
}, },
"substituteFrom": { "substituteFrom": {
"description": "SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen.", "description": "SubstituteFrom holds references to ConfigMaps and Secrets containing\nthe variables and their values to be substituted in the YAML manifests.\nThe ConfigMap and the Secret data keys represent the var names and they\nmust match the vars declared in the manifests for the substitution to happen.",
"items": { "items": {
"description": "SubstituteReference contains a reference to a resource containing the variables name and value.", "description": "SubstituteReference contains a reference to a resource containing\nthe variables name and value.",
"properties": { "properties": {
"kind": { "kind": {
"description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').", "description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').",
@ -336,7 +336,7 @@
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the values referent. Should reside in the same namespace as the referring resource.", "description": "Name of the values referent. Should reside in the same namespace as the\nreferring resource.",
"maxLength": 253, "maxLength": 253,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -360,11 +360,11 @@
"type": "boolean" "type": "boolean"
}, },
"retryInterval": { "retryInterval": {
"description": "The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures.", "description": "The interval at which to retry a previously failed reconciliation.\nWhen not specified, the controller uses the KustomizationSpec.Interval\nvalue to retry failures.",
"type": "string" "type": "string"
}, },
"serviceAccountName": { "serviceAccountName": {
"description": "The name of the Kubernetes service account to impersonate when reconciling this Kustomization.", "description": "The name of the Kubernetes service account to impersonate\nwhen reconciling this Kustomization.",
"type": "string" "type": "string"
}, },
"sourceRef": { "sourceRef": {
@ -399,21 +399,21 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false.", "description": "This flag tells the controller to suspend subsequent kustomize executions,\nit does not apply to already started executions. Defaults to false.",
"type": "boolean" "type": "boolean"
}, },
"targetNamespace": { "targetNamespace": {
"description": "TargetNamespace sets or overrides the namespace in the kustomization.yaml file.", "description": "TargetNamespace sets or overrides the namespace in the\nkustomization.yaml file.",
"maxLength": 63, "maxLength": 63,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"timeout": { "timeout": {
"description": "Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration.", "description": "Timeout for validation, apply and health checking operations.\nDefaults to 'Interval' duration.",
"type": "string" "type": "string"
}, },
"validation": { "validation": {
"description": "Validate the Kubernetes objects before applying them on the cluster. The validation strategy can be 'client' (local dry-run), 'server' (APIServer dry-run) or 'none'. When 'Force' is 'true', validation will fallback to 'client' if set to 'server' because server-side validation is not supported in this scenario.", "description": "Validate the Kubernetes objects before applying them on the cluster.\nThe validation strategy can be 'client' (local dry-run), 'server'\n(APIServer dry-run) or 'none'.\nWhen 'Force' is 'true', validation will fallback to 'client' if set to\n'server' because server-side validation is not supported in this scenario.",
"enum": [ "enum": [
"none", "none",
"client", "client",
@ -438,26 +438,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -473,7 +473,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -492,7 +492,7 @@
"type": "array" "type": "array"
}, },
"lastAppliedRevision": { "lastAppliedRevision": {
"description": "The last successfully applied revision. The revision format for Git sources is <branch|tag>/<commit-sha>.", "description": "The last successfully applied revision.\nThe revision format for Git sources is <branch|tag>/<commit-sha>.",
"type": "string" "type": "string"
}, },
"lastAttemptedRevision": { "lastAttemptedRevision": {
@ -500,7 +500,7 @@
"type": "string" "type": "string"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
@ -518,7 +518,7 @@
"entries": { "entries": {
"description": "A list of Kubernetes kinds grouped by namespace.", "description": "A list of Kubernetes kinds grouped by namespace.",
"items": { "items": {
"description": "Snapshot holds the metadata of namespaced Kubernetes objects", "description": "Snapshot holds the metadata of namespaced\nKubernetes objects",
"properties": { "properties": {
"kinds": { "kinds": {
"additionalProperties": { "additionalProperties": {

106
kustomize.toolkit.fluxcd.io/kustomization_v1beta2.json
View File

@ -2,11 +2,11 @@
"description": "Kustomization is the Schema for the kustomizations API.", "description": "Kustomization is the Schema for the kustomizations API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,7 +16,7 @@
"description": "KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize.", "description": "KustomizationSpec defines the configuration to calculate the desired state from a Source using Kustomize.",
"properties": { "properties": {
"commonMetadata": { "commonMetadata": {
"description": "CommonMetadata specifies the common labels and annotations that are applied to all resources. Any existing label or annotation will be overridden if its key matches a common one.", "description": "CommonMetadata specifies the common labels and annotations that are applied to all resources.\nAny existing label or annotation will be overridden if its key matches a common one.",
"properties": { "properties": {
"annotations": { "annotations": {
"additionalProperties": { "additionalProperties": {
@ -75,9 +75,9 @@
"additionalProperties": false "additionalProperties": false
}, },
"dependsOn": { "dependsOn": {
"description": "DependsOn may contain a meta.NamespacedObjectReference slice with references to Kustomization resources that must be ready before this Kustomization can be reconciled.", "description": "DependsOn may contain a meta.NamespacedObjectReference slice\nwith references to Kustomization resources that must be ready before this\nKustomization can be reconciled.",
"items": { "items": {
"description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any namespace.", "description": "NamespacedObjectReference contains enough information to locate the referenced Kubernetes resource object in any\nnamespace.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -98,13 +98,13 @@
}, },
"force": { "force": {
"default": false, "default": false,
"description": "Force instructs the controller to recreate resources when patching fails due to an immutable field change.", "description": "Force instructs the controller to recreate resources\nwhen patching fails due to an immutable field change.",
"type": "boolean" "type": "boolean"
}, },
"healthChecks": { "healthChecks": {
"description": "A list of resources to be included in the health assessment.", "description": "A list of resources to be included in the health assessment.",
"items": { "items": {
"description": "NamespacedObjectKindReference contains enough information to locate the typed referenced Kubernetes resource object in any namespace.", "description": "NamespacedObjectKindReference contains enough information to locate the typed referenced Kubernetes resource object\nin any namespace.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent, if not specified the Kubernetes preferred version will be used.", "description": "API version of the referent, if not specified the Kubernetes preferred version will be used.",
@ -133,12 +133,12 @@
"type": "array" "type": "array"
}, },
"images": { "images": {
"description": "Images is a list of (image name, new name, new tag or digest) for changing image names, tags or digests. This can also be achieved with a patch, but this operator is simpler to specify.", "description": "Images is a list of (image name, new name, new tag or digest)\nfor changing image names, tags or digests. This can also be achieved with a\npatch, but this operator is simpler to specify.",
"items": { "items": {
"description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.", "description": "Image contains an image name, a new name, a new tag or digest, which will replace the original name and tag.",
"properties": { "properties": {
"digest": { "digest": {
"description": "Digest is the value used to replace the original image tag. If digest is present NewTag value is ignored.", "description": "Digest is the value used to replace the original image tag.\nIf digest is present NewTag value is ignored.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -168,10 +168,10 @@
"type": "string" "type": "string"
}, },
"kubeConfig": { "kubeConfig": {
"description": "The KubeConfig for reconciling the Kustomization on a remote cluster. When used in combination with KustomizationSpec.ServiceAccountName, forces the controller to act on behalf of that Service Account at the target cluster. If the --default-service-account flag is set, its value will be used as a controller level fallback for when KustomizationSpec.ServiceAccountName is empty.", "description": "The KubeConfig for reconciling the Kustomization on a remote cluster.\nWhen used in combination with KustomizationSpec.ServiceAccountName,\nforces the controller to act on behalf of that Service Account at the\ntarget cluster.\nIf the --default-service-account flag is set, its value will be used as\na controller level fallback for when KustomizationSpec.ServiceAccountName\nis empty.",
"properties": { "properties": {
"secretRef": { "secretRef": {
"description": "SecretRef holds the name of a secret that contains a key with the kubeconfig file as the value. If no key is set, the key will default to 'value'. It is recommended that the kubeconfig is self-contained, and the secret is regularly updated if credentials such as a cloud-access-token expire. Cloud specific `cmd-path` auth helpers will not function without adding binaries and credentials to the Pod that is responsible for reconciling Kubernetes resources.", "description": "SecretRef holds the name of a secret that contains a key with\nthe kubeconfig file as the value. If no key is set, the key will default\nto 'value'.\nIt is recommended that the kubeconfig is self-contained, and the secret\nis regularly updated if credentials such as a cloud-access-token expire.\nCloud specific `cmd-path` auth helpers will not function without adding\nbinaries and credentials to the Pod that is responsible for reconciling\nKubernetes resources.",
"properties": { "properties": {
"key": { "key": {
"description": "Key in the Secret, when not specified an implementation-specific default key is used.", "description": "Key in the Secret, when not specified an implementation-specific default key is used.",
@ -196,31 +196,31 @@
"additionalProperties": false "additionalProperties": false
}, },
"patches": { "patches": {
"description": "Strategic merge and JSON patches, defined as inline YAML objects, capable of targeting objects based on kind, label and annotation selectors.", "description": "Strategic merge and JSON patches, defined as inline YAML objects,\ncapable of targeting objects based on kind, label and annotation selectors.",
"items": { "items": {
"description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should be applied to.", "description": "Patch contains an inline StrategicMerge or JSON6902 patch, and the target the patch should\nbe applied to.",
"properties": { "properties": {
"patch": { "patch": {
"description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with an array of operation objects.", "description": "Patch contains an inline StrategicMerge patch or an inline JSON6902 patch with\nan array of operation objects.",
"type": "string" "type": "string"
}, },
"target": { "target": {
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -232,7 +232,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -249,21 +249,21 @@
"type": "array" "type": "array"
}, },
"patchesJson6902": { "patchesJson6902": {
"description": "JSON 6902 patches, defined as inline YAML objects. Deprecated: Use Patches instead.", "description": "JSON 6902 patches, defined as inline YAML objects.\nDeprecated: Use Patches instead.",
"items": { "items": {
"description": "JSON6902Patch contains a JSON6902 patch and the target the patch should be applied to.", "description": "JSON6902Patch contains a JSON6902 patch and the target the patch should be applied to.",
"properties": { "properties": {
"patch": { "patch": {
"description": "Patch contains the JSON6902 patch document with an array of operation objects.", "description": "Patch contains the JSON6902 patch document with an array of operation objects.",
"items": { "items": {
"description": "JSON6902 is a JSON6902 operation object. https://datatracker.ietf.org/doc/html/rfc6902#section-4", "description": "JSON6902 is a JSON6902 operation object.\nhttps://datatracker.ietf.org/doc/html/rfc6902#section-4",
"properties": { "properties": {
"from": { "from": {
"description": "From contains a JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.", "description": "From contains a JSON-pointer value that references a location within the target document where the operation is\nperformed. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.",
"type": "string" "type": "string"
}, },
"op": { "op": {
"description": "Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\". https://datatracker.ietf.org/doc/html/rfc6902#section-4", "description": "Op indicates the operation to perform. Its value MUST be one of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or\n\"test\".\nhttps://datatracker.ietf.org/doc/html/rfc6902#section-4",
"enum": [ "enum": [
"test", "test",
"remove", "remove",
@ -275,11 +275,11 @@
"type": "string" "type": "string"
}, },
"path": { "path": {
"description": "Path contains the JSON-pointer value that references a location within the target document where the operation is performed. The meaning of the value depends on the value of Op.", "description": "Path contains the JSON-pointer value that references a location within the target document where the operation\nis performed. The meaning of the value depends on the value of Op.",
"type": "string" "type": "string"
}, },
"value": { "value": {
"description": "Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into account by all operations.", "description": "Value contains a valid JSON structure. The meaning of the value depends on the value of Op, and is NOT taken into\naccount by all operations.",
"x-kubernetes-preserve-unknown-fields": true "x-kubernetes-preserve-unknown-fields": true
} }
}, },
@ -296,19 +296,19 @@
"description": "Target points to the resources that the patch document should be applied to.", "description": "Target points to the resources that the patch document should be applied to.",
"properties": { "properties": {
"annotationSelector": { "annotationSelector": {
"description": "AnnotationSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource annotations.", "description": "AnnotationSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource annotations.",
"type": "string" "type": "string"
}, },
"group": { "group": {
"description": "Group is the API group to select resources from. Together with Version and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Group is the API group to select resources from.\nTogether with Version and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the API Group to select resources from. Together with Group and Version it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Kind of the API Group to select resources from.\nTogether with Group and Version it is capable of unambiguously\nidentifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
}, },
"labelSelector": { "labelSelector": {
"description": "LabelSelector is a string that follows the label selection expression https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api It matches with the resource labels.", "description": "LabelSelector is a string that follows the label selection expression\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#api\nIt matches with the resource labels.",
"type": "string" "type": "string"
}, },
"name": { "name": {
@ -320,7 +320,7 @@
"type": "string" "type": "string"
}, },
"version": { "version": {
"description": "Version of the API Group to select resources from. Together with Group and Kind it is capable of unambiguously identifying and/or selecting resources. https://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md", "description": "Version of the API Group to select resources from.\nTogether with Group and Kind it is capable of unambiguously identifying and/or selecting resources.\nhttps://github.com/kubernetes/community/blob/master/contributors/design-proposals/api-machinery/api-group.md",
"type": "string" "type": "string"
} }
}, },
@ -338,30 +338,30 @@
"type": "array" "type": "array"
}, },
"patchesStrategicMerge": { "patchesStrategicMerge": {
"description": "Strategic merge patches, defined as inline YAML objects. Deprecated: Use Patches instead.", "description": "Strategic merge patches, defined as inline YAML objects.\nDeprecated: Use Patches instead.",
"items": { "items": {
"x-kubernetes-preserve-unknown-fields": true "x-kubernetes-preserve-unknown-fields": true
}, },
"type": "array" "type": "array"
}, },
"path": { "path": {
"description": "Path to the directory containing the kustomization.yaml file, or the set of plain YAMLs a kustomization.yaml should be generated for. Defaults to 'None', which translates to the root path of the SourceRef.", "description": "Path to the directory containing the kustomization.yaml file, or the\nset of plain YAMLs a kustomization.yaml should be generated for.\nDefaults to 'None', which translates to the root path of the SourceRef.",
"type": "string" "type": "string"
}, },
"postBuild": { "postBuild": {
"description": "PostBuild describes which actions to perform on the YAML manifest generated by building the kustomize overlay.", "description": "PostBuild describes which actions to perform on the YAML manifest\ngenerated by building the kustomize overlay.",
"properties": { "properties": {
"substitute": { "substitute": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "Substitute holds a map of key/value pairs. The variables defined in your YAML manifests that match any of the keys defined in the map will be substituted with the set value. Includes support for bash string replacement functions e.g. ${var:=default}, ${var:position} and ${var/substring/replacement}.", "description": "Substitute holds a map of key/value pairs.\nThe variables defined in your YAML manifests\nthat match any of the keys defined in the map\nwill be substituted with the set value.\nIncludes support for bash string replacement functions\ne.g. ${var:=default}, ${var:position} and ${var/substring/replacement}.",
"type": "object" "type": "object"
}, },
"substituteFrom": { "substituteFrom": {
"description": "SubstituteFrom holds references to ConfigMaps and Secrets containing the variables and their values to be substituted in the YAML manifests. The ConfigMap and the Secret data keys represent the var names and they must match the vars declared in the manifests for the substitution to happen.", "description": "SubstituteFrom holds references to ConfigMaps and Secrets containing\nthe variables and their values to be substituted in the YAML manifests.\nThe ConfigMap and the Secret data keys represent the var names and they\nmust match the vars declared in the manifests for the substitution to happen.",
"items": { "items": {
"description": "SubstituteReference contains a reference to a resource containing the variables name and value.", "description": "SubstituteReference contains a reference to a resource containing\nthe variables name and value.",
"properties": { "properties": {
"kind": { "kind": {
"description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').", "description": "Kind of the values referent, valid values are ('Secret', 'ConfigMap').",
@ -372,14 +372,14 @@
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the values referent. Should reside in the same namespace as the referring resource.", "description": "Name of the values referent. Should reside in the same namespace as the\nreferring resource.",
"maxLength": 253, "maxLength": 253,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"optional": { "optional": {
"default": false, "default": false,
"description": "Optional indicates whether the referenced resource must exist, or whether to tolerate its absence. If true and the referenced resource is absent, proceed as if the resource was present but empty, without any variables defined.", "description": "Optional indicates whether the referenced resource must exist, or whether to\ntolerate its absence. If true and the referenced resource is absent, proceed\nas if the resource was present but empty, without any variables defined.",
"type": "boolean" "type": "boolean"
} }
}, },
@ -401,12 +401,12 @@
"type": "boolean" "type": "boolean"
}, },
"retryInterval": { "retryInterval": {
"description": "The interval at which to retry a previously failed reconciliation. When not specified, the controller uses the KustomizationSpec.Interval value to retry failures.", "description": "The interval at which to retry a previously failed reconciliation.\nWhen not specified, the controller uses the KustomizationSpec.Interval\nvalue to retry failures.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"serviceAccountName": { "serviceAccountName": {
"description": "The name of the Kubernetes service account to impersonate when reconciling this Kustomization.", "description": "The name of the Kubernetes service account to impersonate\nwhen reconciling this Kustomization.",
"type": "string" "type": "string"
}, },
"sourceRef": { "sourceRef": {
@ -442,17 +442,17 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "This flag tells the controller to suspend subsequent kustomize executions, it does not apply to already started executions. Defaults to false.", "description": "This flag tells the controller to suspend subsequent kustomize executions,\nit does not apply to already started executions. Defaults to false.",
"type": "boolean" "type": "boolean"
}, },
"targetNamespace": { "targetNamespace": {
"description": "TargetNamespace sets or overrides the namespace in the kustomization.yaml file.", "description": "TargetNamespace sets or overrides the namespace in the\nkustomization.yaml file.",
"maxLength": 63, "maxLength": 63,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
}, },
"timeout": { "timeout": {
"description": "Timeout for validation, apply and health checking operations. Defaults to 'Interval' duration.", "description": "Timeout for validation, apply and health checking operations.\nDefaults to 'Interval' duration.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
@ -466,7 +466,7 @@
"type": "string" "type": "string"
}, },
"wait": { "wait": {
"description": "Wait instructs the controller to check the health of all the reconciled resources. When enabled, the HealthChecks are ignored. Defaults to false.", "description": "Wait instructs the controller to check the health of all the reconciled resources.\nWhen enabled, the HealthChecks are ignored. Defaults to false.",
"type": "boolean" "type": "boolean"
} }
}, },
@ -486,26 +486,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -521,7 +521,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -548,7 +548,7 @@
"description": "ResourceRef contains the information necessary to locate a resource within a cluster.", "description": "ResourceRef contains the information necessary to locate a resource within a cluster.",
"properties": { "properties": {
"id": { "id": {
"description": "ID is the string representation of the Kubernetes resource object's metadata, in the format '<namespace>_<name>_<group>_<kind>'.", "description": "ID is the string representation of the Kubernetes resource object's metadata,\nin the format '<namespace>_<name>_<group>_<kind>'.",
"type": "string" "type": "string"
}, },
"v": { "v": {
@ -573,7 +573,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"lastAppliedRevision": { "lastAppliedRevision": {
"description": "The last successfully applied revision. Equals the Revision of the applied Artifact from the referenced Source.", "description": "The last successfully applied revision.\nEquals the Revision of the applied Artifact from the referenced Source.",
"type": "string" "type": "string"
}, },
"lastAttemptedRevision": { "lastAttemptedRevision": {
@ -581,7 +581,7 @@
"type": "string" "type": "string"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {

207
minio.min.io/tenant_v2.json
View File

@ -3807,6 +3807,190 @@
"type": "object", "type": "object",
"additionalProperties": false "additionalProperties": false
}, },
"lifecycle": {
"properties": {
"postStart": {
"properties": {
"exec": {
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"httpGet": {
"properties": {
"host": {
"type": "string"
},
"httpHeaders": {
"items": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"x-kubernetes-int-or-string": true
},
"scheme": {
"type": "string"
}
},
"required": [
"port"
],
"type": "object",
"additionalProperties": false
},
"tcpSocket": {
"properties": {
"host": {
"type": "string"
},
"port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"x-kubernetes-int-or-string": true
}
},
"required": [
"port"
],
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"preStop": {
"properties": {
"exec": {
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
},
"httpGet": {
"properties": {
"host": {
"type": "string"
},
"httpHeaders": {
"items": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"path": {
"type": "string"
},
"port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"x-kubernetes-int-or-string": true
},
"scheme": {
"type": "string"
}
},
"required": [
"port"
],
"type": "object",
"additionalProperties": false
},
"tcpSocket": {
"properties": {
"host": {
"type": "string"
},
"port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"x-kubernetes-int-or-string": true
}
},
"required": [
"port"
],
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object",
"additionalProperties": false
},
"liveness": { "liveness": {
"properties": { "properties": {
"exec": { "exec": {
@ -4883,7 +5067,13 @@
}, },
"servers": { "servers": {
"format": "int32", "format": "int32",
"type": "integer" "type": "integer",
"x-kubernetes-validations": [
{
"message": "servers is immutable",
"rule": "self == oldSelf"
}
]
}, },
"tolerations": { "tolerations": {
"items": { "items": {
@ -5276,10 +5466,17 @@
}, },
"volumesPerServer": { "volumesPerServer": {
"format": "int32", "format": "int32",
"type": "integer" "type": "integer",
"x-kubernetes-validations": [
{
"message": "volumesPerServer is immutable",
"rule": "self == oldSelf"
}
]
} }
}, },
"required": [ "required": [
"name",
"servers", "servers",
"volumeClaimTemplate", "volumeClaimTemplate",
"volumesPerServer" "volumesPerServer"
@ -5287,7 +5484,11 @@
"type": "object", "type": "object",
"additionalProperties": false "additionalProperties": false
}, },
"type": "array" "type": "array",
"x-kubernetes-list-map-keys": [
"name"
],
"x-kubernetes-list-type": "map"
}, },
"priorityClassName": { "priorityClassName": {
"type": "string" "type": "string"

24
notification.toolkit.fluxcd.io/alert_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "Alert is the Schema for the alerts API", "description": "Alert is the Schema for the alerts API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -17,7 +17,7 @@
"properties": { "properties": {
"eventSeverity": { "eventSeverity": {
"default": "info", "default": "info",
"description": "Filter events based on severity, defaults to ('info'). If set to 'info' no events will be filtered.", "description": "Filter events based on severity, defaults to ('info').\nIf set to 'info' no events will be filtered.",
"enum": [ "enum": [
"info", "info",
"error" "error"
@ -27,7 +27,7 @@
"eventSources": { "eventSources": {
"description": "Filter events based on the involved objects.", "description": "Filter events based on the involved objects.",
"items": { "items": {
"description": "CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level", "description": "CrossNamespaceObjectReference contains enough information to let you locate the\ntyped referenced object at cluster level",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent", "description": "API version of the referent",
@ -53,7 +53,7 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
}, },
"name": { "name": {
@ -103,7 +103,7 @@
"type": "string" "type": "string"
}, },
"suspend": { "suspend": {
"description": "This flag tells the controller to suspend subsequent events dispatching. Defaults to false.", "description": "This flag tells the controller to suspend subsequent events dispatching.\nDefaults to false.",
"type": "boolean" "type": "boolean"
} }
}, },
@ -122,26 +122,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -157,7 +157,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"

36
notification.toolkit.fluxcd.io/alert_v1beta2.json
View File

@ -2,11 +2,11 @@
"description": "Alert is the Schema for the alerts API", "description": "Alert is the Schema for the alerts API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -19,12 +19,12 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed.", "description": "EventMetadata is an optional field for adding metadata to events dispatched by the\ncontroller. This can be used for enhancing the context of the event. If a field\nwould override one already present on the original event as generated by the emitter,\nthen the override doesn't happen, i.e. the original value is preserved, and an info\nlog is printed.",
"type": "object" "type": "object"
}, },
"eventSeverity": { "eventSeverity": {
"default": "info", "default": "info",
"description": "EventSeverity specifies how to filter events based on severity. If set to 'info' no events will be filtered.", "description": "EventSeverity specifies how to filter events based on severity.\nIf set to 'info' no events will be filtered.",
"enum": [ "enum": [
"info", "info",
"error" "error"
@ -32,9 +32,9 @@
"type": "string" "type": "string"
}, },
"eventSources": { "eventSources": {
"description": "EventSources specifies how to filter events based on the involved object kind, name and namespace.", "description": "EventSources specifies how to filter events based\non the involved object kind, name and namespace.",
"items": { "items": {
"description": "CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level", "description": "CrossNamespaceObjectReference contains enough information to let you locate the\ntyped referenced object at cluster level",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent", "description": "API version of the referent",
@ -60,11 +60,11 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed. MatchLabels requires the name to be set to `*`.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\nMatchLabels requires the name to be set to `*`.",
"type": "object" "type": "object"
}, },
"name": { "name": {
"description": "Name of the referent If multiple resources are targeted `*` may be set.", "description": "Name of the referent\nIf multiple resources are targeted `*` may be set.",
"maxLength": 53, "maxLength": 53,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -86,14 +86,14 @@
"type": "array" "type": "array"
}, },
"exclusionList": { "exclusionList": {
"description": "ExclusionList specifies a list of Golang regular expressions to be used for excluding messages.", "description": "ExclusionList specifies a list of Golang regular expressions\nto be used for excluding messages.",
"items": { "items": {
"type": "string" "type": "string"
}, },
"type": "array" "type": "array"
}, },
"inclusionList": { "inclusionList": {
"description": "InclusionList specifies a list of Golang regular expressions to be used for including messages.", "description": "InclusionList specifies a list of Golang regular expressions\nto be used for including messages.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -119,7 +119,7 @@
"type": "string" "type": "string"
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend subsequent events handling for this Alert.", "description": "Suspend tells the controller to suspend subsequent\nevents handling for this Alert.",
"type": "boolean" "type": "boolean"
} }
}, },
@ -139,26 +139,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the Alert.", "description": "Conditions holds the conditions for the Alert.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -174,7 +174,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -193,7 +193,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {

22
notification.toolkit.fluxcd.io/alert_v1beta3.json
View File

@ -2,11 +2,11 @@
"description": "Alert is the Schema for the alerts API", "description": "Alert is the Schema for the alerts API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -19,12 +19,12 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "EventMetadata is an optional field for adding metadata to events dispatched by the controller. This can be used for enhancing the context of the event. If a field would override one already present on the original event as generated by the emitter, then the override doesn't happen, i.e. the original value is preserved, and an info log is printed.", "description": "EventMetadata is an optional field for adding metadata to events dispatched by the\ncontroller. This can be used for enhancing the context of the event. If a field\nwould override one already present on the original event as generated by the emitter,\nthen the override doesn't happen, i.e. the original value is preserved, and an info\nlog is printed.",
"type": "object" "type": "object"
}, },
"eventSeverity": { "eventSeverity": {
"default": "info", "default": "info",
"description": "EventSeverity specifies how to filter events based on severity. If set to 'info' no events will be filtered.", "description": "EventSeverity specifies how to filter events based on severity.\nIf set to 'info' no events will be filtered.",
"enum": [ "enum": [
"info", "info",
"error" "error"
@ -32,9 +32,9 @@
"type": "string" "type": "string"
}, },
"eventSources": { "eventSources": {
"description": "EventSources specifies how to filter events based on the involved object kind, name and namespace.", "description": "EventSources specifies how to filter events based\non the involved object kind, name and namespace.",
"items": { "items": {
"description": "CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level", "description": "CrossNamespaceObjectReference contains enough information to let you locate the\ntyped referenced object at cluster level",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent", "description": "API version of the referent",
@ -60,11 +60,11 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed. MatchLabels requires the name to be set to `*`.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\nMatchLabels requires the name to be set to `*`.",
"type": "object" "type": "object"
}, },
"name": { "name": {
"description": "Name of the referent If multiple resources are targeted `*` may be set.", "description": "Name of the referent\nIf multiple resources are targeted `*` may be set.",
"maxLength": 53, "maxLength": 53,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -86,14 +86,14 @@
"type": "array" "type": "array"
}, },
"exclusionList": { "exclusionList": {
"description": "ExclusionList specifies a list of Golang regular expressions to be used for excluding messages.", "description": "ExclusionList specifies a list of Golang regular expressions\nto be used for excluding messages.",
"items": { "items": {
"type": "string" "type": "string"
}, },
"type": "array" "type": "array"
}, },
"inclusionList": { "inclusionList": {
"description": "InclusionList specifies a list of Golang regular expressions to be used for including messages.", "description": "InclusionList specifies a list of Golang regular expressions\nto be used for including messages.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -119,7 +119,7 @@
"type": "string" "type": "string"
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend subsequent events handling for this Alert.", "description": "Suspend tells the controller to suspend subsequent\nevents handling for this Alert.",
"type": "boolean" "type": "boolean"
} }
}, },

22
notification.toolkit.fluxcd.io/provider_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "Provider is the Schema for the providers API", "description": "Provider is the Schema for the providers API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -21,7 +21,7 @@
"type": "string" "type": "string"
}, },
"certSecretRef": { "certSecretRef": {
"description": "CertSecretRef can be given the name of a secret containing a PEM-encoded CA certificate (`caFile`)", "description": "CertSecretRef can be given the name of a secret containing\na PEM-encoded CA certificate (`caFile`)",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -44,7 +44,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "Secret reference containing the provider webhook URL using \"address\" as data key", "description": "Secret reference containing the provider webhook URL\nusing \"address\" as data key",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -58,7 +58,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "This flag tells the controller to suspend subsequent events handling. Defaults to false.", "description": "This flag tells the controller to suspend subsequent events handling.\nDefaults to false.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
@ -112,26 +112,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -147,7 +147,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"

26
notification.toolkit.fluxcd.io/provider_v1beta2.json
View File

@ -2,11 +2,11 @@
"description": "Provider is the Schema for the providers API.", "description": "Provider is the Schema for the providers API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,12 +16,12 @@
"description": "ProviderSpec defines the desired state of the Provider.", "description": "ProviderSpec defines the desired state of the Provider.",
"properties": { "properties": {
"address": { "address": {
"description": "Address specifies the endpoint, in a generic sense, to where alerts are sent. What kind of endpoint depends on the specific Provider type being used. For the generic Provider, for example, this is an HTTP/S address. For other Provider types this could be a project ID or a namespace.", "description": "Address specifies the endpoint, in a generic sense, to where alerts are sent.\nWhat kind of endpoint depends on the specific Provider type being used.\nFor the generic Provider, for example, this is an HTTP/S address.\nFor other Provider types this could be a project ID or a namespace.",
"maxLength": 2048, "maxLength": 2048,
"type": "string" "type": "string"
}, },
"certSecretRef": { "certSecretRef": {
"description": "CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the `ca.crt` key). \n Note: Support for the `caFile` key has been deprecated.", "description": "CertSecretRef specifies the Secret containing\na PEM-encoded CA certificate (in the `ca.crt` key).\n\n\nNote: Support for the `caFile` key has\nbeen deprecated.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -51,7 +51,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing the authentication credentials for this Provider.", "description": "SecretRef specifies the Secret containing the authentication\ncredentials for this Provider.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -65,7 +65,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend subsequent events handling for this Provider.", "description": "Suspend tells the controller to suspend subsequent\nevents handling for this Provider.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
@ -126,26 +126,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the Provider.", "description": "Conditions holds the conditions for the Provider.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -161,7 +161,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -180,7 +180,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {

14
notification.toolkit.fluxcd.io/provider_v1beta3.json
View File

@ -2,11 +2,11 @@
"description": "Provider is the Schema for the providers API", "description": "Provider is the Schema for the providers API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,12 +16,12 @@
"description": "ProviderSpec defines the desired state of the Provider.", "description": "ProviderSpec defines the desired state of the Provider.",
"properties": { "properties": {
"address": { "address": {
"description": "Address specifies the endpoint, in a generic sense, to where alerts are sent. What kind of endpoint depends on the specific Provider type being used. For the generic Provider, for example, this is an HTTP/S address. For other Provider types this could be a project ID or a namespace.", "description": "Address specifies the endpoint, in a generic sense, to where alerts are sent.\nWhat kind of endpoint depends on the specific Provider type being used.\nFor the generic Provider, for example, this is an HTTP/S address.\nFor other Provider types this could be a project ID or a namespace.",
"maxLength": 2048, "maxLength": 2048,
"type": "string" "type": "string"
}, },
"certSecretRef": { "certSecretRef": {
"description": "CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the `ca.crt` key). \n Note: Support for the `caFile` key has been deprecated.", "description": "CertSecretRef specifies the Secret containing\na PEM-encoded CA certificate (in the `ca.crt` key).\n\n\nNote: Support for the `caFile` key has\nbeen deprecated.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -40,7 +40,7 @@
"type": "string" "type": "string"
}, },
"interval": { "interval": {
"description": "Interval at which to reconcile the Provider with its Secret references. Deprecated and not used in v1beta3.", "description": "Interval at which to reconcile the Provider with its Secret references.\nDeprecated and not used in v1beta3.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
@ -51,7 +51,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing the authentication credentials for this Provider.", "description": "SecretRef specifies the Secret containing the authentication\ncredentials for this Provider.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -65,7 +65,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend subsequent events handling for this Provider.", "description": "Suspend tells the controller to suspend subsequent\nevents handling for this Provider.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {

37
notification.toolkit.fluxcd.io/receiver_v1.json
View File

@ -2,11 +2,11 @@
"description": "Receiver is the Schema for the receivers API.", "description": "Receiver is the Schema for the receivers API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,7 +16,7 @@
"description": "ReceiverSpec defines the desired state of the Receiver.", "description": "ReceiverSpec defines the desired state of the Receiver.",
"properties": { "properties": {
"events": { "events": {
"description": "Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.", "description": "Events specifies the list of event types to handle,\ne.g. 'push' for GitHub or 'Push Hook' for GitLab.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -31,7 +31,7 @@
"resources": { "resources": {
"description": "A list of resources to be notified about changes.", "description": "A list of resources to be notified about changes.",
"items": { "items": {
"description": "CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level", "description": "CrossNamespaceObjectReference contains enough information to let you locate the\ntyped referenced object at cluster level",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent", "description": "API version of the referent",
@ -57,11 +57,11 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed. MatchLabels requires the name to be set to `*`.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\nMatchLabels requires the name to be set to `*`.",
"type": "object" "type": "object"
}, },
"name": { "name": {
"description": "Name of the referent If multiple resources are targeted `*` may be set.", "description": "Name of the referent\nIf multiple resources are targeted `*` may be set.",
"maxLength": 53, "maxLength": 53,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -83,7 +83,7 @@
"type": "array" "type": "array"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing the token used to validate the payload authenticity.", "description": "SecretRef specifies the Secret containing the token used\nto validate the payload authenticity.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -97,11 +97,11 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend subsequent events handling for this receiver.", "description": "Suspend tells the controller to suspend subsequent\nevents handling for this receiver.",
"type": "boolean" "type": "boolean"
}, },
"type": { "type": {
"description": "Type of webhook sender, used to determine the validation procedure and payload deserialization.", "description": "Type of webhook sender, used to determine\nthe validation procedure and payload deserialization.",
"enum": [ "enum": [
"generic", "generic",
"generic-hmac", "generic-hmac",
@ -113,7 +113,8 @@
"quay", "quay",
"gcr", "gcr",
"nexus", "nexus",
"acr" "acr",
"cdevents"
], ],
"type": "string" "type": "string"
} }
@ -135,26 +136,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the Receiver.", "description": "Conditions holds the conditions for the Receiver.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -170,7 +171,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -189,7 +190,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
@ -198,7 +199,7 @@
"type": "integer" "type": "integer"
}, },
"webhookPath": { "webhookPath": {
"description": "WebhookPath is the generated incoming webhook address in the format of '/hook/sha256sum(token+name+namespace)'.", "description": "WebhookPath is the generated incoming webhook address in the format\nof '/hook/sha256sum(token+name+namespace)'.",
"type": "string" "type": "string"
} }
}, },

30
notification.toolkit.fluxcd.io/receiver_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "Receiver is the Schema for the receivers API", "description": "Receiver is the Schema for the receivers API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,7 +16,7 @@
"description": "ReceiverSpec defines the desired state of Receiver", "description": "ReceiverSpec defines the desired state of Receiver",
"properties": { "properties": {
"events": { "events": {
"description": "A list of events to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.", "description": "A list of events to handle,\ne.g. 'push' for GitHub or 'Push Hook' for GitLab.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -25,7 +25,7 @@
"resources": { "resources": {
"description": "A list of resources to be notified about changes.", "description": "A list of resources to be notified about changes.",
"items": { "items": {
"description": "CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level", "description": "CrossNamespaceObjectReference contains enough information to let you locate the\ntyped referenced object at cluster level",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent", "description": "API version of the referent",
@ -51,7 +51,7 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
}, },
"name": { "name": {
@ -76,7 +76,7 @@
"type": "array" "type": "array"
}, },
"secretRef": { "secretRef": {
"description": "Secret reference containing the token used to validate the payload authenticity", "description": "Secret reference containing the token used\nto validate the payload authenticity",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -90,11 +90,11 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "This flag tells the controller to suspend subsequent events handling. Defaults to false.", "description": "This flag tells the controller to suspend subsequent events handling.\nDefaults to false.",
"type": "boolean" "type": "boolean"
}, },
"type": { "type": {
"description": "Type of webhook sender, used to determine the validation procedure and payload deserialization.", "description": "Type of webhook sender, used to determine\nthe validation procedure and payload deserialization.",
"enum": [ "enum": [
"generic", "generic",
"generic-hmac", "generic-hmac",
@ -126,26 +126,26 @@
"properties": { "properties": {
"conditions": { "conditions": {
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -161,7 +161,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -185,7 +185,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "Generated webhook URL in the format of '/hook/sha256sum(token+name+namespace)'.", "description": "Generated webhook URL in the format\nof '/hook/sha256sum(token+name+namespace)'.",
"type": "string" "type": "string"
} }
}, },

36
notification.toolkit.fluxcd.io/receiver_v1beta2.json
View File

@ -2,11 +2,11 @@
"description": "Receiver is the Schema for the receivers API.", "description": "Receiver is the Schema for the receivers API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,7 +16,7 @@
"description": "ReceiverSpec defines the desired state of the Receiver.", "description": "ReceiverSpec defines the desired state of the Receiver.",
"properties": { "properties": {
"events": { "events": {
"description": "Events specifies the list of event types to handle, e.g. 'push' for GitHub or 'Push Hook' for GitLab.", "description": "Events specifies the list of event types to handle,\ne.g. 'push' for GitHub or 'Push Hook' for GitLab.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -30,7 +30,7 @@
"resources": { "resources": {
"description": "A list of resources to be notified about changes.", "description": "A list of resources to be notified about changes.",
"items": { "items": {
"description": "CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level", "description": "CrossNamespaceObjectReference contains enough information to let you locate the\ntyped referenced object at cluster level",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "API version of the referent", "description": "API version of the referent",
@ -56,11 +56,11 @@
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed. MatchLabels requires the name to be set to `*`.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.\nMatchLabels requires the name to be set to `*`.",
"type": "object" "type": "object"
}, },
"name": { "name": {
"description": "Name of the referent If multiple resources are targeted `*` may be set.", "description": "Name of the referent\nIf multiple resources are targeted `*` may be set.",
"maxLength": 53, "maxLength": 53,
"minLength": 1, "minLength": 1,
"type": "string" "type": "string"
@ -82,7 +82,7 @@
"type": "array" "type": "array"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing the token used to validate the payload authenticity.", "description": "SecretRef specifies the Secret containing the token used\nto validate the payload authenticity.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -96,11 +96,11 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend subsequent events handling for this receiver.", "description": "Suspend tells the controller to suspend subsequent\nevents handling for this receiver.",
"type": "boolean" "type": "boolean"
}, },
"type": { "type": {
"description": "Type of webhook sender, used to determine the validation procedure and payload deserialization.", "description": "Type of webhook sender, used to determine\nthe validation procedure and payload deserialization.",
"enum": [ "enum": [
"generic", "generic",
"generic-hmac", "generic-hmac",
@ -133,26 +133,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the Receiver.", "description": "Conditions holds the conditions for the Receiver.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -168,7 +168,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -187,7 +187,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
@ -196,11 +196,11 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the generated incoming webhook address in the format of '/hook/sha256sum(token+name+namespace)'. Deprecated: Replaced by WebhookPath.", "description": "URL is the generated incoming webhook address in the format\nof '/hook/sha256sum(token+name+namespace)'.\nDeprecated: Replaced by WebhookPath.",
"type": "string" "type": "string"
}, },
"webhookPath": { "webhookPath": {
"description": "WebhookPath is the generated incoming webhook address in the format of '/hook/sha256sum(token+name+namespace)'.", "description": "WebhookPath is the generated incoming webhook address in the format\nof '/hook/sha256sum(token+name+namespace)'.",
"type": "string" "type": "string"
} }
}, },

2
projectcalico.org/bgppeer_v3.json
View File

@ -43,7 +43,7 @@
"type": "string" "type": "string"
}, },
"numAllowedLocalASNumbers": { "numAllowedLocalASNumbers": {
"description": "Maximum number of local AS numbers that are allowed in the AS path for received routes. This removes BGP loop prevention and should only be used if absolutely necesssary.", "description": "Maximum number of local AS numbers that are allowed in the AS path for received routes. This removes BGP loop prevention and should only be used if absolutely necessary.",
"format": "int32", "format": "int32",
"type": "integer" "type": "integer"
}, },

20
projectcalico.org/felixconfiguration_v3.json
View File

@ -113,7 +113,7 @@
"type": "string" "type": "string"
}, },
"bpfKubeProxyEndpointSlicesEnabled": { "bpfKubeProxyEndpointSlicesEnabled": {
"description": "BPFKubeProxyEndpointSlicesEnabled in BPF mode, controls whether Felix's embedded kube-proxy accepts EndpointSlices or not.", "description": "BPFKubeProxyEndpointSlicesEnabled is deprecated and has no effect. BPF kube-proxy always accepts endpoint slices. This option will be removed in the next release.",
"type": "boolean" "type": "boolean"
}, },
"bpfKubeProxyIptablesCleanupEnabled": { "bpfKubeProxyIptablesCleanupEnabled": {
@ -201,13 +201,25 @@
"debugDisableLogDropping": { "debugDisableLogDropping": {
"type": "boolean" "type": "boolean"
}, },
"debugHost": {
"description": "DebugHost is the host IP or hostname to bind the debug port to. Only used if DebugPort is set. [Default:localhost]",
"type": "string"
},
"debugMemoryProfilePath": { "debugMemoryProfilePath": {
"type": "string" "type": "string"
}, },
"debugPort": {
"description": "DebugPort if set, enables Felix's debug HTTP port, which allows memory and CPU profiles to be retrieved. The debug port is not secure, it should not be exposed to the internet.",
"type": "integer"
},
"debugSimulateCalcGraphHangAfter": { "debugSimulateCalcGraphHangAfter": {
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$", "pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
"type": "string" "type": "string"
}, },
"debugSimulateDataplaneApplyDelay": {
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
"type": "string"
},
"debugSimulateDataplaneHangAfter": { "debugSimulateDataplaneHangAfter": {
"pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$", "pattern": "^([0-9]+(\\\\.[0-9]+)?(ms|s|m|h))*$",
"type": "string" "type": "string"
@ -239,6 +251,10 @@
"endpointReportingEnabled": { "endpointReportingEnabled": {
"type": "boolean" "type": "boolean"
}, },
"endpointStatusPathPrefix": {
"description": "EndpointStatusPathPrefix is the path to the directory where endpoint status will be written. Endpoint status file reporting is disabled if field is left empty. \n Chosen directory should match the directory used by the CNI for PodStartupDelay. [Default: \"\"]",
"type": "string"
},
"externalNodesList": { "externalNodesList": {
"description": "ExternalNodesCIDRList is a list of CIDR's of external-non-calico-nodes which may source tunnel traffic and have the tunneled traffic be accepted at calico nodes.", "description": "ExternalNodesCIDRList is a list of CIDR's of external-non-calico-nodes which may source tunnel traffic and have the tunneled traffic be accepted at calico nodes.",
"items": { "items": {
@ -472,7 +488,7 @@
"type": "integer" "type": "integer"
}, },
"metadataAddr": { "metadataAddr": {
"description": "MetadataAddr is the IP address or domain name of the server that can answer VM queries for cloud-init metadata. In OpenStack, this corresponds to the machine running nova-api (or in Ubuntu, nova-api-metadata). A value of none (case insensitive) means that Felix should not set up any NAT rule for the metadata path. [Default: 127.0.0.1]", "description": "MetadataAddr is the IP address or domain name of the server that can answer VM queries for cloud-init metadata. In OpenStack, this corresponds to the machine running nova-api (or in Ubuntu, nova-api-metadata). A value of none (case-insensitive) means that Felix should not set up any NAT rule for the metadata path. [Default: 127.0.0.1]",
"type": "string" "type": "string"
}, },
"metadataPort": { "metadataPort": {

2
projectcalico.org/globalnetworkpolicy_v3.json
View File

@ -677,7 +677,7 @@
"type": "boolean" "type": "boolean"
}, },
"selector": { "selector": {
"description": "The selector is an expression used to pick pick out the endpoints that the policy should be applied to. \n Selector expressions follow this syntax: \n \tlabel == \"string_literal\" -> comparison, e.g. my_label == \"foo bar\" \tlabel != \"string_literal\" -> not equal; also matches if label is not present \tlabel in { \"a\", \"b\", \"c\", ... } -> true if the value of label X is one of \"a\", \"b\", \"c\" \tlabel not in { \"a\", \"b\", \"c\", ... } -> true if the value of label X is not one of \"a\", \"b\", \"c\" \thas(label_name) -> True if that label is present \t! expr -> negation of expr \texpr && expr -> Short-circuit and \texpr || expr -> Short-circuit or \t( expr ) -> parens for grouping \tall() or the empty selector -> matches all endpoints. \n Label names are allowed to contain alphanumerics, -, _ and /. String literals are more permissive but they do not support escape characters. \n Examples (with made-up labels): \n \ttype == \"webserver\" && deployment == \"prod\" \ttype in {\"frontend\", \"backend\"} \tdeployment != \"dev\" \t! has(label_name)", "description": "The selector is an expression used to pick out the endpoints that the policy should be applied to. \n Selector expressions follow this syntax: \n \tlabel == \"string_literal\" -> comparison, e.g. my_label == \"foo bar\" \tlabel != \"string_literal\" -> not equal; also matches if label is not present \tlabel in { \"a\", \"b\", \"c\", ... } -> true if the value of label X is one of \"a\", \"b\", \"c\" \tlabel not in { \"a\", \"b\", \"c\", ... } -> true if the value of label X is not one of \"a\", \"b\", \"c\" \thas(label_name) -> True if that label is present \t! expr -> negation of expr \texpr && expr -> Short-circuit and \texpr || expr -> Short-circuit or \t( expr ) -> parens for grouping \tall() or the empty selector -> matches all endpoints. \n Label names are allowed to contain alphanumerics, -, _ and /. String literals are more permissive but they do not support escape characters. \n Examples (with made-up labels): \n \ttype == \"webserver\" && deployment == \"prod\" \ttype in {\"frontend\", \"backend\"} \tdeployment != \"dev\" \t! has(label_name)",
"type": "string" "type": "string"
}, },
"serviceAccountSelector": { "serviceAccountSelector": {

2
projectcalico.org/networkpolicy_v3.json
View File

@ -661,7 +661,7 @@
"type": "array" "type": "array"
}, },
"selector": { "selector": {
"description": "The selector is an expression used to pick pick out the endpoints that the policy should be applied to. \n Selector expressions follow this syntax: \n \tlabel == \"string_literal\" -> comparison, e.g. my_label == \"foo bar\" \tlabel != \"string_literal\" -> not equal; also matches if label is not present \tlabel in { \"a\", \"b\", \"c\", ... } -> true if the value of label X is one of \"a\", \"b\", \"c\" \tlabel not in { \"a\", \"b\", \"c\", ... } -> true if the value of label X is not one of \"a\", \"b\", \"c\" \thas(label_name) -> True if that label is present \t! expr -> negation of expr \texpr && expr -> Short-circuit and \texpr || expr -> Short-circuit or \t( expr ) -> parens for grouping \tall() or the empty selector -> matches all endpoints. \n Label names are allowed to contain alphanumerics, -, _ and /. String literals are more permissive but they do not support escape characters. \n Examples (with made-up labels): \n \ttype == \"webserver\" && deployment == \"prod\" \ttype in {\"frontend\", \"backend\"} \tdeployment != \"dev\" \t! has(label_name)", "description": "The selector is an expression used to pick out the endpoints that the policy should be applied to. \n Selector expressions follow this syntax: \n \tlabel == \"string_literal\" -> comparison, e.g. my_label == \"foo bar\" \tlabel != \"string_literal\" -> not equal; also matches if label is not present \tlabel in { \"a\", \"b\", \"c\", ... } -> true if the value of label X is one of \"a\", \"b\", \"c\" \tlabel not in { \"a\", \"b\", \"c\", ... } -> true if the value of label X is not one of \"a\", \"b\", \"c\" \thas(label_name) -> True if that label is present \t! expr -> negation of expr \texpr && expr -> Short-circuit and \texpr || expr -> Short-circuit or \t( expr ) -> parens for grouping \tall() or the empty selector -> matches all endpoints. \n Label names are allowed to contain alphanumerics, -, _ and /. String literals are more permissive but they do not support escape characters. \n Examples (with made-up labels): \n \ttype == \"webserver\" && deployment == \"prod\" \ttype in {\"frontend\", \"backend\"} \tdeployment != \"dev\" \t! has(label_name)",
"type": "string" "type": "string"
}, },
"serviceAccountSelector": { "serviceAccountSelector": {

6
source.toolkit.fluxcd.io/all-anyOf.json
View File

@ -15,12 +15,18 @@
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/gitrepository_v1beta2.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/gitrepository_v1beta2.json"
}, },
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1.json"
},
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1beta1.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1beta1.json"
}, },
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1beta2.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1beta2.json"
}, },
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmrepository_v1.json"
},
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmrepository_v1beta1.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmrepository_v1beta1.json"
}, },

6
source.toolkit.fluxcd.io/all-oneOf.json
View File

@ -15,12 +15,18 @@
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/gitrepository_v1beta2.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/gitrepository_v1beta2.json"
}, },
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1.json"
},
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1beta1.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1beta1.json"
}, },
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1beta2.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmchart_v1beta2.json"
}, },
{
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmrepository_v1.json"
},
{ {
"$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmrepository_v1beta1.json" "$ref": "https://gitea.rknet.org/infra/crds-catalog/raw/branch/catalog/source.toolkit.fluxcd.io/helmrepository_v1beta1.json"
}, },

32
source.toolkit.fluxcd.io/bucket_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "Bucket is the Schema for the buckets API", "description": "Bucket is the Schema for the buckets API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -19,15 +19,15 @@
"description": "AccessFrom defines an Access Control List for allowing cross-namespace references to this object.", "description": "AccessFrom defines an Access Control List for allowing cross-namespace references to this object.",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -52,7 +52,7 @@
"type": "string" "type": "string"
}, },
"ignore": { "ignore": {
"description": "Ignore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore). If not provided, a default will be used, consult the documentation for your version to find out what those are.", "description": "Ignore overrides the set of excluded patterns in the .sourceignore format\n(which is the same as .gitignore). If not provided, a default will be used,\nconsult the documentation for your version to find out what those are.",
"type": "string" "type": "string"
}, },
"insecure": { "insecure": {
@ -78,7 +78,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "The name of the secret containing authentication credentials for the Bucket.", "description": "The name of the secret containing authentication credentials\nfor the Bucket.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -123,7 +123,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of this artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of this\nartifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -132,7 +132,7 @@
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm chart version, etc.", "description": "Revision is a human readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm\nchart version, etc.",
"type": "string" "type": "string"
}, },
"url": { "url": {
@ -150,26 +150,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the Bucket.", "description": "Conditions holds the conditions for the Bucket.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -185,7 +185,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -204,7 +204,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {

50
source.toolkit.fluxcd.io/bucket_v1beta2.json
View File

@ -2,32 +2,32 @@
"description": "Bucket is the Schema for the buckets API.", "description": "Bucket is the Schema for the buckets API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "BucketSpec specifies the required configuration to produce an Artifact for an object storage bucket.", "description": "BucketSpec specifies the required configuration to produce an Artifact for\nan object storage bucket.",
"properties": { "properties": {
"accessFrom": { "accessFrom": {
"description": "AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092", "description": "AccessFrom specifies an Access Control List for allowing cross-namespace\nreferences to this object.\nNOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -52,7 +52,7 @@
"type": "string" "type": "string"
}, },
"ignore": { "ignore": {
"description": "Ignore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore). If not provided, a default will be used, consult the documentation for your version to find out what those are.", "description": "Ignore overrides the set of excluded patterns in the .sourceignore format\n(which is the same as .gitignore). If not provided, a default will be used,\nconsult the documentation for your version to find out what those are.",
"type": "string" "type": "string"
}, },
"insecure": { "insecure": {
@ -60,7 +60,7 @@
"type": "boolean" "type": "boolean"
}, },
"interval": { "interval": {
"description": "Interval at which the Bucket Endpoint is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources.", "description": "Interval at which the Bucket Endpoint is checked for updates.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
@ -70,7 +70,7 @@
}, },
"provider": { "provider": {
"default": "generic", "default": "generic",
"description": "Provider of the object storage bucket. Defaults to 'generic', which expects an S3 (API) compatible object storage.", "description": "Provider of the object storage bucket.\nDefaults to 'generic', which expects an S3 (API) compatible object\nstorage.",
"enum": [ "enum": [
"generic", "generic",
"aws", "aws",
@ -84,7 +84,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing authentication credentials for the Bucket.", "description": "SecretRef specifies the Secret containing authentication credentials\nfor the Bucket.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -98,7 +98,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend the reconciliation of this Bucket.", "description": "Suspend tells the controller to suspend the reconciliation of this\nBucket.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
@ -131,7 +131,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the Artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -143,11 +143,11 @@
"type": "object" "type": "object"
}, },
"path": { "path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.", "description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.", "description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string" "type": "string"
}, },
"size": { "size": {
@ -156,7 +156,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.", "description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string" "type": "string"
} }
}, },
@ -172,26 +172,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the Bucket.", "description": "Conditions holds the conditions for the Bucket.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -207,7 +207,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -226,7 +226,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
@ -235,11 +235,11 @@
"type": "integer" "type": "integer"
}, },
"observedIgnore": { "observedIgnore": {
"description": "ObservedIgnore is the observed exclusion patterns used for constructing the source artifact.", "description": "ObservedIgnore is the observed exclusion patterns used for constructing\nthe source artifact.",
"type": "string" "type": "string"
}, },
"url": { "url": {
"description": "URL is the dynamic fetch link for the latest Artifact. It is provided on a \"best effort\" basis, and using the precise BucketStatus.Artifact data is recommended.", "description": "URL is the dynamic fetch link for the latest Artifact.\nIt is provided on a \"best effort\" basis, and using the precise\nBucketStatus.Artifact data is recommended.",
"type": "string" "type": "string"
} }
}, },

90
source.toolkit.fluxcd.io/gitrepository_v1.json
View File

@ -2,34 +2,34 @@
"description": "GitRepository is the Schema for the gitrepositories API.", "description": "GitRepository is the Schema for the gitrepositories API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "GitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository.", "description": "GitRepositorySpec specifies the required configuration to produce an\nArtifact for a Git repository.",
"properties": { "properties": {
"ignore": { "ignore": {
"description": "Ignore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore). If not provided, a default will be used, consult the documentation for your version to find out what those are.", "description": "Ignore overrides the set of excluded patterns in the .sourceignore format\n(which is the same as .gitignore). If not provided, a default will be used,\nconsult the documentation for your version to find out what those are.",
"type": "string" "type": "string"
}, },
"include": { "include": {
"description": "Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository.", "description": "Include specifies a list of GitRepository resources which Artifacts\nshould be included in the Artifact produced for this GitRepository.",
"items": { "items": {
"description": "GitRepositoryInclude specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.", "description": "GitRepositoryInclude specifies a local reference to a GitRepository which\nArtifact (sub-)contents must be included, and where they should be placed.",
"properties": { "properties": {
"fromPath": { "fromPath": {
"description": "FromPath specifies the path to copy contents from, defaults to the root of the Artifact.", "description": "FromPath specifies the path to copy contents from, defaults to the root\nof the Artifact.",
"type": "string" "type": "string"
}, },
"repository": { "repository": {
"description": "GitRepositoryRef specifies the GitRepository which Artifact contents must be included.", "description": "GitRepositoryRef specifies the GitRepository which Artifact contents\nmust be included.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -43,7 +43,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"toPath": { "toPath": {
"description": "ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef.", "description": "ToPath specifies the path to copy contents to, defaults to the name of\nthe GitRepositoryRef.",
"type": "string" "type": "string"
} }
}, },
@ -56,12 +56,12 @@
"type": "array" "type": "array"
}, },
"interval": { "interval": {
"description": "Interval at which the GitRepository URL is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources.", "description": "Interval at which the GitRepository URL is checked for updates.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"proxySecretRef": { "proxySecretRef": {
"description": "ProxySecretRef specifies the Secret containing the proxy configuration to use while communicating with the Git server.", "description": "ProxySecretRef specifies the Secret containing the proxy configuration\nto use while communicating with the Git server.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -75,22 +75,22 @@
"additionalProperties": false "additionalProperties": false
}, },
"recurseSubmodules": { "recurseSubmodules": {
"description": "RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings.", "description": "RecurseSubmodules enables the initialization of all submodules within\nthe GitRepository as cloned from the URL, using their default settings.",
"type": "boolean" "type": "boolean"
}, },
"ref": { "ref": {
"description": "Reference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch.", "description": "Reference specifies the Git reference to resolve and monitor for\nchanges, defaults to the 'master' branch.",
"properties": { "properties": {
"branch": { "branch": {
"description": "Branch to check out, defaults to 'master' if no other field is defined.", "description": "Branch to check out, defaults to 'master' if no other field is defined.",
"type": "string" "type": "string"
}, },
"commit": { "commit": {
"description": "Commit SHA to check out, takes precedence over all reference fields. \n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist.", "description": "Commit SHA to check out, takes precedence over all reference fields.\n\n\nThis can be combined with Branch to shallow clone the branch, in which\nthe commit is expected to exist.",
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\"", "description": "Name of the reference to check out; takes precedence over Branch, Tag and SemVer.\n\n\nIt must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description\nExamples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\"",
"type": "string" "type": "string"
}, },
"semver": { "semver": {
@ -106,7 +106,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing authentication credentials for the GitRepository. For HTTPS repositories the Secret must contain 'username' and 'password' fields for basic auth or 'bearerToken' field for token auth. For SSH repositories the Secret must contain 'identity' and 'known_hosts' fields.", "description": "SecretRef specifies the Secret containing authentication credentials for\nthe GitRepository.\nFor HTTPS repositories the Secret must contain 'username' and 'password'\nfields for basic auth or 'bearerToken' field for token auth.\nFor SSH repositories the Secret must contain 'identity'\nand 'known_hosts' fields.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -120,7 +120,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend the reconciliation of this GitRepository.", "description": "Suspend tells the controller to suspend the reconciliation of this\nGitRepository.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
@ -135,11 +135,11 @@
"type": "string" "type": "string"
}, },
"verify": { "verify": {
"description": "Verification specifies the configuration to verify the Git commit signature(s).", "description": "Verification specifies the configuration to verify the Git commit\nsignature(s).",
"properties": { "properties": {
"mode": { "mode": {
"default": "HEAD", "default": "HEAD",
"description": "Mode specifies which Git object(s) should be verified. \n The variants \"head\" and \"HEAD\" both imply the same thing, i.e. verify the commit that the HEAD of the Git repository points to. The variant \"head\" solely exists to ensure backwards compatibility.", "description": "Mode specifies which Git object(s) should be verified.\n\n\nThe variants \"head\" and \"HEAD\" both imply the same thing, i.e. verify\nthe commit that the HEAD of the Git repository points to. The variant\n\"head\" solely exists to ensure backwards compatibility.",
"enum": [ "enum": [
"head", "head",
"HEAD", "HEAD",
@ -149,7 +149,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing the public keys of trusted Git authors.", "description": "SecretRef specifies the Secret containing the public keys of trusted Git\nauthors.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -192,7 +192,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the Artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -204,11 +204,11 @@
"type": "object" "type": "object"
}, },
"path": { "path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.", "description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.", "description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string" "type": "string"
}, },
"size": { "size": {
@ -217,7 +217,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.", "description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string" "type": "string"
} }
}, },
@ -233,26 +233,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the GitRepository.", "description": "Conditions holds the conditions for the GitRepository.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -268,7 +268,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -287,7 +287,7 @@
"type": "array" "type": "array"
}, },
"includedArtifacts": { "includedArtifacts": {
"description": "IncludedArtifacts contains a list of the last successfully included Artifacts as instructed by GitRepositorySpec.Include.", "description": "IncludedArtifacts contains a list of the last successfully included\nArtifacts as instructed by GitRepositorySpec.Include.",
"items": { "items": {
"description": "Artifact represents the output of a Source reconciliation.", "description": "Artifact represents the output of a Source reconciliation.",
"properties": { "properties": {
@ -297,7 +297,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the Artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -309,11 +309,11 @@
"type": "object" "type": "object"
}, },
"path": { "path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.", "description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.", "description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string" "type": "string"
}, },
"size": { "size": {
@ -322,7 +322,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.", "description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string" "type": "string"
} }
}, },
@ -338,29 +338,29 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "ObservedGeneration is the last observed generation of the GitRepository object.", "description": "ObservedGeneration is the last observed generation of the GitRepository\nobject.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"observedIgnore": { "observedIgnore": {
"description": "ObservedIgnore is the observed exclusion patterns used for constructing the source artifact.", "description": "ObservedIgnore is the observed exclusion patterns used for constructing\nthe source artifact.",
"type": "string" "type": "string"
}, },
"observedInclude": { "observedInclude": {
"description": "ObservedInclude is the observed list of GitRepository resources used to produce the current Artifact.", "description": "ObservedInclude is the observed list of GitRepository resources used to\nproduce the current Artifact.",
"items": { "items": {
"description": "GitRepositoryInclude specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.", "description": "GitRepositoryInclude specifies a local reference to a GitRepository which\nArtifact (sub-)contents must be included, and where they should be placed.",
"properties": { "properties": {
"fromPath": { "fromPath": {
"description": "FromPath specifies the path to copy contents from, defaults to the root of the Artifact.", "description": "FromPath specifies the path to copy contents from, defaults to the root\nof the Artifact.",
"type": "string" "type": "string"
}, },
"repository": { "repository": {
"description": "GitRepositoryRef specifies the GitRepository which Artifact contents must be included.", "description": "GitRepositoryRef specifies the GitRepository which Artifact contents\nmust be included.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -374,7 +374,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"toPath": { "toPath": {
"description": "ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef.", "description": "ToPath specifies the path to copy contents to, defaults to the name of\nthe GitRepositoryRef.",
"type": "string" "type": "string"
} }
}, },
@ -387,11 +387,11 @@
"type": "array" "type": "array"
}, },
"observedRecurseSubmodules": { "observedRecurseSubmodules": {
"description": "ObservedRecurseSubmodules is the observed resource submodules configuration used to produce the current Artifact.", "description": "ObservedRecurseSubmodules is the observed resource submodules\nconfiguration used to produce the current Artifact.",
"type": "boolean" "type": "boolean"
}, },
"sourceVerificationMode": { "sourceVerificationMode": {
"description": "SourceVerificationMode is the last used verification mode indicating which Git object(s) have been verified.", "description": "SourceVerificationMode is the last used verification mode indicating\nwhich Git object(s) have been verified.",
"type": "string" "type": "string"
} }
}, },

44
source.toolkit.fluxcd.io/gitrepository_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "GitRepository is the Schema for the gitrepositories API", "description": "GitRepository is the Schema for the gitrepositories API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -19,15 +19,15 @@
"description": "AccessFrom defines an Access Control List for allowing cross-namespace references to this object.", "description": "AccessFrom defines an Access Control List for allowing cross-namespace references to this object.",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -45,7 +45,7 @@
}, },
"gitImplementation": { "gitImplementation": {
"default": "go-git", "default": "go-git",
"description": "Determines which git client library to use. Defaults to go-git, valid values are ('go-git', 'libgit2').", "description": "Determines which git client library to use.\nDefaults to go-git, valid values are ('go-git', 'libgit2').",
"enum": [ "enum": [
"go-git", "go-git",
"libgit2" "libgit2"
@ -53,7 +53,7 @@
"type": "string" "type": "string"
}, },
"ignore": { "ignore": {
"description": "Ignore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore). If not provided, a default will be used, consult the documentation for your version to find out what those are.", "description": "Ignore overrides the set of excluded patterns in the .sourceignore format\n(which is the same as .gitignore). If not provided, a default will be used,\nconsult the documentation for your version to find out what those are.",
"type": "string" "type": "string"
}, },
"include": { "include": {
@ -97,11 +97,11 @@
"type": "string" "type": "string"
}, },
"recurseSubmodules": { "recurseSubmodules": {
"description": "When enabled, after the clone is created, initializes all submodules within, using their default settings. This option is available only when using the 'go-git' GitImplementation.", "description": "When enabled, after the clone is created, initializes all submodules within,\nusing their default settings.\nThis option is available only when using the 'go-git' GitImplementation.",
"type": "boolean" "type": "boolean"
}, },
"ref": { "ref": {
"description": "The Git reference to checkout and monitor for changes, defaults to master branch.", "description": "The Git reference to checkout and monitor for changes, defaults to\nmaster branch.",
"properties": { "properties": {
"branch": { "branch": {
"description": "The Git branch to checkout, defaults to master.", "description": "The Git branch to checkout, defaults to master.",
@ -124,7 +124,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"secretRef": { "secretRef": {
"description": "The secret name containing the Git credentials. For HTTPS repositories the secret must contain username and password fields. For SSH repositories the secret must contain identity and known_hosts fields.", "description": "The secret name containing the Git credentials.\nFor HTTPS repositories the secret must contain username and password\nfields.\nFor SSH repositories the secret must contain identity and known_hosts\nfields.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -204,7 +204,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of this artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of this\nartifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -213,7 +213,7 @@
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm chart version, etc.", "description": "Revision is a human readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm\nchart version, etc.",
"type": "string" "type": "string"
}, },
"url": { "url": {
@ -231,26 +231,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the GitRepository.", "description": "Conditions holds the conditions for the GitRepository.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -266,7 +266,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -294,7 +294,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of this artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of this\nartifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -303,7 +303,7 @@
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm chart version, etc.", "description": "Revision is a human readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm\nchart version, etc.",
"type": "string" "type": "string"
}, },
"url": { "url": {
@ -321,7 +321,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
@ -330,7 +330,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the download link for the artifact output of the last repository sync.", "description": "URL is the download link for the artifact output of the last repository\nsync.",
"type": "string" "type": "string"
} }
}, },

96
source.toolkit.fluxcd.io/gitrepository_v1beta2.json
View File

@ -2,32 +2,32 @@
"description": "GitRepository is the Schema for the gitrepositories API.", "description": "GitRepository is the Schema for the gitrepositories API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "GitRepositorySpec specifies the required configuration to produce an Artifact for a Git repository.", "description": "GitRepositorySpec specifies the required configuration to produce an\nArtifact for a Git repository.",
"properties": { "properties": {
"accessFrom": { "accessFrom": {
"description": "AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092", "description": "AccessFrom specifies an Access Control List for allowing cross-namespace\nreferences to this object.\nNOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -45,7 +45,7 @@
}, },
"gitImplementation": { "gitImplementation": {
"default": "go-git", "default": "go-git",
"description": "GitImplementation specifies which Git client library implementation to use. Defaults to 'go-git', valid values are ('go-git', 'libgit2'). Deprecated: gitImplementation is deprecated now that 'go-git' is the only supported implementation.", "description": "GitImplementation specifies which Git client library implementation to\nuse. Defaults to 'go-git', valid values are ('go-git', 'libgit2').\nDeprecated: gitImplementation is deprecated now that 'go-git' is the\nonly supported implementation.",
"enum": [ "enum": [
"go-git", "go-git",
"libgit2" "libgit2"
@ -53,20 +53,20 @@
"type": "string" "type": "string"
}, },
"ignore": { "ignore": {
"description": "Ignore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore). If not provided, a default will be used, consult the documentation for your version to find out what those are.", "description": "Ignore overrides the set of excluded patterns in the .sourceignore format\n(which is the same as .gitignore). If not provided, a default will be used,\nconsult the documentation for your version to find out what those are.",
"type": "string" "type": "string"
}, },
"include": { "include": {
"description": "Include specifies a list of GitRepository resources which Artifacts should be included in the Artifact produced for this GitRepository.", "description": "Include specifies a list of GitRepository resources which Artifacts\nshould be included in the Artifact produced for this GitRepository.",
"items": { "items": {
"description": "GitRepositoryInclude specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.", "description": "GitRepositoryInclude specifies a local reference to a GitRepository which\nArtifact (sub-)contents must be included, and where they should be placed.",
"properties": { "properties": {
"fromPath": { "fromPath": {
"description": "FromPath specifies the path to copy contents from, defaults to the root of the Artifact.", "description": "FromPath specifies the path to copy contents from, defaults to the root\nof the Artifact.",
"type": "string" "type": "string"
}, },
"repository": { "repository": {
"description": "GitRepositoryRef specifies the GitRepository which Artifact contents must be included.", "description": "GitRepositoryRef specifies the GitRepository which Artifact contents\nmust be included.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -80,7 +80,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"toPath": { "toPath": {
"description": "ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef.", "description": "ToPath specifies the path to copy contents to, defaults to the name of\nthe GitRepositoryRef.",
"type": "string" "type": "string"
} }
}, },
@ -98,22 +98,22 @@
"type": "string" "type": "string"
}, },
"recurseSubmodules": { "recurseSubmodules": {
"description": "RecurseSubmodules enables the initialization of all submodules within the GitRepository as cloned from the URL, using their default settings.", "description": "RecurseSubmodules enables the initialization of all submodules within\nthe GitRepository as cloned from the URL, using their default settings.",
"type": "boolean" "type": "boolean"
}, },
"ref": { "ref": {
"description": "Reference specifies the Git reference to resolve and monitor for changes, defaults to the 'master' branch.", "description": "Reference specifies the Git reference to resolve and monitor for\nchanges, defaults to the 'master' branch.",
"properties": { "properties": {
"branch": { "branch": {
"description": "Branch to check out, defaults to 'master' if no other field is defined.", "description": "Branch to check out, defaults to 'master' if no other field is defined.",
"type": "string" "type": "string"
}, },
"commit": { "commit": {
"description": "Commit SHA to check out, takes precedence over all reference fields. \n This can be combined with Branch to shallow clone the branch, in which the commit is expected to exist.", "description": "Commit SHA to check out, takes precedence over all reference fields.\n\n\nThis can be combined with Branch to shallow clone the branch, in which\nthe commit is expected to exist.",
"type": "string" "type": "string"
}, },
"name": { "name": {
"description": "Name of the reference to check out; takes precedence over Branch, Tag and SemVer. \n It must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description Examples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\"", "description": "Name of the reference to check out; takes precedence over Branch, Tag and SemVer.\n\n\nIt must be a valid Git reference: https://git-scm.com/docs/git-check-ref-format#_description\nExamples: \"refs/heads/main\", \"refs/tags/v0.1.0\", \"refs/pull/420/head\", \"refs/merge-requests/1/head\"",
"type": "string" "type": "string"
}, },
"semver": { "semver": {
@ -129,7 +129,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing authentication credentials for the GitRepository. For HTTPS repositories the Secret must contain 'username' and 'password' fields for basic auth or 'bearerToken' field for token auth. For SSH repositories the Secret must contain 'identity' and 'known_hosts' fields.", "description": "SecretRef specifies the Secret containing authentication credentials for\nthe GitRepository.\nFor HTTPS repositories the Secret must contain 'username' and 'password'\nfields for basic auth or 'bearerToken' field for token auth.\nFor SSH repositories the Secret must contain 'identity'\nand 'known_hosts' fields.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -143,7 +143,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend the reconciliation of this GitRepository.", "description": "Suspend tells the controller to suspend the reconciliation of this\nGitRepository.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
@ -158,7 +158,7 @@
"type": "string" "type": "string"
}, },
"verify": { "verify": {
"description": "Verification specifies the configuration to verify the Git commit signature(s).", "description": "Verification specifies the configuration to verify the Git commit\nsignature(s).",
"properties": { "properties": {
"mode": { "mode": {
"description": "Mode specifies what Git object should be verified, currently ('head').", "description": "Mode specifies what Git object should be verified, currently ('head').",
@ -168,7 +168,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing the public keys of trusted Git authors.", "description": "SecretRef specifies the Secret containing the public keys of trusted Git\nauthors.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -212,7 +212,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the Artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -224,11 +224,11 @@
"type": "object" "type": "object"
}, },
"path": { "path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.", "description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.", "description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string" "type": "string"
}, },
"size": { "size": {
@ -237,7 +237,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.", "description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string" "type": "string"
} }
}, },
@ -253,26 +253,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the GitRepository.", "description": "Conditions holds the conditions for the GitRepository.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -288,7 +288,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -307,11 +307,11 @@
"type": "array" "type": "array"
}, },
"contentConfigChecksum": { "contentConfigChecksum": {
"description": "ContentConfigChecksum is a checksum of all the configurations related to the content of the source artifact: - .spec.ignore - .spec.recurseSubmodules - .spec.included and the checksum of the included artifacts observed in .status.observedGeneration version of the object. This can be used to determine if the content of the included repository has changed. It has the format of `<algo>:<checksum>`, for example: `sha256:<checksum>`. \n Deprecated: Replaced with explicit fields for observed artifact content config in the status.", "description": "ContentConfigChecksum is a checksum of all the configurations related to\nthe content of the source artifact:\n - .spec.ignore\n - .spec.recurseSubmodules\n - .spec.included and the checksum of the included artifacts\nobserved in .status.observedGeneration version of the object. This can\nbe used to determine if the content of the included repository has\nchanged.\nIt has the format of `<algo>:<checksum>`, for example: `sha256:<checksum>`.\n\n\nDeprecated: Replaced with explicit fields for observed artifact content\nconfig in the status.",
"type": "string" "type": "string"
}, },
"includedArtifacts": { "includedArtifacts": {
"description": "IncludedArtifacts contains a list of the last successfully included Artifacts as instructed by GitRepositorySpec.Include.", "description": "IncludedArtifacts contains a list of the last successfully included\nArtifacts as instructed by GitRepositorySpec.Include.",
"items": { "items": {
"description": "Artifact represents the output of a Source reconciliation.", "description": "Artifact represents the output of a Source reconciliation.",
"properties": { "properties": {
@ -321,7 +321,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the Artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -333,11 +333,11 @@
"type": "object" "type": "object"
}, },
"path": { "path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.", "description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.", "description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string" "type": "string"
}, },
"size": { "size": {
@ -346,7 +346,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.", "description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string" "type": "string"
} }
}, },
@ -362,29 +362,29 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "ObservedGeneration is the last observed generation of the GitRepository object.", "description": "ObservedGeneration is the last observed generation of the GitRepository\nobject.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"observedIgnore": { "observedIgnore": {
"description": "ObservedIgnore is the observed exclusion patterns used for constructing the source artifact.", "description": "ObservedIgnore is the observed exclusion patterns used for constructing\nthe source artifact.",
"type": "string" "type": "string"
}, },
"observedInclude": { "observedInclude": {
"description": "ObservedInclude is the observed list of GitRepository resources used to to produce the current Artifact.", "description": "ObservedInclude is the observed list of GitRepository resources used to\nto produce the current Artifact.",
"items": { "items": {
"description": "GitRepositoryInclude specifies a local reference to a GitRepository which Artifact (sub-)contents must be included, and where they should be placed.", "description": "GitRepositoryInclude specifies a local reference to a GitRepository which\nArtifact (sub-)contents must be included, and where they should be placed.",
"properties": { "properties": {
"fromPath": { "fromPath": {
"description": "FromPath specifies the path to copy contents from, defaults to the root of the Artifact.", "description": "FromPath specifies the path to copy contents from, defaults to the root\nof the Artifact.",
"type": "string" "type": "string"
}, },
"repository": { "repository": {
"description": "GitRepositoryRef specifies the GitRepository which Artifact contents must be included.", "description": "GitRepositoryRef specifies the GitRepository which Artifact contents\nmust be included.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -398,7 +398,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"toPath": { "toPath": {
"description": "ToPath specifies the path to copy contents to, defaults to the name of the GitRepositoryRef.", "description": "ToPath specifies the path to copy contents to, defaults to the name of\nthe GitRepositoryRef.",
"type": "string" "type": "string"
} }
}, },
@ -411,11 +411,11 @@
"type": "array" "type": "array"
}, },
"observedRecurseSubmodules": { "observedRecurseSubmodules": {
"description": "ObservedRecurseSubmodules is the observed resource submodules configuration used to produce the current Artifact.", "description": "ObservedRecurseSubmodules is the observed resource submodules\nconfiguration used to produce the current Artifact.",
"type": "boolean" "type": "boolean"
}, },
"url": { "url": {
"description": "URL is the dynamic fetch link for the latest Artifact. It is provided on a \"best effort\" basis, and using the precise GitRepositoryStatus.Artifact data is recommended.", "description": "URL is the dynamic fetch link for the latest Artifact.\nIt is provided on a \"best effort\" basis, and using the precise\nGitRepositoryStatus.Artifact data is recommended.",
"type": "string" "type": "string"
} }
}, },

292
source.toolkit.fluxcd.io/helmchart_v1.json Normal file
View File

@ -0,0 +1,292 @@
{
"description": "HelmChart is the Schema for the helmcharts API.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "HelmChartSpec specifies the desired state of a Helm chart.",
"properties": {
"chart": {
"description": "Chart is the name or path the Helm chart is available at in the\nSourceRef.",
"type": "string"
},
"ignoreMissingValuesFiles": {
"description": "IgnoreMissingValuesFiles controls whether to silently ignore missing values\nfiles rather than failing.",
"type": "boolean"
},
"interval": {
"description": "Interval at which the HelmChart SourceRef is checked for updates.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string"
},
"reconcileStrategy": {
"default": "ChartVersion",
"description": "ReconcileStrategy determines what enables the creation of a new artifact.\nValid values are ('ChartVersion', 'Revision').\nSee the documentation of the values for an explanation on their behavior.\nDefaults to ChartVersion when omitted.",
"enum": [
"ChartVersion",
"Revision"
],
"type": "string"
},
"sourceRef": {
"description": "SourceRef is the reference to the Source the chart is available at.",
"properties": {
"apiVersion": {
"description": "APIVersion of the referent.",
"type": "string"
},
"kind": {
"description": "Kind of the referent, valid values are ('HelmRepository', 'GitRepository',\n'Bucket').",
"enum": [
"HelmRepository",
"GitRepository",
"Bucket"
],
"type": "string"
},
"name": {
"description": "Name of the referent.",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object",
"additionalProperties": false
},
"suspend": {
"description": "Suspend tells the controller to suspend the reconciliation of this\nsource.",
"type": "boolean"
},
"valuesFiles": {
"description": "ValuesFiles is an alternative list of values files to use as the chart\nvalues (values.yaml is not included by default), expected to be a\nrelative path in the SourceRef.\nValues files are merged in the order of this list with the last file\noverriding the first. Ignored when omitted.",
"items": {
"type": "string"
},
"type": "array"
},
"verify": {
"description": "Verify contains the secret name containing the trusted public keys\nused to verify the signature and specifies which provider to use to check\nwhether OCI image is authentic.\nThis field is only supported when using HelmRepository source with spec.type 'oci'.\nChart dependencies, which are not bundled in the umbrella chart artifact, are not verified.",
"properties": {
"matchOIDCIdentity": {
"description": "MatchOIDCIdentity specifies the identity matching criteria to use\nwhile verifying an OCI artifact which was signed using Cosign keyless\nsigning. The artifact's identity is deemed to be verified if any of the\nspecified matchers match against the identity.",
"items": {
"description": "OIDCIdentityMatch specifies options for verifying the certificate identity,\ni.e. the issuer and the subject of the certificate.",
"properties": {
"issuer": {
"description": "Issuer specifies the regex pattern to match against to verify\nthe OIDC issuer in the Fulcio certificate. The pattern must be a\nvalid Go regular expression.",
"type": "string"
},
"subject": {
"description": "Subject specifies the regex pattern to match against to verify\nthe identity subject in the Fulcio certificate. The pattern must\nbe a valid Go regular expression.",
"type": "string"
}
},
"required": [
"issuer",
"subject"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"provider": {
"default": "cosign",
"description": "Provider specifies the technology used to sign the OCI Artifact.",
"enum": [
"cosign",
"notation"
],
"type": "string"
},
"secretRef": {
"description": "SecretRef specifies the Kubernetes Secret containing the\ntrusted public keys.",
"properties": {
"name": {
"description": "Name of the referent.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
}
},
"required": [
"provider"
],
"type": "object",
"additionalProperties": false
},
"version": {
"default": "*",
"description": "Version is the chart version semver expression, ignored for charts from\nGitRepository and Bucket sources. Defaults to latest when omitted.",
"type": "string"
}
},
"required": [
"chart",
"interval",
"sourceRef"
],
"type": "object",
"additionalProperties": false
},
"status": {
"default": {
"observedGeneration": -1
},
"description": "HelmChartStatus records the observed state of the HelmChart.",
"properties": {
"artifact": {
"description": "Artifact represents the output of the last successful reconciliation.",
"properties": {
"digest": {
"description": "Digest is the digest of the file in the form of '<algorithm>:<checksum>'.",
"pattern": "^[a-z0-9]+(?:[.+_-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$",
"type": "string"
},
"lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata holds upstream information such as OCI annotations.",
"type": "object"
},
"path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string"
},
"revision": {
"description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string"
},
"size": {
"description": "Size is the number of bytes in the file.",
"format": "int64",
"type": "integer"
},
"url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string"
}
},
"required": [
"lastUpdateTime",
"path",
"revision",
"url"
],
"type": "object",
"additionalProperties": false
},
"conditions": {
"description": "Conditions holds the conditions for the HelmChart.",
"items": {
"description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": {
"lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768,
"type": "string"
},
"observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64",
"minimum": 0,
"type": "integer"
},
"reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
"type": "string"
},
"status": {
"description": "status of the condition, one of True, False, Unknown.",
"enum": [
"True",
"False",
"Unknown"
],
"type": "string"
},
"type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string"
}
},
"required": [
"lastTransitionTime",
"message",
"reason",
"status",
"type"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string"
},
"observedChartName": {
"description": "ObservedChartName is the last observed chart name as specified by the\nresolved chart reference.",
"type": "string"
},
"observedGeneration": {
"description": "ObservedGeneration is the last observed generation of the HelmChart\nobject.",
"format": "int64",
"type": "integer"
},
"observedSourceArtifactRevision": {
"description": "ObservedSourceArtifactRevision is the last observed Artifact.Revision\nof the HelmChartSpec.SourceRef.",
"type": "string"
},
"observedValuesFiles": {
"description": "ObservedValuesFiles are the observed value files of the last successful\nreconciliation.\nIt matches the chart in the last successfully reconciled artifact.",
"items": {
"type": "string"
},
"type": "array"
},
"url": {
"description": "URL is the dynamic fetch link for the latest Artifact.\nIt is provided on a \"best effort\" basis, and using the precise\nBucketStatus.Artifact data is recommended.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object"
}

38
source.toolkit.fluxcd.io/helmchart_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "HelmChart is the Schema for the helmcharts API", "description": "HelmChart is the Schema for the helmcharts API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -19,15 +19,15 @@
"description": "AccessFrom defines an Access Control List for allowing cross-namespace references to this object.", "description": "AccessFrom defines an Access Control List for allowing cross-namespace references to this object.",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -53,7 +53,7 @@
}, },
"reconcileStrategy": { "reconcileStrategy": {
"default": "ChartVersion", "default": "ChartVersion",
"description": "Determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.", "description": "Determines what enables the creation of a new artifact. Valid values are\n('ChartVersion', 'Revision').\nSee the documentation of the values for an explanation on their behavior.\nDefaults to ChartVersion when omitted.",
"enum": [ "enum": [
"ChartVersion", "ChartVersion",
"Revision" "Revision"
@ -68,7 +68,7 @@
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the referent, valid values are ('HelmRepository', 'GitRepository', 'Bucket').", "description": "Kind of the referent, valid values are ('HelmRepository', 'GitRepository',\n'Bucket').",
"enum": [ "enum": [
"HelmRepository", "HelmRepository",
"GitRepository", "GitRepository",
@ -93,11 +93,11 @@
"type": "boolean" "type": "boolean"
}, },
"valuesFile": { "valuesFile": {
"description": "Alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file defined here is merged before the ValuesFiles items. Ignored when omitted.", "description": "Alternative values file to use as the default chart values, expected to\nbe a relative path in the SourceRef. Deprecated in favor of ValuesFiles,\nfor backwards compatibility the file defined here is merged before the\nValuesFiles items. Ignored when omitted.",
"type": "string" "type": "string"
}, },
"valuesFiles": { "valuesFiles": {
"description": "Alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted.", "description": "Alternative list of values files to use as the chart values (values.yaml\nis not included by default), expected to be a relative path in the SourceRef.\nValues files are merged in the order of this list with the last file overriding\nthe first. Ignored when omitted.",
"items": { "items": {
"type": "string" "type": "string"
}, },
@ -105,7 +105,7 @@
}, },
"version": { "version": {
"default": "*", "default": "*",
"description": "The chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted.", "description": "The chart version semver expression, ignored for charts from GitRepository\nand Bucket sources. Defaults to latest when omitted.",
"type": "string" "type": "string"
} }
}, },
@ -131,7 +131,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of this artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of this\nartifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -140,7 +140,7 @@
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm chart version, etc.", "description": "Revision is a human readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm\nchart version, etc.",
"type": "string" "type": "string"
}, },
"url": { "url": {
@ -158,26 +158,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the HelmChart.", "description": "Conditions holds the conditions for the HelmChart.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -193,7 +193,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -212,7 +212,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {

84
source.toolkit.fluxcd.io/helmchart_v1beta2.json
View File

@ -2,11 +2,11 @@
"description": "HelmChart is the Schema for the helmcharts API.", "description": "HelmChart is the Schema for the helmcharts API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,18 +16,18 @@
"description": "HelmChartSpec specifies the desired state of a Helm chart.", "description": "HelmChartSpec specifies the desired state of a Helm chart.",
"properties": { "properties": {
"accessFrom": { "accessFrom": {
"description": "AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092", "description": "AccessFrom specifies an Access Control List for allowing cross-namespace\nreferences to this object.\nNOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -44,17 +44,21 @@
"additionalProperties": false "additionalProperties": false
}, },
"chart": { "chart": {
"description": "Chart is the name or path the Helm chart is available at in the SourceRef.", "description": "Chart is the name or path the Helm chart is available at in the\nSourceRef.",
"type": "string" "type": "string"
}, },
"ignoreMissingValuesFiles": {
"description": "IgnoreMissingValuesFiles controls whether to silently ignore missing values\nfiles rather than failing.",
"type": "boolean"
},
"interval": { "interval": {
"description": "Interval at which the HelmChart SourceRef is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources.", "description": "Interval at which the HelmChart SourceRef is checked for updates.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"reconcileStrategy": { "reconcileStrategy": {
"default": "ChartVersion", "default": "ChartVersion",
"description": "ReconcileStrategy determines what enables the creation of a new artifact. Valid values are ('ChartVersion', 'Revision'). See the documentation of the values for an explanation on their behavior. Defaults to ChartVersion when omitted.", "description": "ReconcileStrategy determines what enables the creation of a new artifact.\nValid values are ('ChartVersion', 'Revision').\nSee the documentation of the values for an explanation on their behavior.\nDefaults to ChartVersion when omitted.",
"enum": [ "enum": [
"ChartVersion", "ChartVersion",
"Revision" "Revision"
@ -69,7 +73,7 @@
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "Kind of the referent, valid values are ('HelmRepository', 'GitRepository', 'Bucket').", "description": "Kind of the referent, valid values are ('HelmRepository', 'GitRepository',\n'Bucket').",
"enum": [ "enum": [
"HelmRepository", "HelmRepository",
"GitRepository", "GitRepository",
@ -90,34 +94,34 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend the reconciliation of this source.", "description": "Suspend tells the controller to suspend the reconciliation of this\nsource.",
"type": "boolean" "type": "boolean"
}, },
"valuesFile": { "valuesFile": {
"description": "ValuesFile is an alternative values file to use as the default chart values, expected to be a relative path in the SourceRef. Deprecated in favor of ValuesFiles, for backwards compatibility the file specified here is merged before the ValuesFiles items. Ignored when omitted.", "description": "ValuesFile is an alternative values file to use as the default chart\nvalues, expected to be a relative path in the SourceRef. Deprecated in\nfavor of ValuesFiles, for backwards compatibility the file specified here\nis merged before the ValuesFiles items. Ignored when omitted.",
"type": "string" "type": "string"
}, },
"valuesFiles": { "valuesFiles": {
"description": "ValuesFiles is an alternative list of values files to use as the chart values (values.yaml is not included by default), expected to be a relative path in the SourceRef. Values files are merged in the order of this list with the last file overriding the first. Ignored when omitted.", "description": "ValuesFiles is an alternative list of values files to use as the chart\nvalues (values.yaml is not included by default), expected to be a\nrelative path in the SourceRef.\nValues files are merged in the order of this list with the last file\noverriding the first. Ignored when omitted.",
"items": { "items": {
"type": "string" "type": "string"
}, },
"type": "array" "type": "array"
}, },
"verify": { "verify": {
"description": "Verify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic. This field is only supported when using HelmRepository source with spec.type 'oci'. Chart dependencies, which are not bundled in the umbrella chart artifact, are not verified.", "description": "Verify contains the secret name containing the trusted public keys\nused to verify the signature and specifies which provider to use to check\nwhether OCI image is authentic.\nThis field is only supported when using HelmRepository source with spec.type 'oci'.\nChart dependencies, which are not bundled in the umbrella chart artifact, are not verified.",
"properties": { "properties": {
"matchOIDCIdentity": { "matchOIDCIdentity": {
"description": "MatchOIDCIdentity specifies the identity matching criteria to use while verifying an OCI artifact which was signed using Cosign keyless signing. The artifact's identity is deemed to be verified if any of the specified matchers match against the identity.", "description": "MatchOIDCIdentity specifies the identity matching criteria to use\nwhile verifying an OCI artifact which was signed using Cosign keyless\nsigning. The artifact's identity is deemed to be verified if any of the\nspecified matchers match against the identity.",
"items": { "items": {
"description": "OIDCIdentityMatch specifies options for verifying the certificate identity, i.e. the issuer and the subject of the certificate.", "description": "OIDCIdentityMatch specifies options for verifying the certificate identity,\ni.e. the issuer and the subject of the certificate.",
"properties": { "properties": {
"issuer": { "issuer": {
"description": "Issuer specifies the regex pattern to match against to verify the OIDC issuer in the Fulcio certificate. The pattern must be a valid Go regular expression.", "description": "Issuer specifies the regex pattern to match against to verify\nthe OIDC issuer in the Fulcio certificate. The pattern must be a\nvalid Go regular expression.",
"type": "string" "type": "string"
}, },
"subject": { "subject": {
"description": "Subject specifies the regex pattern to match against to verify the identity subject in the Fulcio certificate. The pattern must be a valid Go regular expression.", "description": "Subject specifies the regex pattern to match against to verify\nthe identity subject in the Fulcio certificate. The pattern must\nbe a valid Go regular expression.",
"type": "string" "type": "string"
} }
}, },
@ -134,12 +138,13 @@
"default": "cosign", "default": "cosign",
"description": "Provider specifies the technology used to sign the OCI Artifact.", "description": "Provider specifies the technology used to sign the OCI Artifact.",
"enum": [ "enum": [
"cosign" "cosign",
"notation"
], ],
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Kubernetes Secret containing the trusted public keys.", "description": "SecretRef specifies the Kubernetes Secret containing the\ntrusted public keys.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -161,7 +166,7 @@
}, },
"version": { "version": {
"default": "*", "default": "*",
"description": "Version is the chart version semver expression, ignored for charts from GitRepository and Bucket sources. Defaults to latest when omitted.", "description": "Version is the chart version semver expression, ignored for charts from\nGitRepository and Bucket sources. Defaults to latest when omitted.",
"type": "string" "type": "string"
} }
}, },
@ -188,7 +193,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the Artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -200,11 +205,11 @@
"type": "object" "type": "object"
}, },
"path": { "path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.", "description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.", "description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string" "type": "string"
}, },
"size": { "size": {
@ -213,7 +218,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.", "description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string" "type": "string"
} }
}, },
@ -229,26 +234,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the HelmChart.", "description": "Conditions holds the conditions for the HelmChart.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -264,7 +269,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -283,24 +288,31 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedChartName": { "observedChartName": {
"description": "ObservedChartName is the last observed chart name as specified by the resolved chart reference.", "description": "ObservedChartName is the last observed chart name as specified by the\nresolved chart reference.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "ObservedGeneration is the last observed generation of the HelmChart object.", "description": "ObservedGeneration is the last observed generation of the HelmChart\nobject.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"observedSourceArtifactRevision": { "observedSourceArtifactRevision": {
"description": "ObservedSourceArtifactRevision is the last observed Artifact.Revision of the HelmChartSpec.SourceRef.", "description": "ObservedSourceArtifactRevision is the last observed Artifact.Revision\nof the HelmChartSpec.SourceRef.",
"type": "string" "type": "string"
}, },
"observedValuesFiles": {
"description": "ObservedValuesFiles are the observed value files of the last successful\nreconciliation.\nIt matches the chart in the last successfully reconciled artifact.",
"items": {
"type": "string"
},
"type": "array"
},
"url": { "url": {
"description": "URL is the dynamic fetch link for the latest Artifact. It is provided on a \"best effort\" basis, and using the precise BucketStatus.Artifact data is recommended.", "description": "URL is the dynamic fetch link for the latest Artifact.\nIt is provided on a \"best effort\" basis, and using the precise\nBucketStatus.Artifact data is recommended.",
"type": "string" "type": "string"
} }
}, },

255
source.toolkit.fluxcd.io/helmrepository_v1.json Normal file
View File

@ -0,0 +1,255 @@
{
"description": "HelmRepository is the Schema for the helmrepositories API.",
"properties": {
"apiVersion": {
"description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string"
},
"kind": {
"description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string"
},
"metadata": {
"type": "object"
},
"spec": {
"description": "HelmRepositorySpec specifies the required configuration to produce an\nArtifact for a Helm repository index YAML.",
"properties": {
"accessFrom": {
"description": "AccessFrom specifies an Access Control List for allowing cross-namespace\nreferences to this object.\nNOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092",
"properties": {
"namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": {
"matchLabels": {
"additionalProperties": {
"type": "string"
},
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object"
}
},
"type": "object",
"additionalProperties": false
},
"type": "array"
}
},
"required": [
"namespaceSelectors"
],
"type": "object",
"additionalProperties": false
},
"certSecretRef": {
"description": "CertSecretRef can be given the name of a Secret containing\neither or both of\n\n\n- a PEM-encoded client certificate (`tls.crt`) and private\nkey (`tls.key`);\n- a PEM-encoded CA certificate (`ca.crt`)\n\n\nand whichever are supplied, will be used for connecting to the\nregistry. The client cert and key are useful if you are\nauthenticating with a certificate; the CA cert is useful if\nyou are using a self-signed server certificate. The Secret must\nbe of type `Opaque` or `kubernetes.io/tls`.\n\n\nIt takes precedence over the values specified in the Secret referred\nto by `.spec.secretRef`.",
"properties": {
"name": {
"description": "Name of the referent.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"insecure": {
"description": "Insecure allows connecting to a non-TLS HTTP container registry.\nThis field is only taken into account if the .spec.type field is set to 'oci'.",
"type": "boolean"
},
"interval": {
"description": "Interval at which the HelmRepository URL is checked for updates.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string"
},
"passCredentials": {
"description": "PassCredentials allows the credentials from the SecretRef to be passed\non to a host that does not match the host as defined in URL.\nThis may be required if the host of the advertised chart URLs in the\nindex differ from the defined URL.\nEnabling this should be done with caution, as it can potentially result\nin credentials getting stolen in a MITM-attack.",
"type": "boolean"
},
"provider": {
"default": "generic",
"description": "Provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'.\nThis field is optional, and only taken into account if the .spec.type field is set to 'oci'.\nWhen not specified, defaults to 'generic'.",
"enum": [
"generic",
"aws",
"azure",
"gcp"
],
"type": "string"
},
"secretRef": {
"description": "SecretRef specifies the Secret containing authentication credentials\nfor the HelmRepository.\nFor HTTP/S basic auth the secret must contain 'username' and 'password'\nfields.\nSupport for TLS auth using the 'certFile' and 'keyFile', and/or 'caFile'\nkeys is deprecated. Please use `.spec.certSecretRef` instead.",
"properties": {
"name": {
"description": "Name of the referent.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"additionalProperties": false
},
"suspend": {
"description": "Suspend tells the controller to suspend the reconciliation of this\nHelmRepository.",
"type": "boolean"
},
"timeout": {
"description": "Timeout is used for the index fetch operation for an HTTPS helm repository,\nand for remote OCI Repository operations like pulling for an OCI helm\nchart by the associated HelmChart.\nIts default value is 60s.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m))+$",
"type": "string"
},
"type": {
"description": "Type of the HelmRepository.\nWhen this field is set to \"oci\", the URL field value must be prefixed with \"oci://\".",
"enum": [
"default",
"oci"
],
"type": "string"
},
"url": {
"description": "URL of the Helm repository, a valid URL contains at least a protocol and\nhost.",
"pattern": "^(http|https|oci)://.*$",
"type": "string"
}
},
"required": [
"url"
],
"type": "object",
"additionalProperties": false
},
"status": {
"default": {
"observedGeneration": -1
},
"description": "HelmRepositoryStatus records the observed state of the HelmRepository.",
"properties": {
"artifact": {
"description": "Artifact represents the last successful HelmRepository reconciliation.",
"properties": {
"digest": {
"description": "Digest is the digest of the file in the form of '<algorithm>:<checksum>'.",
"pattern": "^[a-z0-9]+(?:[.+_-][a-z0-9]+)*:[a-zA-Z0-9=_-]+$",
"type": "string"
},
"lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time",
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata holds upstream information such as OCI annotations.",
"type": "object"
},
"path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string"
},
"revision": {
"description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string"
},
"size": {
"description": "Size is the number of bytes in the file.",
"format": "int64",
"type": "integer"
},
"url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string"
}
},
"required": [
"lastUpdateTime",
"path",
"revision",
"url"
],
"type": "object",
"additionalProperties": false
},
"conditions": {
"description": "Conditions holds the conditions for the HelmRepository.",
"items": {
"description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": {
"lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768,
"type": "string"
},
"observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64",
"minimum": 0,
"type": "integer"
},
"reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024,
"minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
"type": "string"
},
"status": {
"description": "status of the condition, one of True, False, Unknown.",
"enum": [
"True",
"False",
"Unknown"
],
"type": "string"
},
"type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string"
}
},
"required": [
"lastTransitionTime",
"message",
"reason",
"status",
"type"
],
"type": "object",
"additionalProperties": false
},
"type": "array"
},
"lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string"
},
"observedGeneration": {
"description": "ObservedGeneration is the last observed generation of the HelmRepository\nobject.",
"format": "int64",
"type": "integer"
},
"url": {
"description": "URL is the dynamic fetch link for the latest Artifact.\nIt is provided on a \"best effort\" basis, and using the precise\nHelmRepositoryStatus.Artifact data is recommended.",
"type": "string"
}
},
"type": "object",
"additionalProperties": false
}
},
"type": "object"
}

32
source.toolkit.fluxcd.io/helmrepository_v1beta1.json
View File

@ -2,11 +2,11 @@
"description": "HelmRepository is the Schema for the helmrepositories API", "description": "HelmRepository is the Schema for the helmrepositories API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -19,15 +19,15 @@
"description": "AccessFrom defines an Access Control List for allowing cross-namespace references to this object.", "description": "AccessFrom defines an Access Control List for allowing cross-namespace references to this object.",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -48,11 +48,11 @@
"type": "string" "type": "string"
}, },
"passCredentials": { "passCredentials": {
"description": "PassCredentials allows the credentials from the SecretRef to be passed on to a host that does not match the host as defined in URL. This may be required if the host of the advertised chart URLs in the index differ from the defined URL. Enabling this should be done with caution, as it can potentially result in credentials getting stolen in a MITM-attack.", "description": "PassCredentials allows the credentials from the SecretRef to be passed on to\na host that does not match the host as defined in URL.\nThis may be required if the host of the advertised chart URLs in the index\ndiffer from the defined URL.\nEnabling this should be done with caution, as it can potentially result in\ncredentials getting stolen in a MITM-attack.",
"type": "boolean" "type": "boolean"
}, },
"secretRef": { "secretRef": {
"description": "The name of the secret containing authentication credentials for the Helm repository. For HTTP/S basic auth the secret must contain username and password fields. For TLS the secret must contain a certFile and keyFile, and/or caFile fields.", "description": "The name of the secret containing authentication credentials for the Helm\nrepository.\nFor HTTP/S basic auth the secret must contain username and\npassword fields.\nFor TLS the secret must contain a certFile and keyFile, and/or\ncaFile fields.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -100,7 +100,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of this artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of this\nartifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -109,7 +109,7 @@
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm chart version, etc.", "description": "Revision is a human readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm index timestamp, a Helm\nchart version, etc.",
"type": "string" "type": "string"
}, },
"url": { "url": {
@ -127,26 +127,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the HelmRepository.", "description": "Conditions holds the conditions for the HelmRepository.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -162,7 +162,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -181,7 +181,7 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {

60
source.toolkit.fluxcd.io/helmrepository_v1beta2.json
View File

@ -2,32 +2,32 @@
"description": "HelmRepository is the Schema for the helmrepositories API.", "description": "HelmRepository is the Schema for the helmrepositories API.",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
"type": "object" "type": "object"
}, },
"spec": { "spec": {
"description": "HelmRepositorySpec specifies the required configuration to produce an Artifact for a Helm repository index YAML.", "description": "HelmRepositorySpec specifies the required configuration to produce an\nArtifact for a Helm repository index YAML.",
"properties": { "properties": {
"accessFrom": { "accessFrom": {
"description": "AccessFrom specifies an Access Control List for allowing cross-namespace references to this object. NOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092", "description": "AccessFrom specifies an Access Control List for allowing cross-namespace\nreferences to this object.\nNOTE: Not implemented, provisional as of https://github.com/fluxcd/flux2/pull/2092",
"properties": { "properties": {
"namespaceSelectors": { "namespaceSelectors": {
"description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies. Items in this list are evaluated using a logical OR operation.", "description": "NamespaceSelectors is the list of namespace selectors to which this ACL applies.\nItems in this list are evaluated using a logical OR operation.",
"items": { "items": {
"description": "NamespaceSelector selects the namespaces to which this ACL applies. An empty map of MatchLabels matches all namespaces in a cluster.", "description": "NamespaceSelector selects the namespaces to which this ACL applies.\nAn empty map of MatchLabels matches all namespaces in a cluster.",
"properties": { "properties": {
"matchLabels": { "matchLabels": {
"additionalProperties": { "additionalProperties": {
"type": "string" "type": "string"
}, },
"description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is \"key\", the operator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "description": "MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.",
"type": "object" "type": "object"
} }
}, },
@ -44,7 +44,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"certSecretRef": { "certSecretRef": {
"description": "CertSecretRef can be given the name of a Secret containing either or both of \n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \n and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate. The Secret must be of type `Opaque` or `kubernetes.io/tls`. \n It takes precedence over the values specified in the Secret referred to by `.spec.secretRef`.", "description": "CertSecretRef can be given the name of a Secret containing\neither or both of\n\n\n- a PEM-encoded client certificate (`tls.crt`) and private\nkey (`tls.key`);\n- a PEM-encoded CA certificate (`ca.crt`)\n\n\nand whichever are supplied, will be used for connecting to the\nregistry. The client cert and key are useful if you are\nauthenticating with a certificate; the CA cert is useful if\nyou are using a self-signed server certificate. The Secret must\nbe of type `Opaque` or `kubernetes.io/tls`.\n\n\nIt takes precedence over the values specified in the Secret referred\nto by `.spec.secretRef`.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -58,21 +58,21 @@
"additionalProperties": false "additionalProperties": false
}, },
"insecure": { "insecure": {
"description": "Insecure allows connecting to a non-TLS HTTP container registry. This field is only taken into account if the .spec.type field is set to 'oci'.", "description": "Insecure allows connecting to a non-TLS HTTP container registry.\nThis field is only taken into account if the .spec.type field is set to 'oci'.",
"type": "boolean" "type": "boolean"
}, },
"interval": { "interval": {
"description": "Interval at which the HelmRepository URL is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources.", "description": "Interval at which the HelmRepository URL is checked for updates.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"passCredentials": { "passCredentials": {
"description": "PassCredentials allows the credentials from the SecretRef to be passed on to a host that does not match the host as defined in URL. This may be required if the host of the advertised chart URLs in the index differ from the defined URL. Enabling this should be done with caution, as it can potentially result in credentials getting stolen in a MITM-attack.", "description": "PassCredentials allows the credentials from the SecretRef to be passed\non to a host that does not match the host as defined in URL.\nThis may be required if the host of the advertised chart URLs in the\nindex differ from the defined URL.\nEnabling this should be done with caution, as it can potentially result\nin credentials getting stolen in a MITM-attack.",
"type": "boolean" "type": "boolean"
}, },
"provider": { "provider": {
"default": "generic", "default": "generic",
"description": "Provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. This field is optional, and only taken into account if the .spec.type field is set to 'oci'. When not specified, defaults to 'generic'.", "description": "Provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'.\nThis field is optional, and only taken into account if the .spec.type field is set to 'oci'.\nWhen not specified, defaults to 'generic'.",
"enum": [ "enum": [
"generic", "generic",
"aws", "aws",
@ -82,7 +82,7 @@
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Secret containing authentication credentials for the HelmRepository. For HTTP/S basic auth the secret must contain 'username' and 'password' fields. Support for TLS auth using the 'certFile' and 'keyFile', and/or 'caFile' keys is deprecated. Please use `.spec.certSecretRef` instead.", "description": "SecretRef specifies the Secret containing authentication credentials\nfor the HelmRepository.\nFor HTTP/S basic auth the secret must contain 'username' and 'password'\nfields.\nSupport for TLS auth using the 'certFile' and 'keyFile', and/or 'caFile'\nkeys is deprecated. Please use `.spec.certSecretRef` instead.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -96,16 +96,16 @@
"additionalProperties": false "additionalProperties": false
}, },
"suspend": { "suspend": {
"description": "Suspend tells the controller to suspend the reconciliation of this HelmRepository.", "description": "Suspend tells the controller to suspend the reconciliation of this\nHelmRepository.",
"type": "boolean" "type": "boolean"
}, },
"timeout": { "timeout": {
"description": "Timeout is used for the index fetch operation for an HTTPS helm repository, and for remote OCI Repository operations like pulling for an OCI helm chart by the associated HelmChart. Its default value is 60s.", "description": "Timeout is used for the index fetch operation for an HTTPS helm repository,\nand for remote OCI Repository operations like pulling for an OCI helm\nchart by the associated HelmChart.\nIts default value is 60s.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m))+$",
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "Type of the HelmRepository. When this field is set to \"oci\", the URL field value must be prefixed with \"oci://\".", "description": "Type of the HelmRepository.\nWhen this field is set to \"oci\", the URL field value must be prefixed with \"oci://\".",
"enum": [ "enum": [
"default", "default",
"oci" "oci"
@ -113,7 +113,7 @@
"type": "string" "type": "string"
}, },
"url": { "url": {
"description": "URL of the Helm repository, a valid URL contains at least a protocol and host.", "description": "URL of the Helm repository, a valid URL contains at least a protocol and\nhost.",
"pattern": "^(http|https|oci)://.*$", "pattern": "^(http|https|oci)://.*$",
"type": "string" "type": "string"
} }
@ -139,7 +139,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the Artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -151,11 +151,11 @@
"type": "object" "type": "object"
}, },
"path": { "path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.", "description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.", "description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string" "type": "string"
}, },
"size": { "size": {
@ -164,7 +164,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.", "description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string" "type": "string"
} }
}, },
@ -180,26 +180,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the HelmRepository.", "description": "Conditions holds the conditions for the HelmRepository.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -215,7 +215,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -234,16 +234,16 @@
"type": "array" "type": "array"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "ObservedGeneration is the last observed generation of the HelmRepository object.", "description": "ObservedGeneration is the last observed generation of the HelmRepository\nobject.",
"format": "int64", "format": "int64",
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the dynamic fetch link for the latest Artifact. It is provided on a \"best effort\" basis, and using the precise HelmRepositoryStatus.Artifact data is recommended.", "description": "URL is the dynamic fetch link for the latest Artifact.\nIt is provided on a \"best effort\" basis, and using the precise\nHelmRepositoryStatus.Artifact data is recommended.",
"type": "string" "type": "string"
} }
}, },

81
source.toolkit.fluxcd.io/ocirepository_v1beta2.json
View File

@ -2,11 +2,11 @@
"description": "OCIRepository is the Schema for the ocirepositories API", "description": "OCIRepository is the Schema for the ocirepositories API",
"properties": { "properties": {
"apiVersion": { "apiVersion": {
"description": "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", "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type": "string" "type": "string"
}, },
"kind": { "kind": {
"description": "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", "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"type": "string" "type": "string"
}, },
"metadata": { "metadata": {
@ -16,7 +16,7 @@
"description": "OCIRepositorySpec defines the desired state of OCIRepository", "description": "OCIRepositorySpec defines the desired state of OCIRepository",
"properties": { "properties": {
"certSecretRef": { "certSecretRef": {
"description": "CertSecretRef can be given the name of a Secret containing either or both of \n - a PEM-encoded client certificate (`tls.crt`) and private key (`tls.key`); - a PEM-encoded CA certificate (`ca.crt`) \n and whichever are supplied, will be used for connecting to the registry. The client cert and key are useful if you are authenticating with a certificate; the CA cert is useful if you are using a self-signed server certificate. The Secret must be of type `Opaque` or `kubernetes.io/tls`. \n Note: Support for the `caFile`, `certFile` and `keyFile` keys have been deprecated.", "description": "CertSecretRef can be given the name of a Secret containing\neither or both of\n\n\n- a PEM-encoded client certificate (`tls.crt`) and private\nkey (`tls.key`);\n- a PEM-encoded CA certificate (`ca.crt`)\n\n\nand whichever are supplied, will be used for connecting to the\nregistry. The client cert and key are useful if you are\nauthenticating with a certificate; the CA cert is useful if\nyou are using a self-signed server certificate. The Secret must\nbe of type `Opaque` or `kubernetes.io/tls`.\n\n\nNote: Support for the `caFile`, `certFile` and `keyFile` keys have\nbeen deprecated.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -30,7 +30,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"ignore": { "ignore": {
"description": "Ignore overrides the set of excluded patterns in the .sourceignore format (which is the same as .gitignore). If not provided, a default will be used, consult the documentation for your version to find out what those are.", "description": "Ignore overrides the set of excluded patterns in the .sourceignore format\n(which is the same as .gitignore). If not provided, a default will be used,\nconsult the documentation for your version to find out what those are.",
"type": "string" "type": "string"
}, },
"insecure": { "insecure": {
@ -38,19 +38,19 @@
"type": "boolean" "type": "boolean"
}, },
"interval": { "interval": {
"description": "Interval at which the OCIRepository URL is checked for updates. This interval is approximate and may be subject to jitter to ensure efficient use of resources.", "description": "Interval at which the OCIRepository URL is checked for updates.\nThis interval is approximate and may be subject to jitter to ensure\nefficient use of resources.",
"pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$", "pattern": "^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$",
"type": "string" "type": "string"
}, },
"layerSelector": { "layerSelector": {
"description": "LayerSelector specifies which layer should be extracted from the OCI artifact. When not specified, the first layer found in the artifact is selected.", "description": "LayerSelector specifies which layer should be extracted from the OCI artifact.\nWhen not specified, the first layer found in the artifact is selected.",
"properties": { "properties": {
"mediaType": { "mediaType": {
"description": "MediaType specifies the OCI media type of the layer which should be extracted from the OCI Artifact. The first layer matching this type is selected.", "description": "MediaType specifies the OCI media type of the layer\nwhich should be extracted from the OCI Artifact. The\nfirst layer matching this type is selected.",
"type": "string" "type": "string"
}, },
"operation": { "operation": {
"description": "Operation specifies how the selected layer should be processed. By default, the layer compressed content is extracted to storage. When the operation is set to 'copy', the layer compressed content is persisted to storage as it is.", "description": "Operation specifies how the selected layer should be processed.\nBy default, the layer compressed content is extracted to storage.\nWhen the operation is set to 'copy', the layer compressed content\nis persisted to storage as it is.",
"enum": [ "enum": [
"extract", "extract",
"copy" "copy"
@ -63,7 +63,7 @@
}, },
"provider": { "provider": {
"default": "generic", "default": "generic",
"description": "The provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'. When not specified, defaults to 'generic'.", "description": "The provider used for authentication, can be 'aws', 'azure', 'gcp' or 'generic'.\nWhen not specified, defaults to 'generic'.",
"enum": [ "enum": [
"generic", "generic",
"aws", "aws",
@ -73,14 +73,18 @@
"type": "string" "type": "string"
}, },
"ref": { "ref": {
"description": "The OCI reference to pull and monitor for changes, defaults to the latest tag.", "description": "The OCI reference to pull and monitor for changes,\ndefaults to the latest tag.",
"properties": { "properties": {
"digest": { "digest": {
"description": "Digest is the image digest to pull, takes precedence over SemVer. The value should be in the format 'sha256:<HASH>'.", "description": "Digest is the image digest to pull, takes precedence over SemVer.\nThe value should be in the format 'sha256:<HASH>'.",
"type": "string" "type": "string"
}, },
"semver": { "semver": {
"description": "SemVer is the range of tags to pull selecting the latest within the range, takes precedence over Tag.", "description": "SemVer is the range of tags to pull selecting the latest within\nthe range, takes precedence over Tag.",
"type": "string"
},
"semverFilter": {
"description": "SemverFilter is a regex pattern to filter the tags within the SemVer range.",
"type": "string" "type": "string"
}, },
"tag": { "tag": {
@ -92,7 +96,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"secretRef": { "secretRef": {
"description": "SecretRef contains the secret name containing the registry login credentials to resolve image metadata. The secret must be of type kubernetes.io/dockerconfigjson.", "description": "SecretRef contains the secret name containing the registry login\ncredentials to resolve image metadata.\nThe secret must be of type kubernetes.io/dockerconfigjson.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -106,7 +110,7 @@
"additionalProperties": false "additionalProperties": false
}, },
"serviceAccountName": { "serviceAccountName": {
"description": "ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate the image pull if the service account has attached pull secrets. For more information: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account", "description": "ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate\nthe image pull if the service account has attached pull secrets. For more information:\nhttps://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account",
"type": "string" "type": "string"
}, },
"suspend": { "suspend": {
@ -120,24 +124,24 @@
"type": "string" "type": "string"
}, },
"url": { "url": {
"description": "URL is a reference to an OCI artifact repository hosted on a remote container registry.", "description": "URL is a reference to an OCI artifact repository hosted\non a remote container registry.",
"pattern": "^oci://.*$", "pattern": "^oci://.*$",
"type": "string" "type": "string"
}, },
"verify": { "verify": {
"description": "Verify contains the secret name containing the trusted public keys used to verify the signature and specifies which provider to use to check whether OCI image is authentic.", "description": "Verify contains the secret name containing the trusted public keys\nused to verify the signature and specifies which provider to use to check\nwhether OCI image is authentic.",
"properties": { "properties": {
"matchOIDCIdentity": { "matchOIDCIdentity": {
"description": "MatchOIDCIdentity specifies the identity matching criteria to use while verifying an OCI artifact which was signed using Cosign keyless signing. The artifact's identity is deemed to be verified if any of the specified matchers match against the identity.", "description": "MatchOIDCIdentity specifies the identity matching criteria to use\nwhile verifying an OCI artifact which was signed using Cosign keyless\nsigning. The artifact's identity is deemed to be verified if any of the\nspecified matchers match against the identity.",
"items": { "items": {
"description": "OIDCIdentityMatch specifies options for verifying the certificate identity, i.e. the issuer and the subject of the certificate.", "description": "OIDCIdentityMatch specifies options for verifying the certificate identity,\ni.e. the issuer and the subject of the certificate.",
"properties": { "properties": {
"issuer": { "issuer": {
"description": "Issuer specifies the regex pattern to match against to verify the OIDC issuer in the Fulcio certificate. The pattern must be a valid Go regular expression.", "description": "Issuer specifies the regex pattern to match against to verify\nthe OIDC issuer in the Fulcio certificate. The pattern must be a\nvalid Go regular expression.",
"type": "string" "type": "string"
}, },
"subject": { "subject": {
"description": "Subject specifies the regex pattern to match against to verify the identity subject in the Fulcio certificate. The pattern must be a valid Go regular expression.", "description": "Subject specifies the regex pattern to match against to verify\nthe identity subject in the Fulcio certificate. The pattern must\nbe a valid Go regular expression.",
"type": "string" "type": "string"
} }
}, },
@ -154,12 +158,13 @@
"default": "cosign", "default": "cosign",
"description": "Provider specifies the technology used to sign the OCI Artifact.", "description": "Provider specifies the technology used to sign the OCI Artifact.",
"enum": [ "enum": [
"cosign" "cosign",
"notation"
], ],
"type": "string" "type": "string"
}, },
"secretRef": { "secretRef": {
"description": "SecretRef specifies the Kubernetes Secret containing the trusted public keys.", "description": "SecretRef specifies the Kubernetes Secret containing the\ntrusted public keys.",
"properties": { "properties": {
"name": { "name": {
"description": "Name of the referent.", "description": "Name of the referent.",
@ -202,7 +207,7 @@
"type": "string" "type": "string"
}, },
"lastUpdateTime": { "lastUpdateTime": {
"description": "LastUpdateTime is the timestamp corresponding to the last update of the Artifact.", "description": "LastUpdateTime is the timestamp corresponding to the last update of the\nArtifact.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
@ -214,11 +219,11 @@
"type": "object" "type": "object"
}, },
"path": { "path": {
"description": "Path is the relative file path of the Artifact. It can be used to locate the file in the root of the Artifact storage on the local file system of the controller managing the Source.", "description": "Path is the relative file path of the Artifact. It can be used to locate\nthe file in the root of the Artifact storage on the local file system of\nthe controller managing the Source.",
"type": "string" "type": "string"
}, },
"revision": { "revision": {
"description": "Revision is a human-readable identifier traceable in the origin source system. It can be a Git commit SHA, Git tag, a Helm chart version, etc.", "description": "Revision is a human-readable identifier traceable in the origin source\nsystem. It can be a Git commit SHA, Git tag, a Helm chart version, etc.",
"type": "string" "type": "string"
}, },
"size": { "size": {
@ -227,7 +232,7 @@
"type": "integer" "type": "integer"
}, },
"url": { "url": {
"description": "URL is the HTTP address of the Artifact as exposed by the controller managing the Source. It can be used to retrieve the Artifact for consumption, e.g. by another controller applying the Artifact contents.", "description": "URL is the HTTP address of the Artifact as exposed by the controller\nmanaging the Source. It can be used to retrieve the Artifact for\nconsumption, e.g. by another controller applying the Artifact contents.",
"type": "string" "type": "string"
} }
}, },
@ -243,26 +248,26 @@
"conditions": { "conditions": {
"description": "Conditions holds the conditions for the OCIRepository.", "description": "Conditions holds the conditions for the OCIRepository.",
"items": { "items": {
"description": "Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, \n type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }", "description": "Condition contains details for one aspect of the current state of this API Resource.\n---\nThis struct is intended for direct use as an array at the field path .status.conditions. For example,\n\n\n\ttype FooStatus struct{\n\t // Represents the observations of a foo's current state.\n\t // Known .status.conditions.type are: \"Available\", \"Progressing\", and \"Degraded\"\n\t // +patchMergeKey=type\n\t // +patchStrategy=merge\n\t // +listType=map\n\t // +listMapKey=type\n\t Conditions []metav1.Condition `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`\n\n\n\t // other fields\n\t}",
"properties": { "properties": {
"lastTransitionTime": { "lastTransitionTime": {
"description": "lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.",
"format": "date-time", "format": "date-time",
"type": "string" "type": "string"
}, },
"message": { "message": {
"description": "message is a human readable message indicating details about the transition. This may be an empty string.", "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.",
"maxLength": 32768, "maxLength": 32768,
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
"description": "observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.", "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.",
"format": "int64", "format": "int64",
"minimum": 0, "minimum": 0,
"type": "integer" "type": "integer"
}, },
"reason": { "reason": {
"description": "reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.", "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.",
"maxLength": 1024, "maxLength": 1024,
"minLength": 1, "minLength": 1,
"pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$",
@ -278,7 +283,7 @@
"type": "string" "type": "string"
}, },
"type": { "type": {
"description": "type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)", "description": "type of condition in CamelCase or in foo.example.com/CamelCase.\n---\nMany .condition.type values are consistent across resources like Available, but because arbitrary conditions can be\nuseful (see .node.status.conditions), the ability to deconflict is important.\nThe regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)",
"maxLength": 316, "maxLength": 316,
"pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$",
"type": "string" "type": "string"
@ -297,11 +302,11 @@
"type": "array" "type": "array"
}, },
"contentConfigChecksum": { "contentConfigChecksum": {
"description": "ContentConfigChecksum is a checksum of all the configurations related to the content of the source artifact: - .spec.ignore - .spec.layerSelector observed in .status.observedGeneration version of the object. This can be used to determine if the content configuration has changed and the artifact needs to be rebuilt. It has the format of `<algo>:<checksum>`, for example: `sha256:<checksum>`. \n Deprecated: Replaced with explicit fields for observed artifact content config in the status.", "description": "ContentConfigChecksum is a checksum of all the configurations related to\nthe content of the source artifact:\n - .spec.ignore\n - .spec.layerSelector\nobserved in .status.observedGeneration version of the object. This can\nbe used to determine if the content configuration has changed and the\nartifact needs to be rebuilt.\nIt has the format of `<algo>:<checksum>`, for example: `sha256:<checksum>`.\n\n\nDeprecated: Replaced with explicit fields for observed artifact content\nconfig in the status.",
"type": "string" "type": "string"
}, },
"lastHandledReconcileAt": { "lastHandledReconcileAt": {
"description": "LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.", "description": "LastHandledReconcileAt holds the value of the most recent\nreconcile request value, so a change of the annotation value\ncan be detected.",
"type": "string" "type": "string"
}, },
"observedGeneration": { "observedGeneration": {
@ -310,18 +315,18 @@
"type": "integer" "type": "integer"
}, },
"observedIgnore": { "observedIgnore": {
"description": "ObservedIgnore is the observed exclusion patterns used for constructing the source artifact.", "description": "ObservedIgnore is the observed exclusion patterns used for constructing\nthe source artifact.",
"type": "string" "type": "string"
}, },
"observedLayerSelector": { "observedLayerSelector": {
"description": "ObservedLayerSelector is the observed layer selector used for constructing the source artifact.", "description": "ObservedLayerSelector is the observed layer selector used for constructing\nthe source artifact.",
"properties": { "properties": {
"mediaType": { "mediaType": {
"description": "MediaType specifies the OCI media type of the layer which should be extracted from the OCI Artifact. The first layer matching this type is selected.", "description": "MediaType specifies the OCI media type of the layer\nwhich should be extracted from the OCI Artifact. The\nfirst layer matching this type is selected.",
"type": "string" "type": "string"
}, },
"operation": { "operation": {
"description": "Operation specifies how the selected layer should be processed. By default, the layer compressed content is extracted to storage. When the operation is set to 'copy', the layer compressed content is persisted to storage as it is.", "description": "Operation specifies how the selected layer should be processed.\nBy default, the layer compressed content is extracted to storage.\nWhen the operation is set to 'copy', the layer compressed content\nis persisted to storage as it is.",
"enum": [ "enum": [
"extract", "extract",
"copy" "copy"