diff --git a/docs-v2/content/en/docs/references/cli/_index.md b/docs-v2/content/en/docs/references/cli/_index.md index d3a64ad8812..acafae1bfa0 100644 --- a/docs-v2/content/en/docs/references/cli/_index.md +++ b/docs-v2/content/en/docs/references/cli/_index.md @@ -915,7 +915,7 @@ Options: --overwrite=false: Overwrite original config with fixed config --remote-cache-dir='': Specify the location of the git repositories cache (default $HOME/.skaffold/repos) --sync-remote-cache='missing': Controls how Skaffold manages the remote config cache (see `remote-cache-dir`). One of `always` (default), `missing`, or `never`. `always` syncs remote repositories to latest on access. `missing` only clones remote repositories if they do not exist locally. `never` means the user takes responsibility for updating remote repositories. - --version='skaffold/v4beta3': Target schema version to upgrade to + --version='skaffold/v4beta4': Target schema version to upgrade to Usage: skaffold fix [options] diff --git a/docs-v2/content/en/schemas/v4beta4.json b/docs-v2/content/en/schemas/v4beta4.json new file mode 100755 index 00000000000..ca62e392fa2 --- /dev/null +++ b/docs-v2/content/en/schemas/v4beta4.json @@ -0,0 +1,4331 @@ +{ + "type": "object", + "anyOf": [ + { + "$ref": "#/definitions/SkaffoldConfig" + } + ], + "$schema": "http://json-schema.org/draft-07/schema#", + "definitions": { + "Activation": { + "properties": { + "command": { + "type": "string", + "description": "a Skaffold command for which the profile is auto-activated.", + "x-intellij-html-description": "a Skaffold command for which the profile is auto-activated.", + "examples": [ + "dev" + ] + }, + "env": { + "type": "string", + "description": "a `key=pattern` pair. The profile is auto-activated if an Environment Variable `key` matches the pattern. If the pattern starts with `!`, activation happens if the remaining pattern is _not_ matched. The pattern matches if the Environment Variable value is exactly `pattern`, or the regex `pattern` is found in it. An empty `pattern` (e.g. `env: \"key=\"`) always only matches if the Environment Variable is undefined or empty.", + "x-intellij-html-description": "a key=pattern pair. The profile is auto-activated if an Environment Variable key matches the pattern. If the pattern starts with !, activation happens if the remaining pattern is not matched. The pattern matches if the Environment Variable value is exactly pattern, or the regex pattern is found in it. An empty pattern (e.g. env: "key=") always only matches if the Environment Variable is undefined or empty.", + "examples": [ + "ENV=production" + ] + }, + "kubeContext": { + "type": "string", + "description": "a Kubernetes context for which the profile is auto-activated.", + "x-intellij-html-description": "a Kubernetes context for which the profile is auto-activated.", + "examples": [ + "minikube" + ] + } + }, + "preferredOrder": [ + "env", + "kubeContext", + "command" + ], + "additionalProperties": false, + "type": "object", + "description": "criteria by which a profile is auto-activated.", + "x-intellij-html-description": "criteria by which a profile is auto-activated." + }, + "Artifact": { + "required": [ + "image" + ], + "type": "object", + "anyOf": [ + { + "properties": { + "context": { + "type": "string", + "description": "directory containing the artifact's sources.", + "x-intellij-html-description": "directory containing the artifact's sources.", + "default": "." + }, + "hooks": { + "$ref": "#/definitions/BuildHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact." + }, + "image": { + "type": "string", + "description": "name of the image to be built.", + "x-intellij-html-description": "name of the image to be built.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level platforms property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "requires": { + "items": { + "$ref": "#/definitions/ArtifactDependency" + }, + "type": "array", + "description": "describes build artifacts that this artifact depends on.", + "x-intellij-html-description": "describes build artifacts that this artifact depends on." + }, + "runtimeType": { + "type": "string", + "description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes.", + "x-intellij-html-description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of go, nodejs, jvm, python or netcore. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes." + }, + "sync": { + "$ref": "#/definitions/Sync", + "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + } + }, + "preferredOrder": [ + "image", + "context", + "sync", + "requires", + "hooks", + "platforms", + "runtimeType" + ], + "additionalProperties": false + }, + { + "properties": { + "context": { + "type": "string", + "description": "directory containing the artifact's sources.", + "x-intellij-html-description": "directory containing the artifact's sources.", + "default": "." + }, + "docker": { + "$ref": "#/definitions/DockerArtifact", + "description": "*beta* describes an artifact built from a Dockerfile.", + "x-intellij-html-description": "beta describes an artifact built from a Dockerfile." + }, + "hooks": { + "$ref": "#/definitions/BuildHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact." + }, + "image": { + "type": "string", + "description": "name of the image to be built.", + "x-intellij-html-description": "name of the image to be built.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level platforms property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "requires": { + "items": { + "$ref": "#/definitions/ArtifactDependency" + }, + "type": "array", + "description": "describes build artifacts that this artifact depends on.", + "x-intellij-html-description": "describes build artifacts that this artifact depends on." + }, + "runtimeType": { + "type": "string", + "description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes.", + "x-intellij-html-description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of go, nodejs, jvm, python or netcore. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes." + }, + "sync": { + "$ref": "#/definitions/Sync", + "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + } + }, + "preferredOrder": [ + "image", + "context", + "sync", + "requires", + "hooks", + "platforms", + "runtimeType", + "docker" + ], + "additionalProperties": false + }, + { + "properties": { + "bazel": { + "$ref": "#/definitions/BazelArtifact", + "description": "*beta* requires bazel CLI to be installed and the sources to contain [Bazel](https://bazel.build/) configuration files.", + "x-intellij-html-description": "beta requires bazel CLI to be installed and the sources to contain Bazel configuration files." + }, + "context": { + "type": "string", + "description": "directory containing the artifact's sources.", + "x-intellij-html-description": "directory containing the artifact's sources.", + "default": "." + }, + "hooks": { + "$ref": "#/definitions/BuildHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact." + }, + "image": { + "type": "string", + "description": "name of the image to be built.", + "x-intellij-html-description": "name of the image to be built.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level platforms property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "requires": { + "items": { + "$ref": "#/definitions/ArtifactDependency" + }, + "type": "array", + "description": "describes build artifacts that this artifact depends on.", + "x-intellij-html-description": "describes build artifacts that this artifact depends on." + }, + "runtimeType": { + "type": "string", + "description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes.", + "x-intellij-html-description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of go, nodejs, jvm, python or netcore. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes." + }, + "sync": { + "$ref": "#/definitions/Sync", + "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + } + }, + "preferredOrder": [ + "image", + "context", + "sync", + "requires", + "hooks", + "platforms", + "runtimeType", + "bazel" + ], + "additionalProperties": false + }, + { + "properties": { + "context": { + "type": "string", + "description": "directory containing the artifact's sources.", + "x-intellij-html-description": "directory containing the artifact's sources.", + "default": "." + }, + "hooks": { + "$ref": "#/definitions/BuildHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact." + }, + "image": { + "type": "string", + "description": "name of the image to be built.", + "x-intellij-html-description": "name of the image to be built.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "ko": { + "$ref": "#/definitions/KoArtifact", + "description": "builds images using [ko](https://github.com/google/ko).", + "x-intellij-html-description": "builds images using ko." + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level platforms property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "requires": { + "items": { + "$ref": "#/definitions/ArtifactDependency" + }, + "type": "array", + "description": "describes build artifacts that this artifact depends on.", + "x-intellij-html-description": "describes build artifacts that this artifact depends on." + }, + "runtimeType": { + "type": "string", + "description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes.", + "x-intellij-html-description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of go, nodejs, jvm, python or netcore. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes." + }, + "sync": { + "$ref": "#/definitions/Sync", + "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + } + }, + "preferredOrder": [ + "image", + "context", + "sync", + "requires", + "hooks", + "platforms", + "runtimeType", + "ko" + ], + "additionalProperties": false + }, + { + "properties": { + "context": { + "type": "string", + "description": "directory containing the artifact's sources.", + "x-intellij-html-description": "directory containing the artifact's sources.", + "default": "." + }, + "hooks": { + "$ref": "#/definitions/BuildHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact." + }, + "image": { + "type": "string", + "description": "name of the image to be built.", + "x-intellij-html-description": "name of the image to be built.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "jib": { + "$ref": "#/definitions/JibArtifact", + "description": "builds images using the [Jib plugins for Maven or Gradle](https://github.com/GoogleContainerTools/jib/).", + "x-intellij-html-description": "builds images using the Jib plugins for Maven or Gradle." + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level platforms property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "requires": { + "items": { + "$ref": "#/definitions/ArtifactDependency" + }, + "type": "array", + "description": "describes build artifacts that this artifact depends on.", + "x-intellij-html-description": "describes build artifacts that this artifact depends on." + }, + "runtimeType": { + "type": "string", + "description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes.", + "x-intellij-html-description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of go, nodejs, jvm, python or netcore. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes." + }, + "sync": { + "$ref": "#/definitions/Sync", + "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + } + }, + "preferredOrder": [ + "image", + "context", + "sync", + "requires", + "hooks", + "platforms", + "runtimeType", + "jib" + ], + "additionalProperties": false + }, + { + "properties": { + "context": { + "type": "string", + "description": "directory containing the artifact's sources.", + "x-intellij-html-description": "directory containing the artifact's sources.", + "default": "." + }, + "hooks": { + "$ref": "#/definitions/BuildHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact." + }, + "image": { + "type": "string", + "description": "name of the image to be built.", + "x-intellij-html-description": "name of the image to be built.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "kaniko": { + "$ref": "#/definitions/KanikoArtifact", + "description": "builds images using [kaniko](https://github.com/GoogleContainerTools/kaniko).", + "x-intellij-html-description": "builds images using kaniko." + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level platforms property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "requires": { + "items": { + "$ref": "#/definitions/ArtifactDependency" + }, + "type": "array", + "description": "describes build artifacts that this artifact depends on.", + "x-intellij-html-description": "describes build artifacts that this artifact depends on." + }, + "runtimeType": { + "type": "string", + "description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes.", + "x-intellij-html-description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of go, nodejs, jvm, python or netcore. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes." + }, + "sync": { + "$ref": "#/definitions/Sync", + "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + } + }, + "preferredOrder": [ + "image", + "context", + "sync", + "requires", + "hooks", + "platforms", + "runtimeType", + "kaniko" + ], + "additionalProperties": false + }, + { + "properties": { + "buildpacks": { + "$ref": "#/definitions/BuildpackArtifact", + "description": "builds images using [Cloud Native Buildpacks](https://buildpacks.io/).", + "x-intellij-html-description": "builds images using Cloud Native Buildpacks." + }, + "context": { + "type": "string", + "description": "directory containing the artifact's sources.", + "x-intellij-html-description": "directory containing the artifact's sources.", + "default": "." + }, + "hooks": { + "$ref": "#/definitions/BuildHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact." + }, + "image": { + "type": "string", + "description": "name of the image to be built.", + "x-intellij-html-description": "name of the image to be built.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level platforms property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "requires": { + "items": { + "$ref": "#/definitions/ArtifactDependency" + }, + "type": "array", + "description": "describes build artifacts that this artifact depends on.", + "x-intellij-html-description": "describes build artifacts that this artifact depends on." + }, + "runtimeType": { + "type": "string", + "description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes.", + "x-intellij-html-description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of go, nodejs, jvm, python or netcore. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes." + }, + "sync": { + "$ref": "#/definitions/Sync", + "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + } + }, + "preferredOrder": [ + "image", + "context", + "sync", + "requires", + "hooks", + "platforms", + "runtimeType", + "buildpacks" + ], + "additionalProperties": false + }, + { + "properties": { + "context": { + "type": "string", + "description": "directory containing the artifact's sources.", + "x-intellij-html-description": "directory containing the artifact's sources.", + "default": "." + }, + "custom": { + "$ref": "#/definitions/CustomArtifact", + "description": "*beta* builds images using a custom build script written by the user.", + "x-intellij-html-description": "beta builds images using a custom build script written by the user." + }, + "hooks": { + "$ref": "#/definitions/BuildHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each build of the target artifact." + }, + "image": { + "type": "string", + "description": "name of the image to be built.", + "x-intellij-html-description": "name of the image to be built.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build this artifact image for. It overrides the values inferred through heuristics or provided in the top level platforms property or in the global config. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "requires": { + "items": { + "$ref": "#/definitions/ArtifactDependency" + }, + "type": "array", + "description": "describes build artifacts that this artifact depends on.", + "x-intellij-html-description": "describes build artifacts that this artifact depends on." + }, + "runtimeType": { + "type": "string", + "description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes.", + "x-intellij-html-description": "specifies the target language runtime for this artifact that is used to configure debug support. Should be one of go, nodejs, jvm, python or netcore. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes." + }, + "sync": { + "$ref": "#/definitions/Sync", + "description": "*beta* local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta local files synced to pods instead of triggering an image build when modified. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + } + }, + "preferredOrder": [ + "image", + "context", + "sync", + "requires", + "hooks", + "platforms", + "runtimeType", + "custom" + ], + "additionalProperties": false + } + ], + "description": "items that need to be built, along with the context in which they should be built.", + "x-intellij-html-description": "items that need to be built, along with the context in which they should be built." + }, + "ArtifactDependency": { + "required": [ + "image" + ], + "properties": { + "alias": { + "type": "string", + "description": "a token that is replaced with the image reference in the builder definition files. For example, the `docker` builder will use the alias as a build-arg key. Defaults to the value of `image`.", + "x-intellij-html-description": "a token that is replaced with the image reference in the builder definition files. For example, the docker builder will use the alias as a build-arg key. Defaults to the value of image." + }, + "image": { + "type": "string", + "description": "a reference to an artifact's image name.", + "x-intellij-html-description": "a reference to an artifact's image name." + } + }, + "preferredOrder": [ + "image", + "alias" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a specific build dependency for an artifact.", + "x-intellij-html-description": "describes a specific build dependency for an artifact." + }, + "BazelArtifact": { + "required": [ + "target" + ], + "properties": { + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional args to pass to `bazel build`.", + "x-intellij-html-description": "additional args to pass to bazel build.", + "default": "[]", + "examples": [ + "[\"-flag\", \"--otherflag\"]" + ] + }, + "target": { + "type": "string", + "description": "`bazel build` target to run.", + "x-intellij-html-description": "bazel build target to run.", + "examples": [ + "//:skaffold_example.tar" + ] + } + }, + "preferredOrder": [ + "target", + "args" + ], + "additionalProperties": false, + "type": "object", + "description": "describes an artifact built with [Bazel](https://bazel.build/).", + "x-intellij-html-description": "describes an artifact built with Bazel." + }, + "BuildConfig": { + "type": "object", + "anyOf": [ + { + "properties": { + "artifacts": { + "items": { + "$ref": "#/definitions/Artifact" + }, + "type": "array", + "description": "the images you're going to be building.", + "x-intellij-html-description": "the images you're going to be building." + }, + "insecureRegistries": { + "items": { + "type": "string" + }, + "type": "array", + "description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", + "x-intellij-html-description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", + "default": "[]" + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build all artifact images for. It can be overridden by the individual artifact's `platforms` property. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build all artifact images for. It can be overridden by the individual artifact's platforms property. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "tagPolicy": { + "$ref": "#/definitions/TagPolicy", + "description": "*beta* determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to `gitCommit: {variant: Tags}`.", + "x-intellij-html-description": "beta determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to gitCommit: {variant: Tags}." + } + }, + "preferredOrder": [ + "artifacts", + "insecureRegistries", + "tagPolicy", + "platforms" + ], + "additionalProperties": false + }, + { + "properties": { + "artifacts": { + "items": { + "$ref": "#/definitions/Artifact" + }, + "type": "array", + "description": "the images you're going to be building.", + "x-intellij-html-description": "the images you're going to be building." + }, + "insecureRegistries": { + "items": { + "type": "string" + }, + "type": "array", + "description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", + "x-intellij-html-description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", + "default": "[]" + }, + "local": { + "$ref": "#/definitions/LocalBuild", + "description": "*beta* describes how to do a build on the local docker daemon and optionally push to a repository.", + "x-intellij-html-description": "beta describes how to do a build on the local docker daemon and optionally push to a repository." + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build all artifact images for. It can be overridden by the individual artifact's `platforms` property. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build all artifact images for. It can be overridden by the individual artifact's platforms property. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "tagPolicy": { + "$ref": "#/definitions/TagPolicy", + "description": "*beta* determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to `gitCommit: {variant: Tags}`.", + "x-intellij-html-description": "beta determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to gitCommit: {variant: Tags}." + } + }, + "preferredOrder": [ + "artifacts", + "insecureRegistries", + "tagPolicy", + "platforms", + "local" + ], + "additionalProperties": false + }, + { + "properties": { + "artifacts": { + "items": { + "$ref": "#/definitions/Artifact" + }, + "type": "array", + "description": "the images you're going to be building.", + "x-intellij-html-description": "the images you're going to be building." + }, + "googleCloudBuild": { + "$ref": "#/definitions/GoogleCloudBuild", + "description": "*beta* describes how to do a remote build on [Google Cloud Build](https://cloud.google.com/cloud-build/).", + "x-intellij-html-description": "beta describes how to do a remote build on Google Cloud Build." + }, + "insecureRegistries": { + "items": { + "type": "string" + }, + "type": "array", + "description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", + "x-intellij-html-description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", + "default": "[]" + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build all artifact images for. It can be overridden by the individual artifact's `platforms` property. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build all artifact images for. It can be overridden by the individual artifact's platforms property. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "tagPolicy": { + "$ref": "#/definitions/TagPolicy", + "description": "*beta* determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to `gitCommit: {variant: Tags}`.", + "x-intellij-html-description": "beta determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to gitCommit: {variant: Tags}." + } + }, + "preferredOrder": [ + "artifacts", + "insecureRegistries", + "tagPolicy", + "platforms", + "googleCloudBuild" + ], + "additionalProperties": false + }, + { + "properties": { + "artifacts": { + "items": { + "$ref": "#/definitions/Artifact" + }, + "type": "array", + "description": "the images you're going to be building.", + "x-intellij-html-description": "the images you're going to be building." + }, + "cluster": { + "$ref": "#/definitions/ClusterDetails", + "description": "*beta* describes how to do an on-cluster build.", + "x-intellij-html-description": "beta describes how to do an on-cluster build." + }, + "insecureRegistries": { + "items": { + "type": "string" + }, + "type": "array", + "description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", + "x-intellij-html-description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", + "default": "[]" + }, + "platforms": { + "items": { + "type": "string" + }, + "type": "array", + "description": "list of platforms to build all artifact images for. It can be overridden by the individual artifact's `platforms` property. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. Example: `[\"linux/amd64\", \"linux/arm64\"]`.", + "x-intellij-html-description": "list of platforms to build all artifact images for. It can be overridden by the individual artifact's platforms property. If the target builder cannot build for atleast one of the specified platforms, then the build fails. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Example: ["linux/amd64", "linux/arm64"].", + "default": "[]" + }, + "tagPolicy": { + "$ref": "#/definitions/TagPolicy", + "description": "*beta* determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to `gitCommit: {variant: Tags}`.", + "x-intellij-html-description": "beta determines how images are tagged. A few strategies are provided here, although you most likely won't need to care! If not specified, it defaults to gitCommit: {variant: Tags}." + } + }, + "preferredOrder": [ + "artifacts", + "insecureRegistries", + "tagPolicy", + "platforms", + "cluster" + ], + "additionalProperties": false + } + ], + "description": "contains all the configuration for the build steps.", + "x-intellij-html-description": "contains all the configuration for the build steps." + }, + "BuildHooks": { + "properties": { + "after": { + "items": { + "$ref": "#/definitions/HostHook" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *after* each artifact build step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute after each artifact build step." + }, + "before": { + "items": { + "$ref": "#/definitions/HostHook" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *before* each artifact build step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before each artifact build step." + } + }, + "preferredOrder": [ + "before", + "after" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the list of lifecycle hooks to execute before and after each artifact build step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before and after each artifact build step." + }, + "BuildpackArtifact": { + "properties": { + "builder": { + "type": "string", + "description": "builder image used.", + "x-intellij-html-description": "builder image used." + }, + "buildpacks": { + "items": { + "type": "string" + }, + "type": "array", + "description": "a list of strings, where each string is a specific buildpack to use with the builder. If you specify buildpacks the builder image automatic detection will be ignored. These buildpacks will be used to build the Image from your source code. Order matters.", + "x-intellij-html-description": "a list of strings, where each string is a specific buildpack to use with the builder. If you specify buildpacks the builder image automatic detection will be ignored. These buildpacks will be used to build the Image from your source code. Order matters.", + "default": "[]" + }, + "clearCache": { + "type": "boolean", + "description": "removes old cache volume associated with the specific image and supplies a clean cache volume for build.", + "x-intellij-html-description": "removes old cache volume associated with the specific image and supplies a clean cache volume for build.", + "default": "false" + }, + "dependencies": { + "$ref": "#/definitions/BuildpackDependencies", + "description": "file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact.", + "x-intellij-html-description": "file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact." + }, + "env": { + "items": { + "type": "string" + }, + "type": "array", + "description": "environment variables, in the `key=value` form, passed to the build. Values can use the go template syntax.", + "x-intellij-html-description": "environment variables, in the key=value form, passed to the build. Values can use the go template syntax.", + "default": "[]", + "examples": [ + "[\"key1=value1\", \"key2=value2\", \"key3={{.ENV_VARIABLE}}\"]" + ] + }, + "projectDescriptor": { + "type": "string", + "description": "path to the project descriptor file.", + "x-intellij-html-description": "path to the project descriptor file.", + "default": "project.toml" + }, + "runImage": { + "type": "string", + "description": "overrides the stack's default run image.", + "x-intellij-html-description": "overrides the stack's default run image." + }, + "trustBuilder": { + "type": "boolean", + "description": "indicates that the builder should be trusted.", + "x-intellij-html-description": "indicates that the builder should be trusted.", + "default": "false" + }, + "volumes": { + "items": { + "$ref": "#/definitions/BuildpackVolume" + }, + "type": "array", + "description": "support mounting host volumes into the container.", + "x-intellij-html-description": "support mounting host volumes into the container." + } + }, + "preferredOrder": [ + "builder", + "runImage", + "env", + "buildpacks", + "trustBuilder", + "clearCache", + "projectDescriptor", + "dependencies", + "volumes" + ], + "additionalProperties": false, + "type": "object", + "description": "*alpha* describes an artifact built using [Cloud Native Buildpacks](https://buildpacks.io/). It can be used to build images out of project's sources without any additional configuration.", + "x-intellij-html-description": "alpha describes an artifact built using Cloud Native Buildpacks. It can be used to build images out of project's sources without any additional configuration." + }, + "BuildpackDependencies": { + "properties": { + "ignore": { + "items": { + "type": "string" + }, + "type": "array", + "description": "specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both `paths` and in `ignore`, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with `paths`.", + "x-intellij-html-description": "specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with paths.", + "default": "[]" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array", + "description": "should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization.", + "x-intellij-html-description": "should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization.", + "default": "[]" + } + }, + "preferredOrder": [ + "paths", + "ignore" + ], + "additionalProperties": false, + "type": "object", + "description": "*alpha* used to specify dependencies for an artifact built by buildpacks.", + "x-intellij-html-description": "alpha used to specify dependencies for an artifact built by buildpacks." + }, + "BuildpackVolume": { + "required": [ + "host", + "target" + ], + "properties": { + "host": { + "type": "string", + "description": "local volume or absolute directory of the path to mount.", + "x-intellij-html-description": "local volume or absolute directory of the path to mount." + }, + "options": { + "type": "string", + "description": "specify a list of comma-separated mount options. Valid options are: `ro` (default): volume contents are read-only. `rw`: volume contents are readable and writable. `volume-opt==`: can be specified more than once, takes a key-value pair.", + "x-intellij-html-description": "specify a list of comma-separated mount options. Valid options are: ro (default): volume contents are read-only. rw: volume contents are readable and writable. volume-opt=<key>=<value>: can be specified more than once, takes a key-value pair.", + "enum": [ + "ro", + "rw", + "volume-opt==" + ] + }, + "target": { + "type": "string", + "description": "path where the file or directory is available in the container. It is strongly recommended to not specify locations under `/cnb` or `/layers`.", + "x-intellij-html-description": "path where the file or directory is available in the container. It is strongly recommended to not specify locations under /cnb or /layers." + } + }, + "preferredOrder": [ + "host", + "target", + "options" + ], + "additionalProperties": false, + "type": "object", + "description": "*alpha* used to mount host volumes or directories in the build container.", + "x-intellij-html-description": "alpha used to mount host volumes or directories in the build container." + }, + "CloudRunDeploy": { + "properties": { + "hooks": { + "$ref": "#/definitions/CloudRunDeployHooks", + "description": "describes a set of lifecycle host hooks that are executed before and after the Cloud Run deployer.", + "x-intellij-html-description": "describes a set of lifecycle host hooks that are executed before and after the Cloud Run deployer." + }, + "projectid": { + "type": "string", + "description": "the GCP Project to use for Cloud Run. If specified, all Services will be deployed to this project. If not specified, each Service will be deployed to the project specified in `metadata.namespace` of the Cloud Run manifest.", + "x-intellij-html-description": "the GCP Project to use for Cloud Run. If specified, all Services will be deployed to this project. If not specified, each Service will be deployed to the project specified in metadata.namespace of the Cloud Run manifest." + }, + "region": { + "type": "string", + "description": "GCP location to use for the Cloud Run Deploy. Must be one of the regions listed in https://cloud.google.com/run/docs/locations.", + "x-intellij-html-description": "GCP location to use for the Cloud Run Deploy. Must be one of the regions listed in https://cloud.google.com/run/docs/locations." + } + }, + "preferredOrder": [ + "projectid", + "region", + "hooks" + ], + "additionalProperties": false, + "type": "object", + "description": "*alpha* deploys the container to Google Cloud Run.", + "x-intellij-html-description": "alpha deploys the container to Google Cloud Run." + }, + "CloudRunDeployHooks": { + "properties": { + "after": { + "items": { + "$ref": "#/definitions/HostHook" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *after* the Cloud Run deployer.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute after the Cloud Run deployer." + }, + "before": { + "items": { + "$ref": "#/definitions/HostHook" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *before* the Cloud Run deployer.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before the Cloud Run deployer." + } + }, + "preferredOrder": [ + "before", + "after" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the list of lifecycle hooks to execute in the host before and after the Cloud Run deployer.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute in the host before and after the Cloud Run deployer." + }, + "ClusterDetails": { + "properties": { + "HTTPS_PROXY": { + "type": "string", + "description": "for kaniko pod.", + "x-intellij-html-description": "for kaniko pod." + }, + "HTTP_PROXY": { + "type": "string", + "description": "for kaniko pod.", + "x-intellij-html-description": "for kaniko pod." + }, + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "describes the Kubernetes annotations for the pod.", + "x-intellij-html-description": "describes the Kubernetes annotations for the pod.", + "default": "{}" + }, + "concurrency": { + "type": "integer", + "description": "how many artifacts can be built concurrently. 0 means \"no-limit\".", + "x-intellij-html-description": "how many artifacts can be built concurrently. 0 means "no-limit".", + "default": "0" + }, + "dockerConfig": { + "$ref": "#/definitions/DockerConfig", + "description": "describes how to mount the local Docker configuration into a pod.", + "x-intellij-html-description": "describes how to mount the local Docker configuration into a pod." + }, + "namespace": { + "type": "string", + "description": "Kubernetes namespace. Defaults to current namespace in Kubernetes configuration.", + "x-intellij-html-description": "Kubernetes namespace. Defaults to current namespace in Kubernetes configuration." + }, + "nodeSelector": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "describes the Kubernetes node selector for the pod.", + "x-intellij-html-description": "describes the Kubernetes node selector for the pod.", + "default": "{}" + }, + "pullSecretMountPath": { + "type": "string", + "description": "path the pull secret will be mounted at within the running container.", + "x-intellij-html-description": "path the pull secret will be mounted at within the running container." + }, + "pullSecretName": { + "type": "string", + "description": "name of the Kubernetes secret for pulling base images and pushing the final image. If given, the secret needs to contain the Google Cloud service account secret key under the key `kaniko-secret`.", + "x-intellij-html-description": "name of the Kubernetes secret for pulling base images and pushing the final image. If given, the secret needs to contain the Google Cloud service account secret key under the key kaniko-secret.", + "default": "kaniko-secret" + }, + "pullSecretPath": { + "type": "string", + "description": "path to the Google Cloud service account secret key file.", + "x-intellij-html-description": "path to the Google Cloud service account secret key file." + }, + "randomDockerConfigSecret": { + "type": "boolean", + "description": "adds a random UUID postfix to the default name of the docker secret to facilitate parallel builds, e.g. docker-cfgfd154022-c761-416f-8eb3-cf8258450b85.", + "x-intellij-html-description": "adds a random UUID postfix to the default name of the docker secret to facilitate parallel builds, e.g. docker-cfgfd154022-c761-416f-8eb3-cf8258450b85.", + "default": "false" + }, + "randomPullSecret": { + "type": "boolean", + "description": "adds a random UUID postfix to the default name of the pull secret to facilitate parallel builds, e.g. kaniko-secretdocker-cfgfd154022-c761-416f-8eb3-cf8258450b85.", + "x-intellij-html-description": "adds a random UUID postfix to the default name of the pull secret to facilitate parallel builds, e.g. kaniko-secretdocker-cfgfd154022-c761-416f-8eb3-cf8258450b85.", + "default": "false" + }, + "resources": { + "$ref": "#/definitions/ResourceRequirements", + "description": "define the resource requirements for the kaniko pod.", + "x-intellij-html-description": "define the resource requirements for the kaniko pod." + }, + "runAsUser": { + "type": "integer", + "description": "defines the UID to request for running the container. If omitted, no SecurityContext will be specified for the pod and will therefore be inherited from the service account.", + "x-intellij-html-description": "defines the UID to request for running the container. If omitted, no SecurityContext will be specified for the pod and will therefore be inherited from the service account." + }, + "serviceAccount": { + "type": "string", + "description": "describes the Kubernetes service account to use for the pod. Defaults to 'default'.", + "x-intellij-html-description": "describes the Kubernetes service account to use for the pod. Defaults to 'default'." + }, + "timeout": { + "type": "string", + "description": "amount of time (in seconds) that this build is allowed to run. Defaults to 20 minutes (`20m`).", + "x-intellij-html-description": "amount of time (in seconds) that this build is allowed to run. Defaults to 20 minutes (20m)." + }, + "tolerations": { + "items": {}, + "type": "array", + "description": "describes the Kubernetes tolerations for the pod.", + "x-intellij-html-description": "describes the Kubernetes tolerations for the pod.", + "default": "[]" + }, + "volumes": { + "items": {}, + "type": "array", + "description": "defines container mounts for ConfigMap and Secret resources.", + "x-intellij-html-description": "defines container mounts for ConfigMap and Secret resources.", + "default": "[]" + } + }, + "preferredOrder": [ + "HTTP_PROXY", + "HTTPS_PROXY", + "pullSecretPath", + "pullSecretName", + "pullSecretMountPath", + "namespace", + "timeout", + "dockerConfig", + "serviceAccount", + "tolerations", + "nodeSelector", + "annotations", + "runAsUser", + "resources", + "concurrency", + "volumes", + "randomPullSecret", + "randomDockerConfigSecret" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* describes how to do an on-cluster build.", + "x-intellij-html-description": "beta describes how to do an on-cluster build." + }, + "ConfigDependency": { + "properties": { + "activeProfiles": { + "items": { + "$ref": "#/definitions/ProfileDependency" + }, + "type": "array", + "description": "describes the list of profiles to activate when resolving the required configs. These profiles must exist in the imported config.", + "x-intellij-html-description": "describes the list of profiles to activate when resolving the required configs. These profiles must exist in the imported config." + }, + "configs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "includes specific named configs within the file path. If empty, then all configs in the file are included.", + "x-intellij-html-description": "includes specific named configs within the file path. If empty, then all configs in the file are included.", + "default": "[]" + }, + "git": { + "$ref": "#/definitions/GitInfo", + "description": "describes a remote git repository containing the required configs.", + "x-intellij-html-description": "describes a remote git repository containing the required configs." + }, + "path": { + "type": "string", + "description": "describes the path to the file containing the required configs.", + "x-intellij-html-description": "describes the path to the file containing the required configs." + } + }, + "preferredOrder": [ + "configs", + "path", + "git", + "activeProfiles" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a dependency on another skaffold configuration.", + "x-intellij-html-description": "describes a dependency on another skaffold configuration." + }, + "ContainerHook": { + "required": [ + "command" + ], + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "command to execute.", + "x-intellij-html-description": "command to execute.", + "default": "[]" + } + }, + "preferredOrder": [ + "command" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a lifecycle hook definition to execute on a container. The container name is inferred from the scope in which this hook is defined.", + "x-intellij-html-description": "describes a lifecycle hook definition to execute on a container. The container name is inferred from the scope in which this hook is defined." + }, + "CustomArtifact": { + "properties": { + "buildCommand": { + "type": "string", + "description": "command executed to build the image.", + "x-intellij-html-description": "command executed to build the image." + }, + "dependencies": { + "$ref": "#/definitions/CustomDependencies", + "description": "file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact.", + "x-intellij-html-description": "file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact." + } + }, + "preferredOrder": [ + "buildCommand", + "dependencies" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* describes an artifact built from a custom build script written by the user. It can be used to build images with builders that aren't directly integrated with skaffold.", + "x-intellij-html-description": "beta describes an artifact built from a custom build script written by the user. It can be used to build images with builders that aren't directly integrated with skaffold." + }, + "CustomDependencies": { + "properties": { + "command": { + "type": "string", + "description": "represents a custom command that skaffold executes to obtain dependencies. The output of this command *must* be a valid JSON array.", + "x-intellij-html-description": "represents a custom command that skaffold executes to obtain dependencies. The output of this command must be a valid JSON array." + }, + "dockerfile": { + "$ref": "#/definitions/DockerfileDependency", + "description": "should be set if the artifact is built from a Dockerfile, from which skaffold can determine dependencies.", + "x-intellij-html-description": "should be set if the artifact is built from a Dockerfile, from which skaffold can determine dependencies." + }, + "ignore": { + "items": { + "type": "string" + }, + "type": "array", + "description": "specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both `paths` and in `ignore`, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with `paths`.", + "x-intellij-html-description": "specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with paths.", + "default": "[]" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array", + "description": "should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization.", + "x-intellij-html-description": "should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization.", + "default": "[]" + } + }, + "preferredOrder": [ + "dockerfile", + "command", + "paths", + "ignore" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* used to specify dependencies for an artifact built by a custom build script. Either `dockerfile` or `paths` should be specified for file watching to work as expected.", + "x-intellij-html-description": "beta used to specify dependencies for an artifact built by a custom build script. Either dockerfile or paths should be specified for file watching to work as expected." + }, + "CustomTemplateTagger": { + "required": [ + "template" + ], + "properties": { + "components": { + "items": { + "$ref": "#/definitions/TaggerComponent" + }, + "type": "array", + "description": "TaggerComponents that the template (see field above) can be executed against.", + "x-intellij-html-description": "TaggerComponents that the template (see field above) can be executed against." + }, + "template": { + "type": "string", + "description": "used to produce the image name and tag. See golang [text/template](https://golang.org/pkg/text/template/). The template is executed against the provided components with those variables injected.", + "x-intellij-html-description": "used to produce the image name and tag. See golang text/template. The template is executed against the provided components with those variables injected.", + "examples": [ + "{{.DATE}}" + ] + } + }, + "preferredOrder": [ + "template", + "components" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* tags images with a configurable template string.", + "x-intellij-html-description": "beta tags images with a configurable template string." + }, + "CustomTest": { + "required": [ + "command" + ], + "properties": { + "command": { + "type": "string", + "description": "custom command to be executed. If the command exits with a non-zero return code, the test will be considered to have failed.", + "x-intellij-html-description": "custom command to be executed. If the command exits with a non-zero return code, the test will be considered to have failed." + }, + "dependencies": { + "$ref": "#/definitions/CustomTestDependencies", + "description": "additional test-specific file dependencies; changes to these files will re-run this test.", + "x-intellij-html-description": "additional test-specific file dependencies; changes to these files will re-run this test." + }, + "timeoutSeconds": { + "type": "integer", + "description": "sets the wait time for skaffold for the command to complete. If unset or 0, Skaffold will wait until the command completes.", + "x-intellij-html-description": "sets the wait time for skaffold for the command to complete. If unset or 0, Skaffold will wait until the command completes." + } + }, + "preferredOrder": [ + "command", + "timeoutSeconds", + "dependencies" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the custom test command provided by the user. Custom tests are run after an image build whenever build or test dependencies are changed.", + "x-intellij-html-description": "describes the custom test command provided by the user. Custom tests are run after an image build whenever build or test dependencies are changed." + }, + "CustomTestDependencies": { + "properties": { + "command": { + "type": "string", + "description": "represents a command that skaffold executes to obtain dependencies. The output of this command *must* be a valid JSON array.", + "x-intellij-html-description": "represents a command that skaffold executes to obtain dependencies. The output of this command must be a valid JSON array." + }, + "ignore": { + "items": { + "type": "string" + }, + "type": "array", + "description": "specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both `paths` and in `ignore`, it will be ignored, and will be excluded from both retest and file synchronization. Will only work in conjunction with `paths`.", + "x-intellij-html-description": "specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both retest and file synchronization. Will only work in conjunction with paths.", + "default": "[]" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array", + "description": "locates the file dependencies for the command relative to workspace. Paths should be set to the file dependencies for this command, so that the skaffold file watcher knows when to retest and perform file synchronization.", + "x-intellij-html-description": "locates the file dependencies for the command relative to workspace. Paths should be set to the file dependencies for this command, so that the skaffold file watcher knows when to retest and perform file synchronization.", + "default": "[]", + "examples": [ + "[\"src/test/**\"]" + ] + } + }, + "preferredOrder": [ + "command", + "paths", + "ignore" + ], + "additionalProperties": false, + "type": "object", + "description": "used to specify dependencies for custom test command. `paths` should be specified for file watching to work as expected.", + "x-intellij-html-description": "used to specify dependencies for custom test command. paths should be specified for file watching to work as expected." + }, + "DateTimeTagger": { + "properties": { + "format": { + "type": "string", + "description": "formats the date and time. See [#Time.Format](https://golang.org/pkg/time/#Time.Format).", + "x-intellij-html-description": "formats the date and time. See #Time.Format.", + "default": "2006-01-02_15-04-05.999_MST" + }, + "timezone": { + "type": "string", + "description": "sets the timezone for the date and time. See [Time.LoadLocation](https://golang.org/pkg/time/#Time.LoadLocation). Defaults to the local timezone.", + "x-intellij-html-description": "sets the timezone for the date and time. See Time.LoadLocation. Defaults to the local timezone." + } + }, + "preferredOrder": [ + "format", + "timezone" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* tags images with the build timestamp.", + "x-intellij-html-description": "beta tags images with the build timestamp." + }, + "DeployConfig": { + "properties": { + "cloudrun": { + "$ref": "#/definitions/CloudRunDeploy", + "description": "*alpha* deploys to Google Cloud Run using the Cloud Run v1 API.", + "x-intellij-html-description": "alpha deploys to Google Cloud Run using the Cloud Run v1 API." + }, + "docker": { + "$ref": "#/definitions/DockerDeploy", + "description": "*alpha* uses the `docker` CLI to create application containers in Docker.", + "x-intellij-html-description": "alpha uses the docker CLI to create application containers in Docker." + }, + "helm": { + "$ref": "#/definitions/LegacyHelmDeploy", + "description": "*beta* uses the `helm` CLI to apply the charts to the cluster.", + "x-intellij-html-description": "beta uses the helm CLI to apply the charts to the cluster." + }, + "kpt": { + "$ref": "#/definitions/KptDeploy", + "description": "*alpha* uses the `kpt` CLI to manage and deploy manifests.", + "x-intellij-html-description": "alpha uses the kpt CLI to manage and deploy manifests." + }, + "kubeContext": { + "type": "string", + "description": "Kubernetes context that Skaffold should deploy to.", + "x-intellij-html-description": "Kubernetes context that Skaffold should deploy to.", + "examples": [ + "minikube" + ] + }, + "kubectl": { + "$ref": "#/definitions/KubectlDeploy", + "description": "*beta* uses a client side `kubectl apply` to deploy manifests. You'll need a `kubectl` CLI version installed that's compatible with your cluster.", + "x-intellij-html-description": "beta uses a client side kubectl apply to deploy manifests. You'll need a kubectl CLI version installed that's compatible with your cluster." + }, + "logs": { + "$ref": "#/definitions/LogsConfig", + "description": "configures how container logs are printed as a result of a deployment.", + "x-intellij-html-description": "configures how container logs are printed as a result of a deployment." + }, + "statusCheck": { + "type": "boolean", + "description": "*beta* enables waiting for deployments to stabilize.", + "x-intellij-html-description": "beta enables waiting for deployments to stabilize." + }, + "statusCheckDeadlineSeconds": { + "type": "integer", + "description": "*beta* deadline for deployments to stabilize in seconds.", + "x-intellij-html-description": "beta deadline for deployments to stabilize in seconds." + }, + "tolerateFailuresUntilDeadline": { + "type": "boolean", + "description": "configures the Skaffold \"status-check\" to tolerate failures (flapping deployments, etc.) until the statusCheckDeadlineSeconds duration or k8s object timeouts such as progressDeadlineSeconds, etc.", + "x-intellij-html-description": "configures the Skaffold "status-check" to tolerate failures (flapping deployments, etc.) until the statusCheckDeadlineSeconds duration or k8s object timeouts such as progressDeadlineSeconds, etc.", + "default": "false" + } + }, + "preferredOrder": [ + "docker", + "helm", + "kpt", + "kubectl", + "cloudrun", + "statusCheck", + "statusCheckDeadlineSeconds", + "tolerateFailuresUntilDeadline", + "kubeContext", + "logs" + ], + "additionalProperties": false, + "type": "object", + "description": "contains all the configuration needed by the deploy steps.", + "x-intellij-html-description": "contains all the configuration needed by the deploy steps." + }, + "DeployHookItem": { + "properties": { + "container": { + "$ref": "#/definitions/NamedContainerHook", + "description": "describes a single lifecycle hook to run on a container.", + "x-intellij-html-description": "describes a single lifecycle hook to run on a container." + }, + "host": { + "$ref": "#/definitions/HostHook", + "description": "describes a single lifecycle hook to run on the host machine.", + "x-intellij-html-description": "describes a single lifecycle hook to run on the host machine." + } + }, + "preferredOrder": [ + "host", + "container" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a single lifecycle hook to execute before or after each deployer step.", + "x-intellij-html-description": "describes a single lifecycle hook to execute before or after each deployer step." + }, + "DeployHooks": { + "properties": { + "after": { + "items": { + "$ref": "#/definitions/DeployHookItem" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *after* each deployer step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute after each deployer step." + }, + "before": { + "items": { + "$ref": "#/definitions/DeployHookItem" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *before* each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during `skaffold dev`).", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev)." + } + }, + "preferredOrder": [ + "before", + "after" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the list of lifecycle hooks to execute before and after each deployer step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before and after each deployer step." + }, + "DockerArtifact": { + "properties": { + "addHost": { + "items": { + "type": "string" + }, + "type": "array", + "description": "add host.", + "x-intellij-html-description": "add host.", + "default": "[]", + "examples": [ + "[\"host1:ip1\", \"host2:ip2\"]" + ] + }, + "buildArgs": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "arguments passed to the docker build.", + "x-intellij-html-description": "arguments passed to the docker build.", + "default": "{}", + "examples": [ + "{\"key1\": \"value1\", \"key2\": \"{{ .ENV_VAR }}\"}" + ] + }, + "cacheFrom": { + "items": { + "type": "string" + }, + "type": "array", + "description": "the Docker images used as cache sources.", + "x-intellij-html-description": "the Docker images used as cache sources.", + "default": "[]", + "examples": [ + "[\"golang:1.10.1-alpine3.7\", \"alpine:3.7\"]" + ] + }, + "cliFlags": { + "items": { + "type": "string" + }, + "type": "array", + "description": "any additional flags to pass to the local daemon during a build. These flags are only used during a build through the Docker CLI.", + "x-intellij-html-description": "any additional flags to pass to the local daemon during a build. These flags are only used during a build through the Docker CLI.", + "default": "[]" + }, + "dockerfile": { + "type": "string", + "description": "locates the Dockerfile relative to workspace.", + "x-intellij-html-description": "locates the Dockerfile relative to workspace.", + "default": "Dockerfile" + }, + "network": { + "type": "string", + "description": "passed through to docker and overrides the network configuration of docker builder. If unset, use whatever is configured in the underlying docker daemon. Valid modes are `host`: use the host's networking stack. `bridge`: use the bridged network configuration. `container:`: reuse another container's network stack. `none`: no networking in the container.", + "x-intellij-html-description": "passed through to docker and overrides the network configuration of docker builder. If unset, use whatever is configured in the underlying docker daemon. Valid modes are host: use the host's networking stack. bridge: use the bridged network configuration. container:<name|id>: reuse another container's network stack. none: no networking in the container.", + "enum": [ + "host", + "bridge", + "container:", + "none" + ] + }, + "noCache": { + "type": "boolean", + "description": "set to true to pass in --no-cache to docker build, which will prevent caching.", + "x-intellij-html-description": "set to true to pass in --no-cache to docker build, which will prevent caching.", + "default": "false" + }, + "pullParent": { + "type": "boolean", + "description": "used to attempt pulling the parent image even if an older image exists locally.", + "x-intellij-html-description": "used to attempt pulling the parent image even if an older image exists locally.", + "default": "false" + }, + "secrets": { + "items": { + "$ref": "#/definitions/DockerSecret" + }, + "type": "array", + "description": "used to pass in --secret to docker build, `useBuildKit: true` is required.", + "x-intellij-html-description": "used to pass in --secret to docker build, useBuildKit: true is required." + }, + "squash": { + "type": "boolean", + "description": "used to pass in --squash to docker build to squash docker image layers into single layer.", + "x-intellij-html-description": "used to pass in --squash to docker build to squash docker image layers into single layer.", + "default": "false" + }, + "ssh": { + "type": "string", + "description": "used to pass in --ssh to docker build to use SSH agent. Format is \"default|[=|[,]]\".", + "x-intellij-html-description": "used to pass in --ssh to docker build to use SSH agent. Format is "default|[=|[,]]"." + }, + "target": { + "type": "string", + "description": "Dockerfile target name to build.", + "x-intellij-html-description": "Dockerfile target name to build." + } + }, + "preferredOrder": [ + "dockerfile", + "target", + "buildArgs", + "network", + "addHost", + "cacheFrom", + "cliFlags", + "pullParent", + "noCache", + "squash", + "secrets", + "ssh" + ], + "additionalProperties": false, + "type": "object", + "description": "describes an artifact built from a Dockerfile, usually using `docker build`.", + "x-intellij-html-description": "describes an artifact built from a Dockerfile, usually using docker build." + }, + "DockerConfig": { + "properties": { + "path": { + "type": "string", + "description": "path to the docker `config.json`.", + "x-intellij-html-description": "path to the docker config.json." + }, + "secretName": { + "type": "string", + "description": "Kubernetes secret that contains the `config.json` Docker configuration. Note that the expected secret type is not 'kubernetes.io/dockerconfigjson' but 'Opaque'.", + "x-intellij-html-description": "Kubernetes secret that contains the config.json Docker configuration. Note that the expected secret type is not 'kubernetes.io/dockerconfigjson' but 'Opaque'." + } + }, + "preferredOrder": [ + "path", + "secretName" + ], + "additionalProperties": false, + "type": "object", + "description": "contains information about the docker `config.json` to mount.", + "x-intellij-html-description": "contains information about the docker config.json to mount." + }, + "DockerDeploy": { + "required": [ + "images" + ], + "properties": { + "images": { + "items": { + "type": "string" + }, + "type": "array", + "description": "container images to run in Docker.", + "x-intellij-html-description": "container images to run in Docker.", + "default": "[]" + }, + "useCompose": { + "type": "boolean", + "description": "tells skaffold whether or not to deploy using `docker-compose`.", + "x-intellij-html-description": "tells skaffold whether or not to deploy using docker-compose.", + "default": "false" + } + }, + "preferredOrder": [ + "useCompose", + "images" + ], + "additionalProperties": false, + "type": "object", + "description": "uses the `docker` CLI to create application containers in Docker.", + "x-intellij-html-description": "uses the docker CLI to create application containers in Docker." + }, + "DockerSecret": { + "required": [ + "id" + ], + "properties": { + "env": { + "type": "string", + "description": "environment variable name containing the secret value.", + "x-intellij-html-description": "environment variable name containing the secret value." + }, + "id": { + "type": "string", + "description": "id of the secret.", + "x-intellij-html-description": "id of the secret." + }, + "src": { + "type": "string", + "description": "path to the secret on the host machine.", + "x-intellij-html-description": "path to the secret on the host machine." + } + }, + "preferredOrder": [ + "id", + "src", + "env" + ], + "additionalProperties": false, + "type": "object", + "description": "used to pass in --secret to docker build, `useBuildKit: true` is required.", + "x-intellij-html-description": "used to pass in --secret to docker build, useBuildKit: true is required." + }, + "DockerfileDependency": { + "properties": { + "buildArgs": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "key/value pairs used to resolve values of `ARG` instructions in a Dockerfile. Values can be constants or environment variables via the go template syntax.", + "x-intellij-html-description": "key/value pairs used to resolve values of ARG instructions in a Dockerfile. Values can be constants or environment variables via the go template syntax.", + "default": "{}", + "examples": [ + "{\"key1\": \"value1\", \"key2\": \"value2\", \"key3\": \"'{{.ENV_VARIABLE}}'\"}" + ] + }, + "path": { + "type": "string", + "description": "locates the Dockerfile relative to workspace.", + "x-intellij-html-description": "locates the Dockerfile relative to workspace." + } + }, + "preferredOrder": [ + "path", + "buildArgs" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile.", + "x-intellij-html-description": "beta used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile." + }, + "EnvTemplateTagger": { + "required": [ + "template" + ], + "properties": { + "template": { + "type": "string", + "description": "used to produce the image name and tag. See golang [text/template](https://golang.org/pkg/text/template/). The template is executed against the current environment, with those variables injected.", + "x-intellij-html-description": "used to produce the image name and tag. See golang text/template. The template is executed against the current environment, with those variables injected.", + "examples": [ + "{{.RELEASE}}" + ] + } + }, + "preferredOrder": [ + "template" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* tags images with a configurable template string.", + "x-intellij-html-description": "beta tags images with a configurable template string." + }, + "GitInfo": { + "required": [ + "repo" + ], + "properties": { + "path": { + "type": "string", + "description": "relative path from the repo root to the skaffold configuration file. eg. `getting-started/skaffold.yaml`.", + "x-intellij-html-description": "relative path from the repo root to the skaffold configuration file. eg. getting-started/skaffold.yaml." + }, + "ref": { + "type": "string", + "description": "git ref the package should be cloned from. eg. `master` or `main`.", + "x-intellij-html-description": "git ref the package should be cloned from. eg. master or main." + }, + "repo": { + "type": "string", + "description": "git repository the package should be cloned from. e.g. `https://github.com/GoogleContainerTools/skaffold.git`.", + "x-intellij-html-description": "git repository the package should be cloned from. e.g. https://github.com/GoogleContainerTools/skaffold.git." + }, + "sync": { + "type": "boolean", + "description": "when set to `true` will reset the cached repository to the latest commit from remote on every run. To use the cached repository with uncommitted changes or unpushed commits, it needs to be set to `false`.", + "x-intellij-html-description": "when set to true will reset the cached repository to the latest commit from remote on every run. To use the cached repository with uncommitted changes or unpushed commits, it needs to be set to false." + } + }, + "preferredOrder": [ + "repo", + "path", + "ref", + "sync" + ], + "additionalProperties": false, + "type": "object", + "description": "contains information on the origin of skaffold configurations cloned from a git repository.", + "x-intellij-html-description": "contains information on the origin of skaffold configurations cloned from a git repository." + }, + "GitTagger": { + "properties": { + "ignoreChanges": { + "type": "boolean", + "description": "specifies whether to omit the `-dirty` postfix if there are uncommitted changes.", + "x-intellij-html-description": "specifies whether to omit the -dirty postfix if there are uncommitted changes.", + "default": "false" + }, + "prefix": { + "type": "string", + "description": "adds a fixed prefix to the tag.", + "x-intellij-html-description": "adds a fixed prefix to the tag." + }, + "variant": { + "type": "string", + "description": "determines the behavior of the git tagger. Valid variants are: `Tags` (default): use git tags or fall back to abbreviated commit hash. `CommitSha`: use the full git commit sha. `AbbrevCommitSha`: use the abbreviated git commit sha. `TreeSha`: use the full tree hash of the artifact workingdir. `AbbrevTreeSha`: use the abbreviated tree hash of the artifact workingdir.", + "x-intellij-html-description": "determines the behavior of the git tagger. Valid variants are: Tags (default): use git tags or fall back to abbreviated commit hash. CommitSha: use the full git commit sha. AbbrevCommitSha: use the abbreviated git commit sha. TreeSha: use the full tree hash of the artifact workingdir. AbbrevTreeSha: use the abbreviated tree hash of the artifact workingdir.", + "enum": [ + "Tags", + "CommitSha", + "AbbrevCommitSha", + "TreeSha", + "AbbrevTreeSha" + ] + } + }, + "preferredOrder": [ + "variant", + "prefix", + "ignoreChanges" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* tags images with the git tag or commit of the artifact's workspace.", + "x-intellij-html-description": "beta tags images with the git tag or commit of the artifact's workspace." + }, + "GoogleCloudBuild": { + "properties": { + "concurrency": { + "type": "integer", + "description": "how many artifacts can be built concurrently. 0 means \"no-limit\".", + "x-intellij-html-description": "how many artifacts can be built concurrently. 0 means "no-limit".", + "default": "0" + }, + "diskSizeGb": { + "type": "integer", + "description": "disk size of the VM that runs the build. See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions).", + "x-intellij-html-description": "disk size of the VM that runs the build. See Cloud Build Reference." + }, + "dockerImage": { + "type": "string", + "description": "image that runs a Docker build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", + "x-intellij-html-description": "image that runs a Docker build. See Cloud Builders.", + "default": "gcr.io/cloud-builders/docker" + }, + "gradleImage": { + "type": "string", + "description": "image that runs a Gradle build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", + "x-intellij-html-description": "image that runs a Gradle build. See Cloud Builders.", + "default": "gcr.io/cloud-builders/gradle" + }, + "kanikoImage": { + "type": "string", + "description": "image that runs a Kaniko build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", + "x-intellij-html-description": "image that runs a Kaniko build. See Cloud Builders.", + "default": "gcr.io/kaniko-project/executor" + }, + "koImage": { + "type": "string", + "description": "image that runs a ko build. The image must contain Skaffold, Go, and a shell (runnable as `sh`) that supports here documents. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", + "x-intellij-html-description": "image that runs a ko build. The image must contain Skaffold, Go, and a shell (runnable as sh) that supports here documents. See Cloud Builders.", + "default": "gcr.io/k8s-skaffold/skaffold" + }, + "logStreamingOption": { + "type": "string", + "description": "specifies the behavior when writing build logs to Google Cloud Storage. Valid options are: `STREAM_DEFAULT`: Service may automatically determine build log streaming behavior. `STREAM_ON`: Build logs should be streamed to Google Cloud Storage. `STREAM_OFF`: Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed. See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#logstreamingoption).", + "x-intellij-html-description": "specifies the behavior when writing build logs to Google Cloud Storage. Valid options are: STREAM_DEFAULT: Service may automatically determine build log streaming behavior. STREAM_ON: Build logs should be streamed to Google Cloud Storage. STREAM_OFF: Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed. See Cloud Build Reference.", + "enum": [ + "STREAM_DEFAULT", + "STREAM_ON", + "STREAM_OFF" + ] + }, + "logging": { + "type": "string", + "description": "specifies the logging mode. Valid modes are: `LOGGING_UNSPECIFIED`: The service determines the logging mode. `LEGACY`: Stackdriver logging and Cloud Storage logging are enabled (default). `GCS_ONLY`: Only Cloud Storage logging is enabled. See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#loggingmode).", + "x-intellij-html-description": "specifies the logging mode. Valid modes are: LOGGING_UNSPECIFIED: The service determines the logging mode. LEGACY: Stackdriver logging and Cloud Storage logging are enabled (default). GCS_ONLY: Only Cloud Storage logging is enabled. See Cloud Build Reference.", + "enum": [ + "LOGGING_UNSPECIFIED", + "LEGACY", + "GCS_ONLY" + ] + }, + "machineType": { + "type": "string", + "description": "type of the VM that runs the build. See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions).", + "x-intellij-html-description": "type of the VM that runs the build. See Cloud Build Reference." + }, + "mavenImage": { + "type": "string", + "description": "image that runs a Maven build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", + "x-intellij-html-description": "image that runs a Maven build. See Cloud Builders.", + "default": "gcr.io/cloud-builders/mvn" + }, + "packImage": { + "type": "string", + "description": "image that runs a Cloud Native Buildpacks build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", + "x-intellij-html-description": "image that runs a Cloud Native Buildpacks build. See Cloud Builders.", + "default": "gcr.io/k8s-skaffold/pack" + }, + "platformEmulatorInstallStep": { + "$ref": "#/definitions/PlatformEmulatorInstallStep", + "description": "specifies a pre-build step to install the required tooling for QEMU emulation on the GoogleCloudBuild containers. This enables performing cross-platform builds on GoogleCloudBuild. If unspecified, Skaffold uses the `docker/binfmt` image by default.", + "x-intellij-html-description": "specifies a pre-build step to install the required tooling for QEMU emulation on the GoogleCloudBuild containers. This enables performing cross-platform builds on GoogleCloudBuild. If unspecified, Skaffold uses the docker/binfmt image by default." + }, + "projectId": { + "type": "string", + "description": "ID of your Cloud Platform Project. If it is not provided, Skaffold will guess it from the image name. For example, given the artifact image name `gcr.io/myproject/image`, Skaffold will use the `myproject` GCP project.", + "x-intellij-html-description": "ID of your Cloud Platform Project. If it is not provided, Skaffold will guess it from the image name. For example, given the artifact image name gcr.io/myproject/image, Skaffold will use the myproject GCP project." + }, + "region": { + "type": "string", + "description": "configures the region to run the build. If WorkerPool is configured, the region will be deduced from the WorkerPool configuration. If neither WorkerPool nor Region is configured, the build will be run in global(non-regional). See [Cloud Build locations](https://cloud.google.com/build/docs/locations).", + "x-intellij-html-description": "configures the region to run the build. If WorkerPool is configured, the region will be deduced from the WorkerPool configuration. If neither WorkerPool nor Region is configured, the build will be run in global(non-regional). See Cloud Build locations." + }, + "serviceAccount": { + "type": "string", + "description": "Google Cloud platform service account used by Cloud Build. If unspecified, it defaults to the Cloud Build service account generated when the Cloud Build API is enabled.", + "x-intellij-html-description": "Google Cloud platform service account used by Cloud Build. If unspecified, it defaults to the Cloud Build service account generated when the Cloud Build API is enabled." + }, + "timeout": { + "type": "string", + "description": "amount of time (in seconds) that this build should be allowed to run. See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#resource-build).", + "x-intellij-html-description": "amount of time (in seconds) that this build should be allowed to run. See Cloud Build Reference." + }, + "workerPool": { + "type": "string", + "description": "configures a pool of workers to run the build.", + "x-intellij-html-description": "configures a pool of workers to run the build." + } + }, + "preferredOrder": [ + "projectId", + "diskSizeGb", + "machineType", + "timeout", + "logging", + "logStreamingOption", + "dockerImage", + "kanikoImage", + "mavenImage", + "gradleImage", + "packImage", + "koImage", + "concurrency", + "workerPool", + "region", + "platformEmulatorInstallStep", + "serviceAccount" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* describes how to do a remote build on [Google Cloud Build](https://cloud.google.com/cloud-build/docs/). Docker and Jib artifacts can be built on Cloud Build. The `projectId` needs to be provided and the currently logged in user should be given permissions to trigger new builds.", + "x-intellij-html-description": "beta describes how to do a remote build on Google Cloud Build. Docker and Jib artifacts can be built on Cloud Build. The projectId needs to be provided and the currently logged in user should be given permissions to trigger new builds." + }, + "Helm": { + "required": [ + "releases" + ], + "properties": { + "flags": { + "$ref": "#/definitions/HelmDeployFlags", + "description": "additional option flags that are passed on the command line to `helm`.", + "x-intellij-html-description": "additional option flags that are passed on the command line to helm." + }, + "releases": { + "items": { + "$ref": "#/definitions/HelmRelease" + }, + "type": "array", + "description": "a list of Helm releases.", + "x-intellij-html-description": "a list of Helm releases." + } + }, + "preferredOrder": [ + "flags", + "releases" + ], + "additionalProperties": false, + "type": "object", + "description": "defines the manifests from helm releases.", + "x-intellij-html-description": "defines the manifests from helm releases." + }, + "HelmDeployFlags": { + "properties": { + "global": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional flags passed on every command.", + "x-intellij-html-description": "additional flags passed on every command.", + "default": "[]" + }, + "install": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional flags passed to (`helm install`).", + "x-intellij-html-description": "additional flags passed to (helm install).", + "default": "[]" + }, + "upgrade": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional flags passed to (`helm upgrade`).", + "x-intellij-html-description": "additional flags passed to (helm upgrade).", + "default": "[]" + } + }, + "preferredOrder": [ + "global", + "install", + "upgrade" + ], + "additionalProperties": false, + "type": "object", + "description": "additional option flags that are passed on the command line to `helm`.", + "x-intellij-html-description": "additional option flags that are passed on the command line to helm." + }, + "HelmPackaged": { + "properties": { + "appVersion": { + "type": "string", + "description": "sets the `appVersion` on the chart to this version.", + "x-intellij-html-description": "sets the appVersion on the chart to this version." + }, + "version": { + "type": "string", + "description": "sets the `version` on the chart to this semver version.", + "x-intellij-html-description": "sets the version on the chart to this semver version." + } + }, + "preferredOrder": [ + "version", + "appVersion" + ], + "additionalProperties": false, + "type": "object", + "description": "parameters for packaging helm chart (`helm package`).", + "x-intellij-html-description": "parameters for packaging helm chart (helm package)." + }, + "HelmRelease": { + "required": [ + "name" + ], + "properties": { + "chartPath": { + "type": "string", + "description": "local path to a packaged Helm chart or an unpacked Helm chart directory.", + "x-intellij-html-description": "local path to a packaged Helm chart or an unpacked Helm chart directory." + }, + "createNamespace": { + "type": "boolean", + "description": "if `true`, Skaffold will send `--create-namespace` flag to Helm CLI. `--create-namespace` flag is available in Helm since version 3.2. Defaults is `false`.", + "x-intellij-html-description": "if true, Skaffold will send --create-namespace flag to Helm CLI. --create-namespace flag is available in Helm since version 3.2. Defaults is false." + }, + "name": { + "type": "string", + "description": "name of the Helm release. It accepts environment variables via the go template syntax.", + "x-intellij-html-description": "name of the Helm release. It accepts environment variables via the go template syntax." + }, + "namespace": { + "type": "string", + "description": "Kubernetes namespace.", + "x-intellij-html-description": "Kubernetes namespace." + }, + "overrides": { + "description": "key-value pairs. If present, Skaffold will build a Helm `values` file that overrides the original and use it to call Helm CLI (`--f` flag).", + "x-intellij-html-description": "key-value pairs. If present, Skaffold will build a Helm values file that overrides the original and use it to call Helm CLI (--f flag)." + }, + "packaged": { + "$ref": "#/definitions/HelmPackaged", + "description": "parameters for packaging helm chart (`helm package`).", + "x-intellij-html-description": "parameters for packaging helm chart (helm package)." + }, + "recreatePods": { + "type": "boolean", + "description": "if `true`, Skaffold will send `--recreate-pods` flag to Helm CLI when upgrading a new version of a chart in subsequent dev loop deploy.", + "x-intellij-html-description": "if true, Skaffold will send --recreate-pods flag to Helm CLI when upgrading a new version of a chart in subsequent dev loop deploy.", + "default": "false" + }, + "remoteChart": { + "type": "string", + "description": "refers to a remote Helm chart reference or URL.", + "x-intellij-html-description": "refers to a remote Helm chart reference or URL." + }, + "repo": { + "type": "string", + "description": "specifies the helm repository for remote charts. If present, Skaffold will send `--repo` Helm CLI flag or flags.", + "x-intellij-html-description": "specifies the helm repository for remote charts. If present, Skaffold will send --repo Helm CLI flag or flags." + }, + "setFiles": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "key-value pairs. If present, Skaffold will send `--set-file` flag to Helm CLI and append all pairs after the flag.", + "x-intellij-html-description": "key-value pairs. If present, Skaffold will send --set-file flag to Helm CLI and append all pairs after the flag.", + "default": "{}" + }, + "setValueTemplates": { + "description": "key-value pairs. If present, Skaffold will try to parse the value part of each key-value pair using environment variables in the system, then send `--set` flag to Helm CLI and append all parsed pairs after the flag.", + "x-intellij-html-description": "key-value pairs. If present, Skaffold will try to parse the value part of each key-value pair using environment variables in the system, then send --set flag to Helm CLI and append all parsed pairs after the flag." + }, + "setValues": { + "description": "key-value pairs. If present, Skaffold will send `--set` flag to Helm CLI and append all pairs after the flag.", + "x-intellij-html-description": "key-value pairs. If present, Skaffold will send --set flag to Helm CLI and append all pairs after the flag." + }, + "skipBuildDependencies": { + "type": "boolean", + "description": "should build dependencies be skipped. Ignored for `remoteChart`.", + "x-intellij-html-description": "should build dependencies be skipped. Ignored for remoteChart.", + "default": "false" + }, + "skipTests": { + "type": "boolean", + "description": "should ignore helm test during manifests generation.", + "x-intellij-html-description": "should ignore helm test during manifests generation.", + "default": "false" + }, + "upgradeOnChange": { + "type": "boolean", + "description": "specifies whether to upgrade helm chart on code changes. Default is `true` when helm chart is local (has `chartPath`). Default is `false` when helm chart is remote (has `remoteChart`).", + "x-intellij-html-description": "specifies whether to upgrade helm chart on code changes. Default is true when helm chart is local (has chartPath). Default is false when helm chart is remote (has remoteChart)." + }, + "useHelmSecrets": { + "type": "boolean", + "description": "instructs skaffold to use secrets plugin on deployment.", + "x-intellij-html-description": "instructs skaffold to use secrets plugin on deployment.", + "default": "false" + }, + "valuesFiles": { + "items": { + "type": "string" + }, + "type": "array", + "description": "paths to the Helm `values` files.", + "x-intellij-html-description": "paths to the Helm values files.", + "default": "[]" + }, + "version": { + "type": "string", + "description": "version of the chart.", + "x-intellij-html-description": "version of the chart." + }, + "wait": { + "type": "boolean", + "description": "if `true`, Skaffold will send `--wait` flag to Helm CLI.", + "x-intellij-html-description": "if true, Skaffold will send --wait flag to Helm CLI.", + "default": "false" + } + }, + "preferredOrder": [ + "name", + "chartPath", + "remoteChart", + "valuesFiles", + "namespace", + "version", + "setValues", + "setValueTemplates", + "setFiles", + "createNamespace", + "wait", + "recreatePods", + "skipBuildDependencies", + "skipTests", + "useHelmSecrets", + "repo", + "upgradeOnChange", + "overrides", + "packaged" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a helm release to be deployed.", + "x-intellij-html-description": "describes a helm release to be deployed." + }, + "HostHook": { + "required": [ + "command" + ], + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "command to execute.", + "x-intellij-html-description": "command to execute.", + "default": "[]" + }, + "dir": { + "type": "string", + "description": "specifies the working directory of the command. If empty, the command runs in the calling process's current directory.", + "x-intellij-html-description": "specifies the working directory of the command. If empty, the command runs in the calling process's current directory." + }, + "os": { + "items": { + "type": "string" + }, + "type": "array", + "description": "an optional slice of operating system names. If the host machine OS is different, then it skips execution.", + "x-intellij-html-description": "an optional slice of operating system names. If the host machine OS is different, then it skips execution.", + "default": "[]" + } + }, + "preferredOrder": [ + "command", + "os", + "dir" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a lifecycle hook definition to execute on the host machine.", + "x-intellij-html-description": "describes a lifecycle hook definition to execute on the host machine." + }, + "InputDigest": { + "type": "object", + "description": "*beta* tags hashes the image content.", + "x-intellij-html-description": "beta tags hashes the image content." + }, + "JSONParseConfig": { + "properties": { + "fields": { + "items": { + "type": "string" + }, + "type": "array", + "description": "specifies which top level fields should be printed.", + "x-intellij-html-description": "specifies which top level fields should be printed.", + "default": "[]" + } + }, + "preferredOrder": [ + "fields" + ], + "additionalProperties": false, + "type": "object", + "description": "defines the rules for parsing/outputting json logs.", + "x-intellij-html-description": "defines the rules for parsing/outputting json logs." + }, + "JSONPatch": { + "required": [ + "path" + ], + "properties": { + "from": { + "type": "string", + "description": "source position in the yaml, used for `copy` or `move` operations.", + "x-intellij-html-description": "source position in the yaml, used for copy or move operations." + }, + "op": { + "type": "string", + "description": "operation carried by the patch: `add`, `remove`, `replace`, `move`, `copy` or `test`.", + "x-intellij-html-description": "operation carried by the patch: add, remove, replace, move, copy or test.", + "default": "replace" + }, + "path": { + "type": "string", + "description": "position in the yaml where the operation takes place. For example, this targets the `dockerfile` of the first artifact built.", + "x-intellij-html-description": "position in the yaml where the operation takes place. For example, this targets the dockerfile of the first artifact built.", + "examples": [ + "/build/artifacts/0/docker/dockerfile" + ] + }, + "value": { + "description": "value to apply. Can be any portion of yaml.", + "x-intellij-html-description": "value to apply. Can be any portion of yaml." + } + }, + "preferredOrder": [ + "op", + "path", + "from", + "value" + ], + "additionalProperties": false, + "type": "object", + "description": "patch to be applied by a profile.", + "x-intellij-html-description": "patch to be applied by a profile." + }, + "JibArtifact": { + "properties": { + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional build flags passed to the builder.", + "x-intellij-html-description": "additional build flags passed to the builder.", + "default": "[]", + "examples": [ + "[\"--no-build-cache\"]" + ] + }, + "fromImage": { + "type": "string", + "description": "overrides the configured jib base image.", + "x-intellij-html-description": "overrides the configured jib base image." + }, + "project": { + "type": "string", + "description": "selects which sub-project to build for multi-module builds.", + "x-intellij-html-description": "selects which sub-project to build for multi-module builds." + }, + "type": { + "type": "string", + "description": "the Jib builder type; normally determined automatically. Valid types are `maven`: for Maven. `gradle`: for Gradle.", + "x-intellij-html-description": "the Jib builder type; normally determined automatically. Valid types are maven: for Maven. gradle: for Gradle.", + "enum": [ + "maven", + "gradle" + ] + } + }, + "preferredOrder": [ + "project", + "args", + "type", + "fromImage" + ], + "additionalProperties": false, + "type": "object", + "description": "builds images using the [Jib plugins for Maven and Gradle](https://github.com/GoogleContainerTools/jib/).", + "x-intellij-html-description": "builds images using the Jib plugins for Maven and Gradle." + }, + "KanikoArtifact": { + "properties": { + "buildArgs": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "arguments passed to the docker build. It also accepts environment variables and generated values via the go template syntax. Exposed generated values: IMAGE_REPO, IMAGE_NAME, IMAGE_TAG.", + "x-intellij-html-description": "arguments passed to the docker build. It also accepts environment variables and generated values via the go template syntax. Exposed generated values: IMAGEREPO, IMAGENAME, IMAGE_TAG.", + "default": "{}", + "examples": [ + "{\"key1\": \"value1\", \"key2\": \"value2\", \"key3\": \"'{{.ENV_VARIABLE}}'\"}" + ] + }, + "cache": { + "$ref": "#/definitions/KanikoCache", + "description": "configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds.", + "x-intellij-html-description": "configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds." + }, + "cleanup": { + "type": "boolean", + "description": "to clean the filesystem at the end of the build.", + "x-intellij-html-description": "to clean the filesystem at the end of the build.", + "default": "false" + }, + "contextSubPath": { + "type": "string", + "description": "to specify a sub path within the context.", + "x-intellij-html-description": "to specify a sub path within the context." + }, + "digestFile": { + "type": "string", + "description": "to specify a file in the container. This file will receive the digest of a built image. This can be used to automatically track the exact image built by kaniko.", + "x-intellij-html-description": "to specify a file in the container. This file will receive the digest of a built image. This can be used to automatically track the exact image built by kaniko." + }, + "dockerfile": { + "type": "string", + "description": "locates the Dockerfile relative to workspace.", + "x-intellij-html-description": "locates the Dockerfile relative to workspace.", + "default": "Dockerfile" + }, + "env": { + "items": {}, + "type": "array", + "description": "environment variables passed to the kaniko pod. It also accepts environment variables via the go template syntax.", + "x-intellij-html-description": "environment variables passed to the kaniko pod. It also accepts environment variables via the go template syntax.", + "default": "[]", + "examples": [ + "[{\"name\": \"key1\", \"value\": \"value1\"}, {\"name\": \"key2\", \"value\": \"value2\"}, {\"name\": \"key3\", \"value\": \"'{{.ENV_VARIABLE}}'\"}]" + ] + }, + "force": { + "type": "boolean", + "description": "building outside of a container.", + "x-intellij-html-description": "building outside of a container.", + "default": "false" + }, + "ignorePaths": { + "items": { + "type": "string" + }, + "type": "array", + "description": "a list of ignored paths when making an image snapshot.", + "x-intellij-html-description": "a list of ignored paths when making an image snapshot.", + "default": "[]" + }, + "image": { + "type": "string", + "description": "Docker image used by the Kaniko pod. Defaults to the latest released version of `gcr.io/kaniko-project/executor`.", + "x-intellij-html-description": "Docker image used by the Kaniko pod. Defaults to the latest released version of gcr.io/kaniko-project/executor." + }, + "imageFSExtractRetry": { + "type": "string", + "description": "number of retries that should happen for extracting an image filesystem.", + "x-intellij-html-description": "number of retries that should happen for extracting an image filesystem." + }, + "imageNameWithDigestFile": { + "type": "string", + "description": "specify a file to save the image name with digest of the built image to.", + "x-intellij-html-description": "specify a file to save the image name with digest of the built image to." + }, + "initImage": { + "type": "string", + "description": "image used to run init container which mounts kaniko context.", + "x-intellij-html-description": "image used to run init container which mounts kaniko context." + }, + "insecure": { + "type": "boolean", + "description": "if you want to push images to a plain HTTP registry.", + "x-intellij-html-description": "if you want to push images to a plain HTTP registry.", + "default": "false" + }, + "insecurePull": { + "type": "boolean", + "description": "if you want to pull images from a plain HTTP registry.", + "x-intellij-html-description": "if you want to pull images from a plain HTTP registry.", + "default": "false" + }, + "insecureRegistry": { + "items": { + "type": "string" + }, + "type": "array", + "description": "to use plain HTTP requests when accessing a registry.", + "x-intellij-html-description": "to use plain HTTP requests when accessing a registry.", + "default": "[]" + }, + "label": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "key: value to set some metadata to the final image. This is equivalent as using the LABEL within the Dockerfile.", + "x-intellij-html-description": "key: value to set some metadata to the final image. This is equivalent as using the LABEL within the Dockerfile.", + "default": "{}" + }, + "logFormat": { + "type": "string", + "description": " to set the log format.", + "x-intellij-html-description": " to set the log format." + }, + "logTimestamp": { + "type": "boolean", + "description": "to add timestamps to log format.", + "x-intellij-html-description": "to add timestamps to log format.", + "default": "false" + }, + "noPush": { + "type": "boolean", + "description": "if you only want to build the image, without pushing to a registry.", + "x-intellij-html-description": "if you only want to build the image, without pushing to a registry.", + "default": "false" + }, + "ociLayoutPath": { + "type": "string", + "description": "to specify a directory in the container where the OCI image layout of a built image will be placed. This can be used to automatically track the exact image built by kaniko.", + "x-intellij-html-description": "to specify a directory in the container where the OCI image layout of a built image will be placed. This can be used to automatically track the exact image built by kaniko." + }, + "pushRetry": { + "type": "string", + "description": "Set this flag to the number of retries that should happen for the push of an image to a remote destination.", + "x-intellij-html-description": "Set this flag to the number of retries that should happen for the push of an image to a remote destination." + }, + "registryCertificate": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "to provide a certificate for TLS communication with a given registry. my.registry.url: /path/to/the/certificate.cert is the expected format.", + "x-intellij-html-description": "to provide a certificate for TLS communication with a given registry. my.registry.url: /path/to/the/certificate.cert is the expected format.", + "default": "{}" + }, + "registryMirror": { + "type": "string", + "description": "if you want to use a registry mirror instead of default `index.docker.io`.", + "x-intellij-html-description": "if you want to use a registry mirror instead of default index.docker.io." + }, + "reproducible": { + "type": "boolean", + "description": "used to strip timestamps out of the built image.", + "x-intellij-html-description": "used to strip timestamps out of the built image.", + "default": "false" + }, + "singleSnapshot": { + "type": "boolean", + "description": "takes a single snapshot of the filesystem at the end of the build. So only one layer will be appended to the base image.", + "x-intellij-html-description": "takes a single snapshot of the filesystem at the end of the build. So only one layer will be appended to the base image.", + "default": "false" + }, + "skipTLS": { + "type": "boolean", + "description": "skips TLS certificate validation when pushing to a registry.", + "x-intellij-html-description": "skips TLS certificate validation when pushing to a registry.", + "default": "false" + }, + "skipTLSVerifyPull": { + "type": "boolean", + "description": "skips TLS certificate validation when pulling from a registry.", + "x-intellij-html-description": "skips TLS certificate validation when pulling from a registry.", + "default": "false" + }, + "skipTLSVerifyRegistry": { + "items": { + "type": "string" + }, + "type": "array", + "description": "skips TLS certificate validation when accessing a registry.", + "x-intellij-html-description": "skips TLS certificate validation when accessing a registry.", + "default": "[]" + }, + "skipUnusedStages": { + "type": "boolean", + "description": "builds only used stages if defined to true. Otherwise it builds by default all stages, even the unnecessaries ones until it reaches the target stage / end of Dockerfile.", + "x-intellij-html-description": "builds only used stages if defined to true. Otherwise it builds by default all stages, even the unnecessaries ones until it reaches the target stage / end of Dockerfile.", + "default": "false" + }, + "snapshotMode": { + "type": "string", + "description": "how Kaniko will snapshot the filesystem.", + "x-intellij-html-description": "how Kaniko will snapshot the filesystem." + }, + "tarPath": { + "type": "string", + "description": "path to save the image as a tarball at path instead of pushing the image.", + "x-intellij-html-description": "path to save the image as a tarball at path instead of pushing the image." + }, + "target": { + "type": "string", + "description": "to indicate which build stage is the target build stage.", + "x-intellij-html-description": "to indicate which build stage is the target build stage." + }, + "useNewRun": { + "type": "boolean", + "description": "to Use the experimental run implementation for detecting changes without requiring file system snapshots. In some cases, this may improve build performance by 75%.", + "x-intellij-html-description": "to Use the experimental run implementation for detecting changes without requiring file system snapshots. In some cases, this may improve build performance by 75%.", + "default": "false" + }, + "verbosity": { + "type": "string", + "description": " to set the logging level.", + "x-intellij-html-description": " to set the logging level." + }, + "volumeMounts": { + "items": {}, + "type": "array", + "description": "volume mounts passed to kaniko pod.", + "x-intellij-html-description": "volume mounts passed to kaniko pod.", + "default": "[]" + }, + "whitelistVarRun": { + "type": "boolean", + "description": "used to ignore `/var/run` when taking image snapshot. Set it to false to preserve /var/run/* in destination image.", + "x-intellij-html-description": "used to ignore /var/run when taking image snapshot. Set it to false to preserve /var/run/* in destination image.", + "default": "false" + } + }, + "preferredOrder": [ + "cleanup", + "insecure", + "insecurePull", + "noPush", + "force", + "logTimestamp", + "reproducible", + "singleSnapshot", + "skipTLS", + "skipTLSVerifyPull", + "skipUnusedStages", + "useNewRun", + "whitelistVarRun", + "dockerfile", + "target", + "initImage", + "image", + "digestFile", + "imageFSExtractRetry", + "imageNameWithDigestFile", + "logFormat", + "ociLayoutPath", + "registryMirror", + "snapshotMode", + "pushRetry", + "tarPath", + "verbosity", + "insecureRegistry", + "skipTLSVerifyRegistry", + "env", + "cache", + "registryCertificate", + "label", + "buildArgs", + "volumeMounts", + "contextSubPath", + "ignorePaths" + ], + "additionalProperties": false, + "type": "object", + "description": "describes an artifact built from a Dockerfile, with kaniko.", + "x-intellij-html-description": "describes an artifact built from a Dockerfile, with kaniko." + }, + "KanikoCache": { + "properties": { + "cacheCopyLayers": { + "type": "boolean", + "description": "enables caching of copy layers.", + "x-intellij-html-description": "enables caching of copy layers.", + "default": "false" + }, + "hostPath": { + "type": "string", + "description": "specifies a path on the host that is mounted to each pod as read only cache volume containing base images. If set, must exist on each node and prepopulated with kaniko-warmer.", + "x-intellij-html-description": "specifies a path on the host that is mounted to each pod as read only cache volume containing base images. If set, must exist on each node and prepopulated with kaniko-warmer." + }, + "repo": { + "type": "string", + "description": "a remote repository to store cached layers. If none is specified, one will be inferred from the image name. See [Kaniko Caching](https://github.com/GoogleContainerTools/kaniko#caching).", + "x-intellij-html-description": "a remote repository to store cached layers. If none is specified, one will be inferred from the image name. See Kaniko Caching." + }, + "ttl": { + "type": "string", + "description": "Cache timeout in hours.", + "x-intellij-html-description": "Cache timeout in hours." + } + }, + "preferredOrder": [ + "repo", + "hostPath", + "ttl", + "cacheCopyLayers" + ], + "additionalProperties": false, + "type": "object", + "description": "configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds.", + "x-intellij-html-description": "configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds." + }, + "KoArtifact": { + "properties": { + "dependencies": { + "$ref": "#/definitions/KoDependencies", + "description": "file dependencies that Skaffold should watch for both rebuilding and file syncing for this artifact.", + "x-intellij-html-description": "file dependencies that Skaffold should watch for both rebuilding and file syncing for this artifact." + }, + "dir": { + "type": "string", + "description": "directory where the `go` tool will be run. The value is a directory path relative to the `context` directory. If empty, the `go` tool will run in the `context` directory. Example: `./my-app-sources`.", + "x-intellij-html-description": "directory where the go tool will be run. The value is a directory path relative to the context directory. If empty, the go tool will run in the context directory. Example: ./my-app-sources." + }, + "env": { + "items": { + "type": "string" + }, + "type": "array", + "description": "environment variables, in the `key=value` form, passed to the build. These environment variables are only used at build time. They are _not_ set in the resulting container image.", + "x-intellij-html-description": "environment variables, in the key=value form, passed to the build. These environment variables are only used at build time. They are not set in the resulting container image.", + "default": "[]", + "examples": [ + "[\"GOPRIVATE=git.example.com\", \"GOCACHE=/workspace/.gocache\"]" + ] + }, + "flags": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional build flags passed to `go build`.", + "x-intellij-html-description": "additional build flags passed to go build.", + "default": "[]", + "examples": [ + "[\"-trimpath\", \"-v\"]" + ] + }, + "fromImage": { + "type": "string", + "description": "overrides the default ko base image (`gcr.io/distroless/static:nonroot`). Corresponds to, and overrides, the `defaultBaseImage` in `.ko.yaml`.", + "x-intellij-html-description": "overrides the default ko base image (gcr.io/distroless/static:nonroot). Corresponds to, and overrides, the defaultBaseImage in .ko.yaml." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "key-value string pairs to add to the image config.", + "x-intellij-html-description": "key-value string pairs to add to the image config.", + "default": "{}", + "examples": [ + "{\"foo\":\"bar\"}" + ] + }, + "ldflags": { + "items": { + "type": "string" + }, + "type": "array", + "description": "linker flags passed to the builder.", + "x-intellij-html-description": "linker flags passed to the builder.", + "default": "[]", + "examples": [ + "[\"-buildid=\", \"-s\", \"-w\"]" + ] + }, + "main": { + "type": "string", + "description": "location of the main package. It is the pattern passed to `go build`. If main is specified as a relative path, it is relative to the `context` directory. If main is empty, the ko builder uses a default value of `.`. If main is a pattern with wildcards, such as `./...`, the expansion must contain only one main package, otherwise ko fails. Main is ignored if the `ImageName` starts with `ko://`. Example: `./cmd/foo`.", + "x-intellij-html-description": "location of the main package. It is the pattern passed to go build. If main is specified as a relative path, it is relative to the context directory. If main is empty, the ko builder uses a default value of .. If main is a pattern with wildcards, such as ./..., the expansion must contain only one main package, otherwise ko fails. Main is ignored if the ImageName starts with ko://. Example: ./cmd/foo." + } + }, + "preferredOrder": [ + "fromImage", + "dependencies", + "dir", + "env", + "flags", + "labels", + "ldflags", + "main" + ], + "additionalProperties": false, + "type": "object", + "description": "builds images using [ko](https://github.com/google/ko).", + "x-intellij-html-description": "builds images using ko." + }, + "KoDependencies": { + "properties": { + "ignore": { + "items": { + "type": "string" + }, + "type": "array", + "description": "specifies the paths that should be ignored by Skaffold's file watcher. If a file exists in both `paths` and in `ignore`, it will be ignored, and will be excluded from both rebuilds and file synchronization.", + "x-intellij-html-description": "specifies the paths that should be ignored by Skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization.", + "default": "[]" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array", + "description": "should be set to the file dependencies for this artifact, so that the Skaffold file watcher knows when to rebuild and perform file synchronization.", + "x-intellij-html-description": "should be set to the file dependencies for this artifact, so that the Skaffold file watcher knows when to rebuild and perform file synchronization.", + "default": "[\"**/*.go\"]" + } + }, + "preferredOrder": [ + "paths", + "ignore" + ], + "additionalProperties": false, + "type": "object", + "description": "used to specify dependencies for an artifact built by ko.", + "x-intellij-html-description": "used to specify dependencies for an artifact built by ko." + }, + "KptDeploy": { + "properties": { + "applyFlags": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional flags passed to `kpt live apply`.", + "x-intellij-html-description": "additional flags passed to kpt live apply.", + "default": "[]" + }, + "defaultNamespace": { + "type": "string", + "description": "default namespace passed to kpt on deployment if no other override is given.", + "x-intellij-html-description": "default namespace passed to kpt on deployment if no other override is given." + }, + "dir": { + "type": "string", + "description": "equivalent to the dir in `kpt live apply `. If not provided, skaffold deploys from the default hydrated path `/.kpt-pipeline`.", + "x-intellij-html-description": "equivalent to the dir in kpt live apply <dir>. If not provided, skaffold deploys from the default hydrated path <WORKDIR>/.kpt-pipeline." + }, + "false": { + "type": "boolean", + "description": "used in `kpt live init`, which forces the inventory values to be updated, even if they are already set.", + "x-intellij-html-description": "used in kpt live init, which forces the inventory values to be updated, even if they are already set.", + "default": "false" + }, + "flags": { + "items": { + "type": "string" + }, + "type": "array", + "description": "kpt global flags.", + "x-intellij-html-description": "kpt global flags.", + "default": "[]" + }, + "inventoryID": { + "type": "string", + "description": "*alpha* inventory ID which annotates the resources being lively applied by kpt.", + "x-intellij-html-description": "alpha inventory ID which annotates the resources being lively applied by kpt." + }, + "name": { + "type": "string", + "description": "*alpha* inventory object name.", + "x-intellij-html-description": "alpha inventory object name." + }, + "namespace": { + "type": "string", + "description": "*alpha* sets the inventory namespace.", + "x-intellij-html-description": "alpha sets the inventory namespace." + } + }, + "preferredOrder": [ + "dir", + "applyFlags", + "flags", + "name", + "inventoryID", + "namespace", + "false", + "defaultNamespace" + ], + "additionalProperties": false, + "type": "object", + "description": "contains all the configuration needed by the deploy steps.", + "x-intellij-html-description": "contains all the configuration needed by the deploy steps." + }, + "KubectlDeploy": { + "properties": { + "defaultNamespace": { + "type": "string", + "description": "default namespace passed to kubectl on deployment if no other override is given.", + "x-intellij-html-description": "default namespace passed to kubectl on deployment if no other override is given." + }, + "flags": { + "$ref": "#/definitions/KubectlFlags", + "description": "additional flags passed to `kubectl`.", + "x-intellij-html-description": "additional flags passed to kubectl." + }, + "hooks": { + "$ref": "#/definitions/DeployHooks", + "description": "describes a set of lifecycle hooks that are executed before and after every deploy.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after every deploy." + }, + "remoteManifests": { + "items": { + "type": "string" + }, + "type": "array", + "description": "Kubernetes manifests in remote clusters.", + "x-intellij-html-description": "Kubernetes manifests in remote clusters.", + "default": "[]" + } + }, + "preferredOrder": [ + "flags", + "remoteManifests", + "defaultNamespace", + "hooks" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* uses a client side `kubectl apply` to deploy manifests. You'll need a `kubectl` CLI version installed that's compatible with your cluster.", + "x-intellij-html-description": "beta uses a client side kubectl apply to deploy manifests. You'll need a kubectl CLI version installed that's compatible with your cluster." + }, + "KubectlFlags": { + "properties": { + "apply": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional flags passed on creations (`kubectl apply`).", + "x-intellij-html-description": "additional flags passed on creations (kubectl apply).", + "default": "[]" + }, + "delete": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional flags passed on deletions (`kubectl delete`).", + "x-intellij-html-description": "additional flags passed on deletions (kubectl delete).", + "default": "[]" + }, + "disableValidation": { + "type": "boolean", + "description": "passes the `--validate=false` flag to supported `kubectl` commands when enabled.", + "x-intellij-html-description": "passes the --validate=false flag to supported kubectl commands when enabled.", + "default": "false" + }, + "global": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional flags passed on every command.", + "x-intellij-html-description": "additional flags passed on every command.", + "default": "[]" + } + }, + "preferredOrder": [ + "global", + "apply", + "delete", + "disableValidation" + ], + "additionalProperties": false, + "type": "object", + "description": "additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).", + "x-intellij-html-description": "additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete)." + }, + "KubernetesClusterVerifier": { + "properties": { + "jobManifestPath": { + "type": "string", + "description": "path to the kubernetes Job manifest to use for the verify test This manifest will be deployed into the cluster with the Container information replaced by the information in the Container field.", + "x-intellij-html-description": "path to the kubernetes Job manifest to use for the verify test This manifest will be deployed into the cluster with the Container information replaced by the information in the Container field." + }, + "overrides": { + "type": "string", + "description": "inline JSON override to use for the generated kubernetes Job. If this is non-empty, it is used to override the generated object. Similar to the `--overrides` kubectl flag.", + "x-intellij-html-description": "inline JSON override to use for the generated kubernetes Job. If this is non-empty, it is used to override the generated object. Similar to the --overrides kubectl flag." + } + }, + "preferredOrder": [ + "overrides", + "jobManifestPath" + ], + "additionalProperties": false, + "type": "object", + "description": "uses the `kubectl` CLI to create veriy test case container in a kubernetes cluster.", + "x-intellij-html-description": "uses the kubectl CLI to create veriy test case container in a kubernetes cluster." + }, + "Kustomize": { + "properties": { + "buildArgs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional args passed to `kustomize build`.", + "x-intellij-html-description": "additional args passed to kustomize build.", + "default": "[]" + }, + "paths": { + "items": { + "type": "string" + }, + "type": "array", + "description": "path to Kustomization files.", + "x-intellij-html-description": "path to Kustomization files.", + "default": "[\".\"]" + } + }, + "preferredOrder": [ + "paths", + "buildArgs" + ], + "additionalProperties": false, + "type": "object", + "description": "defines the paths to be modified with kustomize, along with extra flags to be passed to kustomize.", + "x-intellij-html-description": "defines the paths to be modified with kustomize, along with extra flags to be passed to kustomize." + }, + "LegacyHelmDeploy": { + "properties": { + "flags": { + "$ref": "#/definitions/HelmDeployFlags", + "description": "additional option flags that are passed on the command line to `helm`.", + "x-intellij-html-description": "additional option flags that are passed on the command line to helm." + }, + "hooks": { + "$ref": "#/definitions/DeployHooks", + "description": "describes a set of lifecycle hooks that are executed before and after every deploy.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after every deploy." + }, + "releases": { + "items": { + "$ref": "#/definitions/HelmRelease" + }, + "type": "array", + "description": "a list of Helm releases.", + "x-intellij-html-description": "a list of Helm releases." + } + }, + "preferredOrder": [ + "releases", + "flags", + "hooks" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* uses the `helm` CLI to apply the charts to the cluster.", + "x-intellij-html-description": "beta uses the helm CLI to apply the charts to the cluster." + }, + "LocalBuild": { + "properties": { + "concurrency": { + "type": "integer", + "description": "how many artifacts can be built concurrently. 0 means \"no-limit\".", + "x-intellij-html-description": "how many artifacts can be built concurrently. 0 means "no-limit".", + "default": "1" + }, + "push": { + "type": "boolean", + "description": "should images be pushed to a registry. If not specified, images are pushed only if the current Kubernetes context connects to a remote cluster.", + "x-intellij-html-description": "should images be pushed to a registry. If not specified, images are pushed only if the current Kubernetes context connects to a remote cluster." + }, + "tryImportMissing": { + "type": "boolean", + "description": "whether to attempt to import artifacts from Docker (either a local or remote registry) if not in the cache.", + "x-intellij-html-description": "whether to attempt to import artifacts from Docker (either a local or remote registry) if not in the cache.", + "default": "false" + }, + "useBuildkit": { + "type": "boolean", + "description": "use BuildKit to build Docker images. If unspecified, uses the Docker default.", + "x-intellij-html-description": "use BuildKit to build Docker images. If unspecified, uses the Docker default." + }, + "useDockerCLI": { + "type": "boolean", + "description": "use `docker` command-line interface instead of Docker Engine APIs.", + "x-intellij-html-description": "use docker command-line interface instead of Docker Engine APIs.", + "default": "false" + } + }, + "preferredOrder": [ + "push", + "tryImportMissing", + "useDockerCLI", + "useBuildkit", + "concurrency" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* describes how to do a build on the local docker daemon and optionally push to a repository.", + "x-intellij-html-description": "beta describes how to do a build on the local docker daemon and optionally push to a repository." + }, + "LocalVerifier": { + "type": "object", + "description": "uses the `docker` CLI to create verify test case containers on the host machine in Docker.", + "x-intellij-html-description": "uses the docker CLI to create verify test case containers on the host machine in Docker." + }, + "LogsConfig": { + "properties": { + "jsonParse": { + "$ref": "#/definitions/JSONParseConfig", + "description": "defines the rules for parsing/outputting json logs.", + "x-intellij-html-description": "defines the rules for parsing/outputting json logs." + }, + "prefix": { + "type": "string", + "description": "defines the prefix shown on each log line. Valid values are `container`: prefix logs lines with the name of the container. `podAndContainer`: prefix logs lines with the names of the pod and of the container. `auto`: same as `podAndContainer` except that the pod name is skipped if it's the same as the container name. `none`: don't add a prefix.", + "x-intellij-html-description": "defines the prefix shown on each log line. Valid values are container: prefix logs lines with the name of the container. podAndContainer: prefix logs lines with the names of the pod and of the container. auto: same as podAndContainer except that the pod name is skipped if it's the same as the container name. none: don't add a prefix.", + "default": "auto", + "enum": [ + "container", + "podAndContainer", + "auto", + "none" + ] + } + }, + "preferredOrder": [ + "prefix", + "jsonParse" + ], + "additionalProperties": false, + "type": "object", + "description": "configures how container logs are printed as a result of a deployment.", + "x-intellij-html-description": "configures how container logs are printed as a result of a deployment." + }, + "Metadata": { + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "a map of annotations providing additional metadata about the project.", + "x-intellij-html-description": "a map of annotations providing additional metadata about the project.", + "default": "{}" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "a map of labels identifying the project.", + "x-intellij-html-description": "a map of labels identifying the project.", + "default": "{}" + }, + "name": { + "type": "string", + "description": "an identifier for the project.", + "x-intellij-html-description": "an identifier for the project." + } + }, + "preferredOrder": [ + "name", + "labels", + "annotations" + ], + "additionalProperties": false, + "type": "object", + "description": "holds an optional name of the project.", + "x-intellij-html-description": "holds an optional name of the project." + }, + "NamedContainerHook": { + "required": [ + "podName", + "command" + ], + "properties": { + "command": { + "items": { + "type": "string" + }, + "type": "array", + "description": "command to execute.", + "x-intellij-html-description": "command to execute.", + "default": "[]" + }, + "containerName": { + "type": "string", + "description": "name of the container to execute the command in.", + "x-intellij-html-description": "name of the container to execute the command in." + }, + "podName": { + "type": "string", + "description": "name of the pod to execute the command in.", + "x-intellij-html-description": "name of the pod to execute the command in." + } + }, + "preferredOrder": [ + "command", + "podName", + "containerName" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a lifecycle hook definition to execute on a named container.", + "x-intellij-html-description": "describes a lifecycle hook definition to execute on a named container." + }, + "PlatformEmulatorInstallStep": { + "required": [ + "image" + ], + "properties": { + "args": { + "items": { + "type": "string" + }, + "type": "array", + "description": "specifies arguments passed to the emulator installer image.", + "x-intellij-html-description": "specifies arguments passed to the emulator installer image.", + "default": "[]" + }, + "entrypoint": { + "type": "string", + "description": "specifies the ENTRYPOINT argument to the emulator installer image.", + "x-intellij-html-description": "specifies the ENTRYPOINT argument to the emulator installer image." + }, + "image": { + "type": "string", + "description": "specifies the image that will install the required tooling for QEMU emulation on the GoogleCloudBuild containers.", + "x-intellij-html-description": "specifies the image that will install the required tooling for QEMU emulation on the GoogleCloudBuild containers." + } + }, + "preferredOrder": [ + "image", + "args", + "entrypoint" + ], + "additionalProperties": false, + "type": "object", + "description": "specifies a pre-build step to install the required tooling for QEMU emulation on the GoogleCloudBuild containers. This enables performing cross-platform builds on GoogleCloudBuild.", + "x-intellij-html-description": "specifies a pre-build step to install the required tooling for QEMU emulation on the GoogleCloudBuild containers. This enables performing cross-platform builds on GoogleCloudBuild." + }, + "PortForwardResource": { + "properties": { + "address": { + "type": "string", + "description": "local address to bind to. Defaults to the loopback address 127.0.0.1.", + "x-intellij-html-description": "local address to bind to. Defaults to the loopback address 127.0.0.1." + }, + "localPort": { + "type": "integer", + "description": "local port to forward to. If the port is unavailable, Skaffold will choose a random open port to forward to. *Optional*.", + "x-intellij-html-description": "local port to forward to. If the port is unavailable, Skaffold will choose a random open port to forward to. Optional." + }, + "namespace": { + "type": "string", + "description": "namespace of the resource to port forward. Does not apply to local containers.", + "x-intellij-html-description": "namespace of the resource to port forward. Does not apply to local containers." + }, + "port": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ], + "description": "resource port that will be forwarded.", + "x-intellij-html-description": "resource port that will be forwarded." + }, + "resourceName": { + "type": "string", + "description": "name of the Kubernetes resource or local container to port forward.", + "x-intellij-html-description": "name of the Kubernetes resource or local container to port forward." + }, + "resourceType": { + "type": "string", + "description": "resource type that should be port forwarded. Acceptable resource types include kubernetes types: `Service`, `Pod` and Controller resource type that has a pod spec: `ReplicaSet`, `ReplicationController`, `Deployment`, `StatefulSet`, `DaemonSet`, `Job`, `CronJob`. Standalone `Container` is also valid for Docker deployments.", + "x-intellij-html-description": "resource type that should be port forwarded. Acceptable resource types include kubernetes types: Service, Pod and Controller resource type that has a pod spec: ReplicaSet, ReplicationController, Deployment, StatefulSet, DaemonSet, Job, CronJob. Standalone Container is also valid for Docker deployments." + } + }, + "preferredOrder": [ + "resourceType", + "resourceName", + "namespace", + "port", + "address", + "localPort" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a resource to port forward.", + "x-intellij-html-description": "describes a resource to port forward." + }, + "Profile": { + "required": [ + "name" + ], + "properties": { + "activation": { + "items": { + "$ref": "#/definitions/Activation" + }, + "type": "array", + "description": "criteria by which a profile can be auto-activated. The profile is auto-activated if any one of the activations are triggered. An activation is triggered if all of the criteria (env, kubeContext, command) are triggered.", + "x-intellij-html-description": "criteria by which a profile can be auto-activated. The profile is auto-activated if any one of the activations are triggered. An activation is triggered if all of the criteria (env, kubeContext, command) are triggered." + }, + "build": { + "$ref": "#/definitions/BuildConfig", + "description": "describes how images are built.", + "x-intellij-html-description": "describes how images are built." + }, + "deploy": { + "$ref": "#/definitions/DeployConfig", + "description": "describes how the manifests are deployed.", + "x-intellij-html-description": "describes how the manifests are deployed." + }, + "manifests": { + "$ref": "#/definitions/RenderConfig", + "description": "describes how the original manifests are hydrated, validated and transformed.", + "x-intellij-html-description": "describes how the original manifests are hydrated, validated and transformed." + }, + "name": { + "type": "string", + "description": "a unique profile name.", + "x-intellij-html-description": "a unique profile name.", + "examples": [ + "profile-prod" + ] + }, + "patches": { + "items": { + "$ref": "#/definitions/JSONPatch" + }, + "type": "array", + "description": "patches applied to the configuration. Patches use the JSON patch notation.", + "x-intellij-html-description": "patches applied to the configuration. Patches use the JSON patch notation." + }, + "portForward": { + "items": { + "$ref": "#/definitions/PortForwardResource" + }, + "type": "array", + "description": "describes user defined resources to port-forward.", + "x-intellij-html-description": "describes user defined resources to port-forward." + }, + "requiresAllActivations": { + "type": "boolean", + "description": "activation strategy of the profile. When true, the profile is auto-activated only when all of its activations are triggered. When false, the profile is auto-activated when any one of its activations is triggered.", + "x-intellij-html-description": "activation strategy of the profile. When true, the profile is auto-activated only when all of its activations are triggered. When false, the profile is auto-activated when any one of its activations is triggered.", + "default": "false" + }, + "resourceSelector": { + "$ref": "#/definitions/ResourceSelectorConfig", + "description": "describes user defined filters describing how skaffold should treat objects/fields during rendering.", + "x-intellij-html-description": "describes user defined filters describing how skaffold should treat objects/fields during rendering." + }, + "test": { + "items": { + "$ref": "#/definitions/TestCase" + }, + "type": "array", + "description": "describes how images are tested.", + "x-intellij-html-description": "describes how images are tested." + }, + "verify": { + "items": { + "$ref": "#/definitions/VerifyTestCase" + }, + "type": "array", + "description": "describes how images are verified (via verification tests).", + "x-intellij-html-description": "describes how images are verified (via verification tests)." + } + }, + "preferredOrder": [ + "name", + "activation", + "requiresAllActivations", + "patches", + "build", + "test", + "manifests", + "deploy", + "portForward", + "resourceSelector", + "verify" + ], + "additionalProperties": false, + "type": "object", + "description": "used to override any `build`, `test` or `deploy` configuration.", + "x-intellij-html-description": "used to override any build, test or deploy configuration." + }, + "ProfileDependency": { + "required": [ + "name" + ], + "properties": { + "activatedBy": { + "items": { + "type": "string" + }, + "type": "array", + "description": "describes a list of profiles in the current config that when activated will also activate the named profile in the dependency config. If empty then the named profile is always activated.", + "x-intellij-html-description": "describes a list of profiles in the current config that when activated will also activate the named profile in the dependency config. If empty then the named profile is always activated.", + "default": "[]" + }, + "name": { + "type": "string", + "description": "describes name of the profile to activate in the dependency config. It should exist in the dependency config.", + "x-intellij-html-description": "describes name of the profile to activate in the dependency config. It should exist in the dependency config." + } + }, + "preferredOrder": [ + "name", + "activatedBy" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a mapping from referenced config profiles to the current config profiles. If the current config is activated with a profile in this mapping then the dependency configs are also activated with the corresponding mapped profiles.", + "x-intellij-html-description": "describes a mapping from referenced config profiles to the current config profiles. If the current config is activated with a profile in this mapping then the dependency configs are also activated with the corresponding mapped profiles." + }, + "RemoteManifest": { + "properties": { + "kubeContext": { + "type": "string", + "description": "Kubernetes context that Skaffold should deploy to.", + "x-intellij-html-description": "Kubernetes context that Skaffold should deploy to.", + "examples": [ + "minikube" + ] + }, + "manifest": { + "type": "string", + "description": "specifies the Kubernetes manifest in the remote cluster.", + "x-intellij-html-description": "specifies the Kubernetes manifest in the remote cluster." + } + }, + "preferredOrder": [ + "manifest", + "kubeContext" + ], + "additionalProperties": false, + "type": "object", + "description": "defines the paths to be modified with kustomize, along with extra flags to be passed to kustomize.", + "x-intellij-html-description": "defines the paths to be modified with kustomize, along with extra flags to be passed to kustomize." + }, + "RenderConfig": { + "properties": { + "helm": { + "$ref": "#/definitions/Helm", + "description": "defines the helm charts used in the application. NOTE: Defines cherts in this section to render via helm but deployed via kubectl or kpt deployer. To use helm to deploy, please see deploy.helm section.", + "x-intellij-html-description": "defines the helm charts used in the application. NOTE: Defines cherts in this section to render via helm but deployed via kubectl or kpt deployer. To use helm to deploy, please see deploy.helm section." + }, + "hooks": { + "$ref": "#/definitions/RenderHooks", + "description": "describes a set of lifecycle hooks that are executed before and after every render.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after every render." + }, + "kpt": { + "items": { + "type": "string" + }, + "type": "array", + "description": "defines the kpt resources in the application.", + "x-intellij-html-description": "defines the kpt resources in the application.", + "default": "[]" + }, + "kustomize": { + "$ref": "#/definitions/Kustomize", + "description": "defines the paths to be modified with kustomize, along with extra flags to be passed to kustomize.", + "x-intellij-html-description": "defines the paths to be modified with kustomize, along with extra flags to be passed to kustomize." + }, + "output": { + "type": "string", + "description": "path to the hydrated directory.", + "x-intellij-html-description": "path to the hydrated directory." + }, + "rawYaml": { + "items": { + "type": "string" + }, + "type": "array", + "description": "defines the raw kubernetes resources.", + "x-intellij-html-description": "defines the raw kubernetes resources.", + "default": "[]" + }, + "remoteManifests": { + "items": { + "$ref": "#/definitions/RemoteManifest" + }, + "type": "array", + "description": "Kubernetes manifests in remote clusters.", + "x-intellij-html-description": "Kubernetes manifests in remote clusters." + }, + "transform": { + "description": "defines a set of transformation operations to run in series.", + "x-intellij-html-description": "defines a set of transformation operations to run in series." + }, + "validate": { + "description": "defines a set of validator operations to run in series.", + "x-intellij-html-description": "defines a set of validator operations to run in series." + } + }, + "preferredOrder": [ + "rawYaml", + "remoteManifests", + "kustomize", + "helm", + "kpt", + "hooks", + "transform", + "validate", + "output" + ], + "additionalProperties": false, + "type": "object", + "description": "contains all the configuration needed by the render steps.", + "x-intellij-html-description": "contains all the configuration needed by the render steps." + }, + "RenderHookItem": { + "properties": { + "host": { + "$ref": "#/definitions/HostHook", + "description": "describes a single lifecycle hook to run on the host machine.", + "x-intellij-html-description": "describes a single lifecycle hook to run on the host machine." + } + }, + "preferredOrder": [ + "host" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a single lifecycle hook to execute before or after each deployer step.", + "x-intellij-html-description": "describes a single lifecycle hook to execute before or after each deployer step." + }, + "RenderHooks": { + "properties": { + "after": { + "items": { + "$ref": "#/definitions/RenderHookItem" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *after* each render step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute after each render step." + }, + "before": { + "items": { + "$ref": "#/definitions/RenderHookItem" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *before* each render step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during `skaffold dev`).", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before each render step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev)." + } + }, + "preferredOrder": [ + "before", + "after" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the list of lifecycle hooks to execute before and after each render step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before and after each render step." + }, + "ResourceFilter": { + "required": [ + "groupKind" + ], + "properties": { + "groupKind": { + "type": "string", + "description": "compact format of a resource type.", + "x-intellij-html-description": "compact format of a resource type." + }, + "image": { + "items": { + "type": "string" + }, + "type": "array", + "description": "an optional slice of JSON-path-like paths of where to rewrite images.", + "x-intellij-html-description": "an optional slice of JSON-path-like paths of where to rewrite images.", + "default": "[]" + }, + "labels": { + "items": { + "type": "string" + }, + "type": "array", + "description": "an optional slice of JSON-path-like paths of where to add a labels block if missing.", + "x-intellij-html-description": "an optional slice of JSON-path-like paths of where to add a labels block if missing.", + "default": "[]" + }, + "podSpec": { + "items": { + "type": "string" + }, + "type": "array", + "description": "an optional slice of JSON-path-like paths of where pod spec properties can be overwritten.", + "x-intellij-html-description": "an optional slice of JSON-path-like paths of where pod spec properties can be overwritten.", + "default": "[]" + } + }, + "preferredOrder": [ + "groupKind", + "image", + "labels", + "podSpec" + ], + "additionalProperties": false, + "type": "object", + "description": "contains definition to filter which resource to transform.", + "x-intellij-html-description": "contains definition to filter which resource to transform." + }, + "ResourceRequirement": { + "properties": { + "cpu": { + "type": "string", + "description": "the number cores to be used.", + "x-intellij-html-description": "the number cores to be used.", + "examples": [ + "2`, `2.0` or `200m" + ] + }, + "ephemeralStorage": { + "type": "string", + "description": "the amount of Ephemeral storage to allocate to the pod.", + "x-intellij-html-description": "the amount of Ephemeral storage to allocate to the pod.", + "examples": [ + "1Gi` or `1000Mi" + ] + }, + "memory": { + "type": "string", + "description": "the amount of memory to allocate to the pod.", + "x-intellij-html-description": "the amount of memory to allocate to the pod.", + "examples": [ + "1Gi` or `1000Mi" + ] + }, + "resourceStorage": { + "type": "string", + "description": "the amount of resource storage to allocate to the pod.", + "x-intellij-html-description": "the amount of resource storage to allocate to the pod.", + "examples": [ + "1Gi` or `1000Mi" + ] + } + }, + "preferredOrder": [ + "cpu", + "memory", + "ephemeralStorage", + "resourceStorage" + ], + "additionalProperties": false, + "type": "object", + "description": "stores the CPU/Memory requirements for the pod.", + "x-intellij-html-description": "stores the CPU/Memory requirements for the pod." + }, + "ResourceRequirements": { + "properties": { + "limits": { + "$ref": "#/definitions/ResourceRequirement", + "description": "[resource limits](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod.", + "x-intellij-html-description": "resource limits for the Kaniko pod." + }, + "requests": { + "$ref": "#/definitions/ResourceRequirement", + "description": "[resource requests](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod.", + "x-intellij-html-description": "resource requests for the Kaniko pod." + } + }, + "preferredOrder": [ + "requests", + "limits" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the resource requirements for the kaniko pod.", + "x-intellij-html-description": "describes the resource requirements for the kaniko pod." + }, + "ResourceSelectorConfig": { + "properties": { + "allow": { + "items": { + "$ref": "#/definitions/ResourceFilter" + }, + "type": "array", + "description": "configures an allowlist for transforming manifests.", + "x-intellij-html-description": "configures an allowlist for transforming manifests." + }, + "deny": { + "items": { + "$ref": "#/definitions/ResourceFilter" + }, + "type": "array", + "description": "configures an allowlist for transforming manifests.", + "x-intellij-html-description": "configures an allowlist for transforming manifests." + } + }, + "preferredOrder": [ + "allow", + "deny" + ], + "additionalProperties": false, + "type": "object", + "description": "contains all the configuration needed by the deploy steps.", + "x-intellij-html-description": "contains all the configuration needed by the deploy steps." + }, + "ResourceType": { + "type": "string", + "description": "describes the Kubernetes resource types used for port forwarding.", + "x-intellij-html-description": "describes the Kubernetes resource types used for port forwarding." + }, + "ShaTagger": { + "type": "object", + "description": "*beta* tags images with their sha256 digest.", + "x-intellij-html-description": "beta tags images with their sha256 digest." + }, + "SkaffoldConfig": { + "required": [ + "apiVersion", + "kind" + ], + "properties": { + "apiVersion": { + "type": "string", + "description": "version of the configuration.", + "x-intellij-html-description": "version of the configuration." + }, + "build": { + "$ref": "#/definitions/BuildConfig", + "description": "describes how images are built.", + "x-intellij-html-description": "describes how images are built." + }, + "deploy": { + "$ref": "#/definitions/DeployConfig", + "description": "describes how the manifests are deployed.", + "x-intellij-html-description": "describes how the manifests are deployed." + }, + "kind": { + "type": "string", + "description": "always `Config`.", + "x-intellij-html-description": "always Config.", + "default": "Config" + }, + "manifests": { + "$ref": "#/definitions/RenderConfig", + "description": "describes how the original manifests are hydrated, validated and transformed.", + "x-intellij-html-description": "describes how the original manifests are hydrated, validated and transformed." + }, + "metadata": { + "$ref": "#/definitions/Metadata", + "description": "holds additional information about the config.", + "x-intellij-html-description": "holds additional information about the config." + }, + "portForward": { + "items": { + "$ref": "#/definitions/PortForwardResource" + }, + "type": "array", + "description": "describes user defined resources to port-forward.", + "x-intellij-html-description": "describes user defined resources to port-forward." + }, + "profiles": { + "items": { + "$ref": "#/definitions/Profile" + }, + "type": "array", + "description": "*beta* can override be used to `build`, `test` or `deploy` configuration.", + "x-intellij-html-description": "beta can override be used to build, test or deploy configuration." + }, + "requires": { + "items": { + "$ref": "#/definitions/ConfigDependency" + }, + "type": "array", + "description": "describes a list of other required configs for the current config.", + "x-intellij-html-description": "describes a list of other required configs for the current config." + }, + "resourceSelector": { + "$ref": "#/definitions/ResourceSelectorConfig", + "description": "describes user defined filters describing how skaffold should treat objects/fields during rendering.", + "x-intellij-html-description": "describes user defined filters describing how skaffold should treat objects/fields during rendering." + }, + "test": { + "items": { + "$ref": "#/definitions/TestCase" + }, + "type": "array", + "description": "describes how images are tested.", + "x-intellij-html-description": "describes how images are tested." + }, + "verify": { + "items": { + "$ref": "#/definitions/VerifyTestCase" + }, + "type": "array", + "description": "describes how images are verified (via verification tests).", + "x-intellij-html-description": "describes how images are verified (via verification tests)." + } + }, + "preferredOrder": [ + "apiVersion", + "kind", + "metadata", + "requires", + "build", + "test", + "manifests", + "deploy", + "portForward", + "resourceSelector", + "verify", + "profiles" + ], + "additionalProperties": false, + "type": "object", + "description": "holds the fields parsed from the Skaffold configuration file (skaffold.yaml).", + "x-intellij-html-description": "holds the fields parsed from the Skaffold configuration file (skaffold.yaml)." + }, + "Sync": { + "properties": { + "auto": { + "type": "boolean", + "description": "delegates discovery of sync rules to the build system. Only available for jib and buildpacks.", + "x-intellij-html-description": "delegates discovery of sync rules to the build system. Only available for jib and buildpacks." + }, + "hooks": { + "$ref": "#/definitions/SyncHooks", + "description": "describes a set of lifecycle hooks that are executed before and after each file sync action on the target artifact's containers.", + "x-intellij-html-description": "describes a set of lifecycle hooks that are executed before and after each file sync action on the target artifact's containers." + }, + "infer": { + "items": { + "type": "string" + }, + "type": "array", + "description": "file patterns which may be synced into the container The container destination is inferred by the builder based on the instructions of a Dockerfile. Available for docker and kaniko artifacts and custom artifacts that declare dependencies on a dockerfile.", + "x-intellij-html-description": "file patterns which may be synced into the container The container destination is inferred by the builder based on the instructions of a Dockerfile. Available for docker and kaniko artifacts and custom artifacts that declare dependencies on a dockerfile.", + "default": "[]" + }, + "manual": { + "items": { + "$ref": "#/definitions/SyncRule" + }, + "type": "array", + "description": "manual sync rules indicating the source and destination.", + "x-intellij-html-description": "manual sync rules indicating the source and destination." + } + }, + "preferredOrder": [ + "manual", + "infer", + "auto", + "hooks" + ], + "additionalProperties": false, + "type": "object", + "description": "*beta* specifies what files to sync into the container. This is a list of sync rules indicating the intent to sync for source files. If no files are listed, sync all the files and infer the destination.", + "x-intellij-html-description": "beta specifies what files to sync into the container. This is a list of sync rules indicating the intent to sync for source files. If no files are listed, sync all the files and infer the destination.", + "default": "infer: [\"**/*\"]" + }, + "SyncHookItem": { + "properties": { + "container": { + "$ref": "#/definitions/ContainerHook", + "description": "describes a single lifecycle hook to run on a container.", + "x-intellij-html-description": "describes a single lifecycle hook to run on a container." + }, + "host": { + "$ref": "#/definitions/HostHook", + "description": "describes a single lifecycle hook to run on the host machine.", + "x-intellij-html-description": "describes a single lifecycle hook to run on the host machine." + } + }, + "preferredOrder": [ + "host", + "container" + ], + "additionalProperties": false, + "type": "object", + "description": "describes a single lifecycle hook to execute before or after each artifact sync step.", + "x-intellij-html-description": "describes a single lifecycle hook to execute before or after each artifact sync step." + }, + "SyncHooks": { + "properties": { + "after": { + "items": { + "$ref": "#/definitions/SyncHookItem" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *after* each artifact sync step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute after each artifact sync step." + }, + "before": { + "items": { + "$ref": "#/definitions/SyncHookItem" + }, + "type": "array", + "description": "describes the list of lifecycle hooks to execute *before* each artifact sync step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before each artifact sync step." + } + }, + "preferredOrder": [ + "before", + "after" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the list of lifecycle hooks to execute before and after each artifact sync step.", + "x-intellij-html-description": "describes the list of lifecycle hooks to execute before and after each artifact sync step." + }, + "SyncRule": { + "required": [ + "src", + "dest" + ], + "properties": { + "dest": { + "type": "string", + "description": "destination path in the container where the files should be synced to.", + "x-intellij-html-description": "destination path in the container where the files should be synced to.", + "examples": [ + "\"app/\"" + ] + }, + "src": { + "type": "string", + "description": "a glob pattern to match local paths against. Directories should be delimited by `/` on all platforms.", + "x-intellij-html-description": "a glob pattern to match local paths against. Directories should be delimited by / on all platforms.", + "examples": [ + "\"css/**/*.css\"" + ] + }, + "strip": { + "type": "string", + "description": "specifies the path prefix to remove from the source path when transplanting the files into the destination folder.", + "x-intellij-html-description": "specifies the path prefix to remove from the source path when transplanting the files into the destination folder.", + "examples": [ + "\"css/\"" + ] + } + }, + "preferredOrder": [ + "src", + "dest", + "strip" + ], + "additionalProperties": false, + "type": "object", + "description": "specifies which local files to sync to remote folders.", + "x-intellij-html-description": "specifies which local files to sync to remote folders." + }, + "TagPolicy": { + "properties": { + "customTemplate": { + "$ref": "#/definitions/CustomTemplateTagger", + "description": "*beta* tags images with a configurable template string *composed of other taggers*.", + "x-intellij-html-description": "beta tags images with a configurable template string composed of other taggers." + }, + "dateTime": { + "$ref": "#/definitions/DateTimeTagger", + "description": "*beta* tags images with the build timestamp.", + "x-intellij-html-description": "beta tags images with the build timestamp." + }, + "envTemplate": { + "$ref": "#/definitions/EnvTemplateTagger", + "description": "*beta* tags images with a configurable template string.", + "x-intellij-html-description": "beta tags images with a configurable template string." + }, + "gitCommit": { + "$ref": "#/definitions/GitTagger", + "description": "*beta* tags images with the git tag or commit of the artifact's workspace.", + "x-intellij-html-description": "beta tags images with the git tag or commit of the artifact's workspace." + }, + "inputDigest": { + "$ref": "#/definitions/InputDigest", + "description": "*beta* tags images with their sha256 digest of their content.", + "x-intellij-html-description": "beta tags images with their sha256 digest of their content." + }, + "sha256": { + "$ref": "#/definitions/ShaTagger", + "description": "*beta* tags images with their sha256 digest.", + "x-intellij-html-description": "beta tags images with their sha256 digest." + } + }, + "preferredOrder": [ + "gitCommit", + "sha256", + "envTemplate", + "dateTime", + "customTemplate", + "inputDigest" + ], + "additionalProperties": false, + "type": "object", + "description": "contains all the configuration for the tagging step.", + "x-intellij-html-description": "contains all the configuration for the tagging step." + }, + "TaggerComponent": { + "type": "object", + "anyOf": [ + { + "properties": { + "name": { + "type": "string", + "description": "an identifier for the component.", + "x-intellij-html-description": "an identifier for the component." + } + }, + "preferredOrder": [ + "name" + ], + "additionalProperties": false + }, + { + "properties": { + "gitCommit": { + "$ref": "#/definitions/GitTagger", + "description": "*beta* tags images with the git tag or commit of the artifact's workspace.", + "x-intellij-html-description": "beta tags images with the git tag or commit of the artifact's workspace." + }, + "name": { + "type": "string", + "description": "an identifier for the component.", + "x-intellij-html-description": "an identifier for the component." + } + }, + "preferredOrder": [ + "name", + "gitCommit" + ], + "additionalProperties": false + }, + { + "properties": { + "name": { + "type": "string", + "description": "an identifier for the component.", + "x-intellij-html-description": "an identifier for the component." + }, + "sha256": { + "$ref": "#/definitions/ShaTagger", + "description": "*beta* tags images with their sha256 digest.", + "x-intellij-html-description": "beta tags images with their sha256 digest." + } + }, + "preferredOrder": [ + "name", + "sha256" + ], + "additionalProperties": false + }, + { + "properties": { + "envTemplate": { + "$ref": "#/definitions/EnvTemplateTagger", + "description": "*beta* tags images with a configurable template string.", + "x-intellij-html-description": "beta tags images with a configurable template string." + }, + "name": { + "type": "string", + "description": "an identifier for the component.", + "x-intellij-html-description": "an identifier for the component." + } + }, + "preferredOrder": [ + "name", + "envTemplate" + ], + "additionalProperties": false + }, + { + "properties": { + "dateTime": { + "$ref": "#/definitions/DateTimeTagger", + "description": "*beta* tags images with the build timestamp.", + "x-intellij-html-description": "beta tags images with the build timestamp." + }, + "name": { + "type": "string", + "description": "an identifier for the component.", + "x-intellij-html-description": "an identifier for the component." + } + }, + "preferredOrder": [ + "name", + "dateTime" + ], + "additionalProperties": false + }, + { + "properties": { + "customTemplate": { + "$ref": "#/definitions/CustomTemplateTagger", + "description": "*beta* tags images with a configurable template string *composed of other taggers*.", + "x-intellij-html-description": "beta tags images with a configurable template string composed of other taggers." + }, + "name": { + "type": "string", + "description": "an identifier for the component.", + "x-intellij-html-description": "an identifier for the component." + } + }, + "preferredOrder": [ + "name", + "customTemplate" + ], + "additionalProperties": false + }, + { + "properties": { + "inputDigest": { + "$ref": "#/definitions/InputDigest", + "description": "*beta* tags images with their sha256 digest of their content.", + "x-intellij-html-description": "beta tags images with their sha256 digest of their content." + }, + "name": { + "type": "string", + "description": "an identifier for the component.", + "x-intellij-html-description": "an identifier for the component." + } + }, + "preferredOrder": [ + "name", + "inputDigest" + ], + "additionalProperties": false + } + ], + "description": "*beta* a component of CustomTemplateTagger.", + "x-intellij-html-description": "beta a component of CustomTemplateTagger." + }, + "TestCase": { + "required": [ + "image" + ], + "properties": { + "context": { + "type": "string", + "description": "directory containing the test sources.", + "x-intellij-html-description": "directory containing the test sources.", + "default": "." + }, + "custom": { + "items": { + "$ref": "#/definitions/CustomTest" + }, + "type": "array", + "description": "the set of custom tests to run after an artifact is built.", + "x-intellij-html-description": "the set of custom tests to run after an artifact is built." + }, + "image": { + "type": "string", + "description": "artifact on which to run those tests.", + "x-intellij-html-description": "artifact on which to run those tests.", + "examples": [ + "gcr.io/k8s-skaffold/example" + ] + }, + "structureTests": { + "items": { + "type": "string" + }, + "type": "array", + "description": "the [Container Structure Tests](https://github.com/GoogleContainerTools/container-structure-test) to run on that artifact.", + "x-intellij-html-description": "the Container Structure Tests to run on that artifact.", + "default": "[]", + "examples": [ + "[\"./test/*\"]" + ] + }, + "structureTestsArgs": { + "items": { + "type": "string" + }, + "type": "array", + "description": "additional configuration arguments passed to `container-structure-test` binary.", + "x-intellij-html-description": "additional configuration arguments passed to container-structure-test binary.", + "default": "[]", + "examples": [ + "[\"--driver=tar\", \"--no-color\", \"-q\"]" + ] + } + }, + "preferredOrder": [ + "image", + "context", + "custom", + "structureTests", + "structureTestsArgs" + ], + "additionalProperties": false, + "type": "object", + "description": "a list of tests to run on images that Skaffold builds.", + "x-intellij-html-description": "a list of tests to run on images that Skaffold builds." + }, + "Transformer": { + "required": [ + "name" + ], + "properties": { + "configMap": { + "items": { + "type": "string" + }, + "type": "array", + "description": "allows users to provide additional config data to the kpt function.", + "x-intellij-html-description": "allows users to provide additional config data to the kpt function.", + "default": "[]" + }, + "name": { + "type": "string", + "description": "transformer name. Can only accept skaffold whitelisted tools.", + "x-intellij-html-description": "transformer name. Can only accept skaffold whitelisted tools." + } + }, + "preferredOrder": [ + "name", + "configMap" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the supported kpt transformers.", + "x-intellij-html-description": "describes the supported kpt transformers." + }, + "Validator": { + "required": [ + "name" + ], + "properties": { + "configMap": { + "items": { + "type": "string" + }, + "type": "array", + "description": "allows users to provide additional config data to the kpt function.", + "x-intellij-html-description": "allows users to provide additional config data to the kpt function.", + "default": "[]" + }, + "name": { + "type": "string", + "description": "Validator name. Can only accept skaffold whitelisted tools.", + "x-intellij-html-description": "Validator name. Can only accept skaffold whitelisted tools." + } + }, + "preferredOrder": [ + "name", + "configMap" + ], + "additionalProperties": false, + "type": "object", + "description": "describes the supported kpt validators.", + "x-intellij-html-description": "describes the supported kpt validators." + }, + "VerifyExecutionModeConfig": { + "properties": { + "kubernetesCluster": { + "$ref": "#/definitions/KubernetesClusterVerifier", + "description": "uses the `kubectl` CLI to create veriy test case container in a kubernetes cluster.", + "x-intellij-html-description": "uses the kubectl CLI to create veriy test case container in a kubernetes cluster." + }, + "local": { + "$ref": "#/definitions/LocalVerifier", + "description": "uses the `docker` CLI to create verify test case containers on the host machine in Docker. This is the default execution mode.", + "x-intellij-html-description": "uses the docker CLI to create verify test case containers on the host machine in Docker. This is the default execution mode." + } + }, + "preferredOrder": [ + "local", + "kubernetesCluster" + ], + "type": "object", + "description": "contains all the configuration needed by the verify execution modes.", + "x-intellij-html-description": "contains all the configuration needed by the verify execution modes." + }, + "VerifyTestCase": { + "required": [ + "name", + "container" + ], + "properties": { + "container": { + "description": "container information for the verify test.", + "x-intellij-html-description": "container information for the verify test." + }, + "executionMode": { + "$ref": "#/definitions/VerifyExecutionModeConfig", + "description": "execution mode used to execute the verify test case.", + "x-intellij-html-description": "execution mode used to execute the verify test case." + }, + "name": { + "type": "string", + "description": "name descriptor for the verify test.", + "x-intellij-html-description": "name descriptor for the verify test." + } + }, + "preferredOrder": [ + "name", + "container", + "executionMode" + ], + "additionalProperties": false, + "type": "object", + "description": "a list of tests to run on images that Skaffold builds.", + "x-intellij-html-description": "a list of tests to run on images that Skaffold builds." + } + } +} diff --git a/hack/versions/cmd/new/templates/upgrade.template b/hack/versions/cmd/new/templates/upgrade.template index 77d1b92a96d..b09204a2b8a 100755 --- a/hack/versions/cmd/new/templates/upgrade.template +++ b/hack/versions/cmd/new/templates/upgrade.template @@ -17,9 +17,9 @@ limitations under the License. package %PREV_VERSION% import ( - next "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest" - "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/util" - pkgutil "github.com/GoogleContainerTools/skaffold/pkg/skaffold/util" + next "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest" + "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/util" + pkgutil "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/util" ) // Upgrade upgrades a configuration to the next version. diff --git a/hack/versions/cmd/new/templates/upgrade_test.template b/hack/versions/cmd/new/templates/upgrade_test.template index af044eb82fd..598a73f60de 100755 --- a/hack/versions/cmd/new/templates/upgrade_test.template +++ b/hack/versions/cmd/new/templates/upgrade_test.template @@ -19,9 +19,9 @@ package %PREV_VERSION% import ( "testing" - next "github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest" - "github.com/GoogleContainerTools/skaffold/pkg/skaffold/yaml" - "github.com/GoogleContainerTools/skaffold/testutil" + next "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest" + "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/yaml" + "github.com/GoogleContainerTools/skaffold/v2/testutil" ) func TestUpgrade(t *testing.T) { diff --git a/integration/examples/bazel/skaffold.yaml b/integration/examples/bazel/skaffold.yaml index 42f232546d8..67068812124 100644 --- a/integration/examples/bazel/skaffold.yaml +++ b/integration/examples/bazel/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/buildpacks-java/skaffold.yaml b/integration/examples/buildpacks-java/skaffold.yaml index 23cf068e5f1..01723896d16 100644 --- a/integration/examples/buildpacks-java/skaffold.yaml +++ b/integration/examples/buildpacks-java/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/buildpacks-node/skaffold.yaml b/integration/examples/buildpacks-node/skaffold.yaml index 2610838d606..4c0f2c49242 100644 --- a/integration/examples/buildpacks-node/skaffold.yaml +++ b/integration/examples/buildpacks-node/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/buildpacks-python/skaffold.yaml b/integration/examples/buildpacks-python/skaffold.yaml index 78577389e41..f0c80ca1342 100644 --- a/integration/examples/buildpacks-python/skaffold.yaml +++ b/integration/examples/buildpacks-python/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/buildpacks/skaffold.yaml b/integration/examples/buildpacks/skaffold.yaml index 00baec88615..17fa09bd442 100644 --- a/integration/examples/buildpacks/skaffold.yaml +++ b/integration/examples/buildpacks/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/cross-platform-builds/skaffold.yaml b/integration/examples/cross-platform-builds/skaffold.yaml index 0cabda4b4a3..1c53088f0a2 100644 --- a/integration/examples/cross-platform-builds/skaffold.yaml +++ b/integration/examples/cross-platform-builds/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/custom-buildx/skaffold.yaml b/integration/examples/custom-buildx/skaffold.yaml index 2aab382a9e3..e99b9e5e4ba 100644 --- a/integration/examples/custom-buildx/skaffold.yaml +++ b/integration/examples/custom-buildx/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: platforms: ["linux/amd64", "linux/arm64"] diff --git a/integration/examples/custom-tests/skaffold.yaml b/integration/examples/custom-tests/skaffold.yaml index 521b231760d..0e1478cbd78 100644 --- a/integration/examples/custom-tests/skaffold.yaml +++ b/integration/examples/custom-tests/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/custom/skaffold.yaml b/integration/examples/custom/skaffold.yaml index c0fd512a8b5..45bac9d5328 100644 --- a/integration/examples/custom/skaffold.yaml +++ b/integration/examples/custom/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/dev-journey-buildpacks/skaffold.yaml b/integration/examples/dev-journey-buildpacks/skaffold.yaml index 136d78def60..ec8e8578185 100644 --- a/integration/examples/dev-journey-buildpacks/skaffold.yaml +++ b/integration/examples/dev-journey-buildpacks/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/docker-deploy/skaffold.yaml b/integration/examples/docker-deploy/skaffold.yaml index ccec1890ba5..3f7375df1b7 100644 --- a/integration/examples/docker-deploy/skaffold.yaml +++ b/integration/examples/docker-deploy/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: local: diff --git a/integration/examples/gcb-kaniko/skaffold.yaml b/integration/examples/gcb-kaniko/skaffold.yaml index f68b4d1c827..550d35473f2 100644 --- a/integration/examples/gcb-kaniko/skaffold.yaml +++ b/integration/examples/gcb-kaniko/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: googleCloudBuild: diff --git a/integration/examples/generate-pipeline/skaffold.yaml b/integration/examples/generate-pipeline/skaffold.yaml index 9f81b92da31..58f9e32b89f 100644 --- a/integration/examples/generate-pipeline/skaffold.yaml +++ b/integration/examples/generate-pipeline/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/getting-started-kustomize/skaffold.yaml b/integration/examples/getting-started-kustomize/skaffold.yaml index 9444d372c76..5d3899f3253 100644 --- a/integration/examples/getting-started-kustomize/skaffold.yaml +++ b/integration/examples/getting-started-kustomize/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: getting-started-kustomize diff --git a/integration/examples/getting-started/skaffold.yaml b/integration/examples/getting-started/skaffold.yaml index 7b0f7aac5d5..b9d33f158b2 100644 --- a/integration/examples/getting-started/skaffold.yaml +++ b/integration/examples/getting-started/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/google-cloud-build/skaffold.yaml b/integration/examples/google-cloud-build/skaffold.yaml index 909f051e49b..da1d116ff1a 100644 --- a/integration/examples/google-cloud-build/skaffold.yaml +++ b/integration/examples/google-cloud-build/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: googleCloudBuild: diff --git a/integration/examples/grpc-e2e-tests/skaffold.yaml b/integration/examples/grpc-e2e-tests/skaffold.yaml index e0e3caf3a25..d5af503eb4b 100644 --- a/integration/examples/grpc-e2e-tests/skaffold.yaml +++ b/integration/examples/grpc-e2e-tests/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: visitor-counter-e2e diff --git a/integration/examples/helm-deployment-dependencies/skaffold.yaml b/integration/examples/helm-deployment-dependencies/skaffold.yaml index 5b855d482d9..802545d3999 100644 --- a/integration/examples/helm-deployment-dependencies/skaffold.yaml +++ b/integration/examples/helm-deployment-dependencies/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: tagPolicy: diff --git a/integration/examples/helm-deployment/skaffold.yaml b/integration/examples/helm-deployment/skaffold.yaml index d14c728be2b..ffde3ae49e9 100644 --- a/integration/examples/helm-deployment/skaffold.yaml +++ b/integration/examples/helm-deployment/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/helm-remote-repo/skaffold.yaml b/integration/examples/helm-remote-repo/skaffold.yaml index cc50252f76e..57380c06988 100644 --- a/integration/examples/helm-remote-repo/skaffold.yaml +++ b/integration/examples/helm-remote-repo/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config deploy: helm: diff --git a/integration/examples/helm-render/skaffold.yaml b/integration/examples/helm-render/skaffold.yaml index 5f9a820f83d..f832154a469 100644 --- a/integration/examples/helm-render/skaffold.yaml +++ b/integration/examples/helm-render/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/hot-reload/skaffold.yaml b/integration/examples/hot-reload/skaffold.yaml index 6ed43e717c8..bfacb510afe 100644 --- a/integration/examples/hot-reload/skaffold.yaml +++ b/integration/examples/hot-reload/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/jib-gradle/skaffold.yaml b/integration/examples/jib-gradle/skaffold.yaml index 7a00a8c4cea..e8221f81d42 100644 --- a/integration/examples/jib-gradle/skaffold.yaml +++ b/integration/examples/jib-gradle/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/jib-multimodule/skaffold.yaml b/integration/examples/jib-multimodule/skaffold.yaml index e5898e4e264..ee7e65ef73b 100644 --- a/integration/examples/jib-multimodule/skaffold.yaml +++ b/integration/examples/jib-multimodule/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/jib-sync/skaffold-gradle.yaml b/integration/examples/jib-sync/skaffold-gradle.yaml index ebcf79d84be..1da2cdba500 100644 --- a/integration/examples/jib-sync/skaffold-gradle.yaml +++ b/integration/examples/jib-sync/skaffold-gradle.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/jib-sync/skaffold-maven.yaml b/integration/examples/jib-sync/skaffold-maven.yaml index 8e612391089..0aec95e3480 100644 --- a/integration/examples/jib-sync/skaffold-maven.yaml +++ b/integration/examples/jib-sync/skaffold-maven.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/jib/skaffold.yaml b/integration/examples/jib/skaffold.yaml index f15189040de..d02a03df09d 100644 --- a/integration/examples/jib/skaffold.yaml +++ b/integration/examples/jib/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/kaniko/skaffold.yaml b/integration/examples/kaniko/skaffold.yaml index b3322b81245..0c9de8a298f 100644 --- a/integration/examples/kaniko/skaffold.yaml +++ b/integration/examples/kaniko/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/ko-sync-infer/skaffold.yaml b/integration/examples/ko-sync-infer/skaffold.yaml index e093f0fa1c6..8d73b531d38 100644 --- a/integration/examples/ko-sync-infer/skaffold.yaml +++ b/integration/examples/ko-sync-infer/skaffold.yaml @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/ko/skaffold.yaml b/integration/examples/ko/skaffold.yaml index 8f409d6f36a..fa1996a4eae 100644 --- a/integration/examples/ko/skaffold.yaml +++ b/integration/examples/ko/skaffold.yaml @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/kustomize/skaffold-kustomize-args.yaml b/integration/examples/kustomize/skaffold-kustomize-args.yaml index 4786a1bac1d..b51bce05ab9 100644 --- a/integration/examples/kustomize/skaffold-kustomize-args.yaml +++ b/integration/examples/kustomize/skaffold-kustomize-args.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config deploy: kustomize: diff --git a/integration/examples/kustomize/skaffold.yaml b/integration/examples/kustomize/skaffold.yaml index b92eb203bef..ed1b461852a 100644 --- a/integration/examples/kustomize/skaffold.yaml +++ b/integration/examples/kustomize/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config manifests: kustomize: diff --git a/integration/examples/lifecycle-hooks/skaffold.yaml b/integration/examples/lifecycle-hooks/skaffold.yaml index b7db9d76064..4419bfb7ed9 100644 --- a/integration/examples/lifecycle-hooks/skaffold.yaml +++ b/integration/examples/lifecycle-hooks/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config manifests: rawYaml: diff --git a/integration/examples/microservices/skaffold.yaml b/integration/examples/microservices/skaffold.yaml index 786e2028bf2..3de8e7ba65b 100644 --- a/integration/examples/microservices/skaffold.yaml +++ b/integration/examples/microservices/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/multi-config-microservices/base/skaffold.yaml b/integration/examples/multi-config-microservices/base/skaffold.yaml index fb8e24706b0..55e4e38101e 100644 --- a/integration/examples/multi-config-microservices/base/skaffold.yaml +++ b/integration/examples/multi-config-microservices/base/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/multi-config-microservices/leeroy-app/skaffold.yaml b/integration/examples/multi-config-microservices/leeroy-app/skaffold.yaml index 34fb167ba3b..db9ef5fce8e 100644 --- a/integration/examples/multi-config-microservices/leeroy-app/skaffold.yaml +++ b/integration/examples/multi-config-microservices/leeroy-app/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: app-config diff --git a/integration/examples/multi-config-microservices/leeroy-web/skaffold.yaml b/integration/examples/multi-config-microservices/leeroy-web/skaffold.yaml index 780434a6b8c..dd831297831 100644 --- a/integration/examples/multi-config-microservices/leeroy-web/skaffold.yaml +++ b/integration/examples/multi-config-microservices/leeroy-web/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: web-config diff --git a/integration/examples/multi-config-microservices/skaffold.yaml b/integration/examples/multi-config-microservices/skaffold.yaml index 8f97fc77b44..87d7085704c 100644 --- a/integration/examples/multi-config-microservices/skaffold.yaml +++ b/integration/examples/multi-config-microservices/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config requires: - path: ./leeroy-app diff --git a/integration/examples/multiple-renderers/skaffold.yaml b/integration/examples/multiple-renderers/skaffold.yaml index 30c34050441..5d7a011e494 100644 --- a/integration/examples/multiple-renderers/skaffold.yaml +++ b/integration/examples/multiple-renderers/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: go-guestbook diff --git a/integration/examples/nodejs/skaffold.yaml b/integration/examples/nodejs/skaffold.yaml index b1d3856f888..091500b1ce6 100644 --- a/integration/examples/nodejs/skaffold.yaml +++ b/integration/examples/nodejs/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: diff --git a/integration/examples/profile-patches/skaffold.yaml b/integration/examples/profile-patches/skaffold.yaml index a294ad16e89..cad6dc5f42f 100644 --- a/integration/examples/profile-patches/skaffold.yaml +++ b/integration/examples/profile-patches/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: # only build and deploy "base-service" on main profile diff --git a/integration/examples/profiles/skaffold.yaml b/integration/examples/profiles/skaffold.yaml index cebf74853e3..16bffac244f 100644 --- a/integration/examples/profiles/skaffold.yaml +++ b/integration/examples/profiles/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: # only build and deploy "world-service" on main profile diff --git a/integration/examples/react-reload-docker/skaffold.yaml b/integration/examples/react-reload-docker/skaffold.yaml index 8d84a97e2f2..cb576c93ccb 100644 --- a/integration/examples/react-reload-docker/skaffold.yaml +++ b/integration/examples/react-reload-docker/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: local: diff --git a/integration/examples/react-reload/skaffold.yaml b/integration/examples/react-reload/skaffold.yaml index 13e36f297e2..f68f400aede 100644 --- a/integration/examples/react-reload/skaffold.yaml +++ b/integration/examples/react-reload/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/remote-multi-config-microservices/skaffold.yaml b/integration/examples/remote-multi-config-microservices/skaffold.yaml index 4780c8c3d09..507a578fb53 100644 --- a/integration/examples/remote-multi-config-microservices/skaffold.yaml +++ b/integration/examples/remote-multi-config-microservices/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config requires: - git: diff --git a/integration/examples/ruby/skaffold.yaml b/integration/examples/ruby/skaffold.yaml index c9ca746e5e4..be7ba5882fb 100644 --- a/integration/examples/ruby/skaffold.yaml +++ b/integration/examples/ruby/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/simple-artifact-dependency/skaffold.yaml b/integration/examples/simple-artifact-dependency/skaffold.yaml index b3e45c2b4bd..0500ce37a7d 100644 --- a/integration/examples/simple-artifact-dependency/skaffold.yaml +++ b/integration/examples/simple-artifact-dependency/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/structure-tests/skaffold.yaml b/integration/examples/structure-tests/skaffold.yaml index 914aa3fcc4f..ec0a7d5f643 100644 --- a/integration/examples/structure-tests/skaffold.yaml +++ b/integration/examples/structure-tests/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/tagging-with-environment-variables/skaffold.yaml b/integration/examples/tagging-with-environment-variables/skaffold.yaml index 221c98a4e3b..f05315f91bc 100644 --- a/integration/examples/tagging-with-environment-variables/skaffold.yaml +++ b/integration/examples/tagging-with-environment-variables/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/examples/templated-fields/skaffold.yaml b/integration/examples/templated-fields/skaffold.yaml index 2410e3917fc..fa9ad71e10b 100644 --- a/integration/examples/templated-fields/skaffold.yaml +++ b/integration/examples/templated-fields/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: my-app diff --git a/integration/examples/typescript/skaffold.yaml b/integration/examples/typescript/skaffold.yaml index 6697e47081c..1270982b5cc 100644 --- a/integration/examples/typescript/skaffold.yaml +++ b/integration/examples/typescript/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: diff --git a/integration/examples/using-env-file/skaffold.yaml b/integration/examples/using-env-file/skaffold.yaml index 9cd4b9e1987..2da8e1bbeca 100644 --- a/integration/examples/using-env-file/skaffold.yaml +++ b/integration/examples/using-env-file/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/build-dependencies/skaffold.yaml b/integration/testdata/build-dependencies/skaffold.yaml index 5b1334794c8..af53c9460d6 100644 --- a/integration/testdata/build-dependencies/skaffold.yaml +++ b/integration/testdata/build-dependencies/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: tagPolicy: diff --git a/integration/testdata/build/docker-with-platform-amd/skaffold.yaml b/integration/testdata/build/docker-with-platform-amd/skaffold.yaml index c41882e801d..acb937dcf3a 100644 --- a/integration/testdata/build/docker-with-platform-amd/skaffold.yaml +++ b/integration/testdata/build/docker-with-platform-amd/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/build/docker-with-platform-arm/skaffold.yaml b/integration/testdata/build/docker-with-platform-arm/skaffold.yaml index 04f024d4f9a..bf9dadea365 100644 --- a/integration/testdata/build/docker-with-platform-arm/skaffold.yaml +++ b/integration/testdata/build/docker-with-platform-arm/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/build/gcb-with-platform/skaffold.yaml b/integration/testdata/build/gcb-with-platform/skaffold.yaml index 1746e90ee34..da16a64f8e4 100644 --- a/integration/testdata/build/gcb-with-platform/skaffold.yaml +++ b/integration/testdata/build/gcb-with-platform/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/build/secret/skaffold.yaml b/integration/testdata/build/secret/skaffold.yaml index 684c4a00bea..8ad8e90d949 100644 --- a/integration/testdata/build/secret/skaffold.yaml +++ b/integration/testdata/build/secret/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: local: diff --git a/integration/testdata/build/skaffold.yaml b/integration/testdata/build/skaffold.yaml index 2b4533bfba5..03a9db2bbe7 100644 --- a/integration/testdata/build/skaffold.yaml +++ b/integration/testdata/build/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: local: diff --git a/integration/testdata/build/squash/skaffold.yaml b/integration/testdata/build/squash/skaffold.yaml index ba3ca86112a..8149f4bebb0 100644 --- a/integration/testdata/build/squash/skaffold.yaml +++ b/integration/testdata/build/squash/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/build/ssh/skaffold.yaml b/integration/testdata/build/ssh/skaffold.yaml index 078417c3ae1..c5fad946b66 100644 --- a/integration/testdata/build/ssh/skaffold.yaml +++ b/integration/testdata/build/ssh/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: local: diff --git a/integration/testdata/custom-test/skaffold.yaml b/integration/testdata/custom-test/skaffold.yaml index f02ae9efdcf..dbd5d9421f7 100644 --- a/integration/testdata/custom-test/skaffold.yaml +++ b/integration/testdata/custom-test/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/debug/skaffold.yaml b/integration/testdata/debug/skaffold.yaml index 62ea85496d5..f6a22f68068 100644 --- a/integration/testdata/debug/skaffold.yaml +++ b/integration/testdata/debug/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/deploy-cloudrun-with-hooks/module1/skaffold.yaml b/integration/testdata/deploy-cloudrun-with-hooks/module1/skaffold.yaml index 5b4cede92d4..6ccb6f71063 100644 --- a/integration/testdata/deploy-cloudrun-with-hooks/module1/skaffold.yaml +++ b/integration/testdata/deploy-cloudrun-with-hooks/module1/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: cloud-run-hooks-module1 diff --git a/integration/testdata/deploy-cloudrun-with-hooks/module2/skaffold.yaml b/integration/testdata/deploy-cloudrun-with-hooks/module2/skaffold.yaml index c8de25cf107..c16517c59ef 100644 --- a/integration/testdata/deploy-cloudrun-with-hooks/module2/skaffold.yaml +++ b/integration/testdata/deploy-cloudrun-with-hooks/module2/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: cloud-run-hooks-module2 diff --git a/integration/testdata/deploy-cloudrun-with-hooks/skaffold.yaml b/integration/testdata/deploy-cloudrun-with-hooks/skaffold.yaml index a472acc7cf0..2dae1d7fc35 100644 --- a/integration/testdata/deploy-cloudrun-with-hooks/skaffold.yaml +++ b/integration/testdata/deploy-cloudrun-with-hooks/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config requires: - path: ./module1 diff --git a/integration/testdata/deploy-cloudrun/skaffold.yaml b/integration/testdata/deploy-cloudrun/skaffold.yaml index 7c141eeb198..fee87ed17eb 100644 --- a/integration/testdata/deploy-cloudrun/skaffold.yaml +++ b/integration/testdata/deploy-cloudrun/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: cloud-run-test diff --git a/integration/testdata/deploy-hello-tail/skaffold.yaml b/integration/testdata/deploy-hello-tail/skaffold.yaml index 159e47c4b4a..99e03ce49e7 100644 --- a/integration/testdata/deploy-hello-tail/skaffold.yaml +++ b/integration/testdata/deploy-hello-tail/skaffold.yaml @@ -1,2 +1,2 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config diff --git a/integration/testdata/deploy-multiple/skaffold.yaml b/integration/testdata/deploy-multiple/skaffold.yaml index e36b82c6e7c..d86a4c81974 100644 --- a/integration/testdata/deploy-multiple/skaffold.yaml +++ b/integration/testdata/deploy-multiple/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/dev/skaffold.yaml b/integration/testdata/dev/skaffold.yaml index 0eaf83c3fc5..3d8d3cc6808 100644 --- a/integration/testdata/dev/skaffold.yaml +++ b/integration/testdata/dev/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/diagnose/multi-config/diagnose.tmpl b/integration/testdata/diagnose/multi-config/diagnose.tmpl index 15bfdbf8dd2..9e4fcedd223 100644 --- a/integration/testdata/diagnose/multi-config/diagnose.tmpl +++ b/integration/testdata/diagnose/multi-config/diagnose.tmpl @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: cfg2 @@ -19,7 +19,7 @@ deploy: logs: prefix: container --- -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: cfg3 @@ -40,7 +40,7 @@ deploy: logs: prefix: container --- -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/diagnose/multi-config/skaffold.yaml b/integration/testdata/diagnose/multi-config/skaffold.yaml index b77389017fe..e780e093386 100644 --- a/integration/testdata/diagnose/multi-config/skaffold.yaml +++ b/integration/testdata/diagnose/multi-config/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config requires: - path: ./skaffold2.yaml diff --git a/integration/testdata/diagnose/multi-config/skaffold2.yaml b/integration/testdata/diagnose/multi-config/skaffold2.yaml index 8bc82bc23fb..7c6c27779a3 100644 --- a/integration/testdata/diagnose/multi-config/skaffold2.yaml +++ b/integration/testdata/diagnose/multi-config/skaffold2.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: cfg2 diff --git a/integration/testdata/diagnose/multi-config/skaffold3.yaml b/integration/testdata/diagnose/multi-config/skaffold3.yaml index 45d206ec833..ae6b3e5ab38 100644 --- a/integration/testdata/diagnose/multi-config/skaffold3.yaml +++ b/integration/testdata/diagnose/multi-config/skaffold3.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: cfg3 diff --git a/integration/testdata/diagnose/temp-config/diagnose.tmpl b/integration/testdata/diagnose/temp-config/diagnose.tmpl index c1aba00e372..a8c8d202204 100644 --- a/integration/testdata/diagnose/temp-config/diagnose.tmpl +++ b/integration/testdata/diagnose/temp-config/diagnose.tmpl @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/diagnose/temp-config/skaffold.yaml b/integration/testdata/diagnose/temp-config/skaffold.yaml index b5e30d03075..e64463b9591 100644 --- a/integration/testdata/diagnose/temp-config/skaffold.yaml +++ b/integration/testdata/diagnose/temp-config/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/empty-dir/skaffold.yaml b/integration/testdata/empty-dir/skaffold.yaml index a5007294c08..d8390383899 100644 --- a/integration/testdata/empty-dir/skaffold.yaml +++ b/integration/testdata/empty-dir/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/file-sync/skaffold-infer.yaml b/integration/testdata/file-sync/skaffold-infer.yaml index 90fa3a80168..6059f3f4079 100644 --- a/integration/testdata/file-sync/skaffold-infer.yaml +++ b/integration/testdata/file-sync/skaffold-infer.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: tagPolicy: diff --git a/integration/testdata/file-sync/skaffold-manual.yaml b/integration/testdata/file-sync/skaffold-manual.yaml index 350b1b37a7c..101193cbdce 100644 --- a/integration/testdata/file-sync/skaffold-manual.yaml +++ b/integration/testdata/file-sync/skaffold-manual.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: tagPolicy: diff --git a/integration/testdata/gcb-with-location/skaffold.yaml b/integration/testdata/gcb-with-location/skaffold.yaml index bbd6d8a5475..8fcb4473c25 100644 --- a/integration/testdata/gcb-with-location/skaffold.yaml +++ b/integration/testdata/gcb-with-location/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/getting-started/skaffold.yaml b/integration/testdata/getting-started/skaffold.yaml index a5007294c08..d8390383899 100644 --- a/integration/testdata/getting-started/skaffold.yaml +++ b/integration/testdata/getting-started/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/gke_loadbalancer-render/skaffold.yaml b/integration/testdata/gke_loadbalancer-render/skaffold.yaml index 11296853cd1..f15144f9e16 100644 --- a/integration/testdata/gke_loadbalancer-render/skaffold.yaml +++ b/integration/testdata/gke_loadbalancer-render/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/gke_loadbalancer/skaffold.yaml b/integration/testdata/gke_loadbalancer/skaffold.yaml index 9b4af37f7fa..f741c944d86 100644 --- a/integration/testdata/gke_loadbalancer/skaffold.yaml +++ b/integration/testdata/gke_loadbalancer/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/hello/skaffold.yaml b/integration/testdata/hello/skaffold.yaml index 89800aedc77..5d8c8691aa7 100644 --- a/integration/testdata/hello/skaffold.yaml +++ b/integration/testdata/hello/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/helm-namespace/skaffold.yaml b/integration/testdata/helm-namespace/skaffold.yaml index 9e80db4bbe0..0c0a6abfe24 100644 --- a/integration/testdata/helm-namespace/skaffold.yaml +++ b/integration/testdata/helm-namespace/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config deploy: diff --git a/integration/testdata/helm-render/skaffold.yaml b/integration/testdata/helm-render/skaffold.yaml index 84d12200dc2..b34c109f59e 100644 --- a/integration/testdata/helm-render/skaffold.yaml +++ b/integration/testdata/helm-render/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: tagPolicy: diff --git a/integration/testdata/helm/skaffold.yaml b/integration/testdata/helm/skaffold.yaml index c1cdcc28178..fdf160ddd4b 100644 --- a/integration/testdata/helm/skaffold.yaml +++ b/integration/testdata/helm/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: tagPolicy: diff --git a/integration/testdata/init/compose/skaffold.yaml b/integration/testdata/init/compose/skaffold.yaml index 333eb7e7163..0dfbff99620 100644 --- a/integration/testdata/init/compose/skaffold.yaml +++ b/integration/testdata/init/compose/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: compose diff --git a/integration/testdata/init/hello-with-manifest/skaffold.yaml b/integration/testdata/init/hello-with-manifest/skaffold.yaml index 9cca6371303..52601e7e461 100644 --- a/integration/testdata/init/hello-with-manifest/skaffold.yaml +++ b/integration/testdata/init/hello-with-manifest/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: hello-with-manifest diff --git a/integration/testdata/init/helm-project/skaffold.yaml b/integration/testdata/init/helm-project/skaffold.yaml index e9e78a59843..fdb63617c62 100644 --- a/integration/testdata/init/helm-project/skaffold.yaml +++ b/integration/testdata/init/helm-project/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: helm-project diff --git a/integration/testdata/inspect/cluster/skaffold.add.default.yaml b/integration/testdata/inspect/cluster/skaffold.add.default.yaml index 64cf4279bfb..4d09f47ab8a 100644 --- a/integration/testdata/inspect/cluster/skaffold.add.default.yaml +++ b/integration/testdata/inspect/cluster/skaffold.add.default.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/cluster/skaffold.add.profile.yaml b/integration/testdata/inspect/cluster/skaffold.add.profile.yaml index f751911f4a4..c4a3fd52c81 100644 --- a/integration/testdata/inspect/cluster/skaffold.add.profile.yaml +++ b/integration/testdata/inspect/cluster/skaffold.add.profile.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/cluster/skaffold.cluster.yaml b/integration/testdata/inspect/cluster/skaffold.cluster.yaml index a8882699e75..88a6f8c117e 100644 --- a/integration/testdata/inspect/cluster/skaffold.cluster.yaml +++ b/integration/testdata/inspect/cluster/skaffold.cluster.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/cluster/skaffold.local.yaml b/integration/testdata/inspect/cluster/skaffold.local.yaml index 7aa5845c77e..3bfdba955a0 100644 --- a/integration/testdata/inspect/cluster/skaffold.local.yaml +++ b/integration/testdata/inspect/cluster/skaffold.local.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/cluster/skaffold.modified.default.yaml b/integration/testdata/inspect/cluster/skaffold.modified.default.yaml index 7eb271ddb61..93407a0fd74 100644 --- a/integration/testdata/inspect/cluster/skaffold.modified.default.yaml +++ b/integration/testdata/inspect/cluster/skaffold.modified.default.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/cluster/skaffold.modified.profile.yaml b/integration/testdata/inspect/cluster/skaffold.modified.profile.yaml index 4721156ea82..36a9f8999ad 100644 --- a/integration/testdata/inspect/cluster/skaffold.modified.profile.yaml +++ b/integration/testdata/inspect/cluster/skaffold.modified.profile.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/gcb/skaffold.add.default.yaml b/integration/testdata/inspect/gcb/skaffold.add.default.yaml index b5b5be94483..c835d28f6a5 100644 --- a/integration/testdata/inspect/gcb/skaffold.add.default.yaml +++ b/integration/testdata/inspect/gcb/skaffold.add.default.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/gcb/skaffold.add.profile.yaml b/integration/testdata/inspect/gcb/skaffold.add.profile.yaml index 38e4d473755..7aee1ff40d8 100644 --- a/integration/testdata/inspect/gcb/skaffold.add.profile.yaml +++ b/integration/testdata/inspect/gcb/skaffold.add.profile.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/gcb/skaffold.gcb.yaml b/integration/testdata/inspect/gcb/skaffold.gcb.yaml index 86b5feba653..119e3f893eb 100644 --- a/integration/testdata/inspect/gcb/skaffold.gcb.yaml +++ b/integration/testdata/inspect/gcb/skaffold.gcb.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/gcb/skaffold.local.yaml b/integration/testdata/inspect/gcb/skaffold.local.yaml index cec8d27aad8..e7da60c57e2 100644 --- a/integration/testdata/inspect/gcb/skaffold.local.yaml +++ b/integration/testdata/inspect/gcb/skaffold.local.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/gcb/skaffold.modified.default.yaml b/integration/testdata/inspect/gcb/skaffold.modified.default.yaml index 430277010fd..f63eaaaa78c 100644 --- a/integration/testdata/inspect/gcb/skaffold.modified.default.yaml +++ b/integration/testdata/inspect/gcb/skaffold.modified.default.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/inspect/gcb/skaffold.modified.profile.yaml b/integration/testdata/inspect/gcb/skaffold.modified.profile.yaml index 39a3c5e7df6..47db1881d1c 100644 --- a/integration/testdata/inspect/gcb/skaffold.modified.profile.yaml +++ b/integration/testdata/inspect/gcb/skaffold.modified.profile.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/jib/skaffold.yaml b/integration/testdata/jib/skaffold.yaml index 1e7d4b19d3f..e44227b6fb6 100644 --- a/integration/testdata/jib/skaffold.yaml +++ b/integration/testdata/jib/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/kaniko-explicit-repo/skaffold.yaml b/integration/testdata/kaniko-explicit-repo/skaffold.yaml index 717b60cafb0..84b8b6a98d0 100644 --- a/integration/testdata/kaniko-explicit-repo/skaffold.yaml +++ b/integration/testdata/kaniko-explicit-repo/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/kaniko-insecure-registry/app/skaffold.yaml b/integration/testdata/kaniko-insecure-registry/app/skaffold.yaml index b5e30d03075..e64463b9591 100644 --- a/integration/testdata/kaniko-insecure-registry/app/skaffold.yaml +++ b/integration/testdata/kaniko-insecure-registry/app/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/kaniko-insecure-registry/skaffold.yaml b/integration/testdata/kaniko-insecure-registry/skaffold.yaml index 3925c31e49f..36c800980ad 100644 --- a/integration/testdata/kaniko-insecure-registry/skaffold.yaml +++ b/integration/testdata/kaniko-insecure-registry/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config profiles: - name: build-artifact diff --git a/integration/testdata/kaniko-microservices/skaffold.yaml b/integration/testdata/kaniko-microservices/skaffold.yaml index 479159dd106..a33e9beab5a 100644 --- a/integration/testdata/kaniko-microservices/skaffold.yaml +++ b/integration/testdata/kaniko-microservices/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/kaniko-sub-folder/skaffold.yaml b/integration/testdata/kaniko-sub-folder/skaffold.yaml index dd636bbe265..fc6e5575ca7 100644 --- a/integration/testdata/kaniko-sub-folder/skaffold.yaml +++ b/integration/testdata/kaniko-sub-folder/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/kaniko-target/skaffold.yaml b/integration/testdata/kaniko-target/skaffold.yaml index 3476dfef7d3..edb763ce0c8 100644 --- a/integration/testdata/kaniko-target/skaffold.yaml +++ b/integration/testdata/kaniko-target/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/modules/app1/skaffold.yaml b/integration/testdata/modules/app1/skaffold.yaml index dba79a4d0fa..6683f240bf4 100644 --- a/integration/testdata/modules/app1/skaffold.yaml +++ b/integration/testdata/modules/app1/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config requires: - path: ../app2 diff --git a/integration/testdata/modules/app2/skaffold.yaml b/integration/testdata/modules/app2/skaffold.yaml index fc20f554003..c1b4258df9e 100644 --- a/integration/testdata/modules/app2/skaffold.yaml +++ b/integration/testdata/modules/app2/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config requires: - path: ../app3 diff --git a/integration/testdata/modules/app3/skaffold.yaml b/integration/testdata/modules/app3/skaffold.yaml index aafa4e5ffd1..490e531094c 100644 --- a/integration/testdata/modules/app3/skaffold.yaml +++ b/integration/testdata/modules/app3/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: tagPolicy: diff --git a/integration/testdata/modules/skaffold.yaml b/integration/testdata/modules/skaffold.yaml index 1a811c033c0..4924ac5cc91 100644 --- a/integration/testdata/modules/skaffold.yaml +++ b/integration/testdata/modules/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config requires: - path: app1 diff --git a/integration/testdata/multi-config-pods/module1/skaffold.yaml b/integration/testdata/multi-config-pods/module1/skaffold.yaml index 116d9fac4cd..fb487e95193 100644 --- a/integration/testdata/multi-config-pods/module1/skaffold.yaml +++ b/integration/testdata/multi-config-pods/module1/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/multi-config-pods/module2/skaffold.yaml b/integration/testdata/multi-config-pods/module2/skaffold.yaml index 38e270a41d8..ddff7cc59f6 100644 --- a/integration/testdata/multi-config-pods/module2/skaffold.yaml +++ b/integration/testdata/multi-config-pods/module2/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/multi-config-pods/skaffold.yaml b/integration/testdata/multi-config-pods/skaffold.yaml index e579494c46e..668e8cba1ca 100644 --- a/integration/testdata/multi-config-pods/skaffold.yaml +++ b/integration/testdata/multi-config-pods/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config requires: - path: ./module1 diff --git a/integration/testdata/tagPolicy/skaffold.yaml b/integration/testdata/tagPolicy/skaffold.yaml index d783514c559..a798587661d 100644 --- a/integration/testdata/tagPolicy/skaffold.yaml +++ b/integration/testdata/tagPolicy/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/test-events/skaffold.yaml b/integration/testdata/test-events/skaffold.yaml index 0b5a268afe5..33eeaffead7 100644 --- a/integration/testdata/test-events/skaffold.yaml +++ b/integration/testdata/test-events/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config build: artifacts: diff --git a/integration/testdata/verify-fail-k8s/skaffold.yaml b/integration/testdata/verify-fail-k8s/skaffold.yaml index 2b8ed0db249..152c4e7836a 100644 --- a/integration/testdata/verify-fail-k8s/skaffold.yaml +++ b/integration/testdata/verify-fail-k8s/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config verify: - name: hello-world diff --git a/integration/testdata/verify-fail/skaffold.yaml b/integration/testdata/verify-fail/skaffold.yaml index a33c0633a74..c2b21849037 100644 --- a/integration/testdata/verify-fail/skaffold.yaml +++ b/integration/testdata/verify-fail/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config verify: - name: hello-world diff --git a/integration/testdata/verify-no-tests/skaffold.yaml b/integration/testdata/verify-no-tests/skaffold.yaml index a9fcab1c4c7..76e37b5b112 100644 --- a/integration/testdata/verify-no-tests/skaffold.yaml +++ b/integration/testdata/verify-no-tests/skaffold.yaml @@ -1,3 +1,3 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config verify: diff --git a/integration/testdata/verify-succeed-k8s/skaffold.yaml b/integration/testdata/verify-succeed-k8s/skaffold.yaml index fef40e6d608..7d0e8a7915a 100644 --- a/integration/testdata/verify-succeed-k8s/skaffold.yaml +++ b/integration/testdata/verify-succeed-k8s/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config verify: - name: hello-world-1 diff --git a/integration/testdata/verify-succeed/skaffold.yaml b/integration/testdata/verify-succeed/skaffold.yaml index 801e1e2ee9e..92d56541919 100644 --- a/integration/testdata/verify-succeed/skaffold.yaml +++ b/integration/testdata/verify-succeed/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config verify: - name: hello-world-1 diff --git a/pkg/skaffold/initializer/testdata/init/allcli/skaffold.yaml b/pkg/skaffold/initializer/testdata/init/allcli/skaffold.yaml index 330ecf6933f..c614bed44d1 100644 --- a/pkg/skaffold/initializer/testdata/init/allcli/skaffold.yaml +++ b/pkg/skaffold/initializer/testdata/init/allcli/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: allcli diff --git a/pkg/skaffold/initializer/testdata/init/getting-started-kustomize/skaffold.yaml b/pkg/skaffold/initializer/testdata/init/getting-started-kustomize/skaffold.yaml index 5e0fc373bf8..8c8311fedc9 100644 --- a/pkg/skaffold/initializer/testdata/init/getting-started-kustomize/skaffold.yaml +++ b/pkg/skaffold/initializer/testdata/init/getting-started-kustomize/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: getting-started-kustomize diff --git a/pkg/skaffold/initializer/testdata/init/hello-no-manifest/skaffold.yaml b/pkg/skaffold/initializer/testdata/init/hello-no-manifest/skaffold.yaml index 99f1b391f37..f56126fe39b 100644 --- a/pkg/skaffold/initializer/testdata/init/hello-no-manifest/skaffold.yaml +++ b/pkg/skaffold/initializer/testdata/init/hello-no-manifest/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: hello diff --git a/pkg/skaffold/initializer/testdata/init/hello/skaffold.yaml b/pkg/skaffold/initializer/testdata/init/hello/skaffold.yaml index fadbb694044..2f8f4273848 100644 --- a/pkg/skaffold/initializer/testdata/init/hello/skaffold.yaml +++ b/pkg/skaffold/initializer/testdata/init/hello/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: hello diff --git a/pkg/skaffold/initializer/testdata/init/helm-deployment/skaffold.yaml b/pkg/skaffold/initializer/testdata/init/helm-deployment/skaffold.yaml index cc9873a9153..ff06b0d0f39 100644 --- a/pkg/skaffold/initializer/testdata/init/helm-deployment/skaffold.yaml +++ b/pkg/skaffold/initializer/testdata/init/helm-deployment/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: "helm-deployment" diff --git a/pkg/skaffold/initializer/testdata/init/ignore-tags/skaffold.yaml b/pkg/skaffold/initializer/testdata/init/ignore-tags/skaffold.yaml index 391f5337bf4..87c558a24e5 100644 --- a/pkg/skaffold/initializer/testdata/init/ignore-tags/skaffold.yaml +++ b/pkg/skaffold/initializer/testdata/init/ignore-tags/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: ignore-tags diff --git a/pkg/skaffold/initializer/testdata/init/microservices/skaffold.yaml b/pkg/skaffold/initializer/testdata/init/microservices/skaffold.yaml index 40634256e86..ea02749ebb5 100644 --- a/pkg/skaffold/initializer/testdata/init/microservices/skaffold.yaml +++ b/pkg/skaffold/initializer/testdata/init/microservices/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: microservices diff --git a/pkg/skaffold/initializer/testdata/init/windows/skaffold.yaml b/pkg/skaffold/initializer/testdata/init/windows/skaffold.yaml index 08e46271aea..4e5838f96c1 100644 --- a/pkg/skaffold/initializer/testdata/init/windows/skaffold.yaml +++ b/pkg/skaffold/initializer/testdata/init/windows/skaffold.yaml @@ -1,4 +1,4 @@ -apiVersion: skaffold/v4beta3 +apiVersion: skaffold/v4beta4 kind: Config metadata: name: windows diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go index 496beac26a8..ed0b43a510c 100644 --- a/pkg/skaffold/schema/latest/config.go +++ b/pkg/skaffold/schema/latest/config.go @@ -26,7 +26,7 @@ import ( ) // This config version is not yet released, it is SAFE TO MODIFY the structs in this file. -const Version string = "skaffold/v4beta3" +const Version string = "skaffold/v4beta4" // NewSkaffoldConfig creates a SkaffoldConfig func NewSkaffoldConfig() util.VersionedConfig { @@ -574,6 +574,7 @@ type VerifyExecutionModeConfig struct { // verify test case will be executed. type VerifyExecutionModeType struct { // LocalExecutionMode uses the `docker` CLI to create verify test case containers on the host machine in Docker. + // This is the default execution mode. LocalExecutionMode *LocalVerifier `yaml:"local,omitempty"` // KubernetesClusterExecutionMode uses the `kubectl` CLI to create veriy test case @@ -582,21 +583,11 @@ type VerifyExecutionModeType struct { } // LocalVerifier uses the `docker` CLI to create verify test case containers on the host machine in Docker. -type LocalVerifier struct { - // LocalVerifyTestCases is a list of verify test cases to run locally. - // LocalVerifyTestCases []*LocalVerifyTestCase `yaml:"testCases,omitempty"` - -} +type LocalVerifier struct{} // KubernetesClusterVerifier uses the `kubectl` CLI to create veriy test case // container in a kubernetes cluster. type KubernetesClusterVerifier struct { - // // Flags are additional flags passed to `kubectl`. - // Flags KubectlFlags `yaml:"flags,omitempty"` - - // // DefaultNamespace is the default namespace passed to kubectl on deployment if no other override is given. - // DefaultNamespace *string `yaml:"defaultNamespace,omitempty"` - // Overrides is the inline JSON override to use for the generated kubernetes Job. // If this is non-empty, it is used to override the generated object. Similar to // the `--overrides` kubectl flag. diff --git a/pkg/skaffold/schema/v4beta2/upgrade.go b/pkg/skaffold/schema/v4beta2/upgrade.go index 90b2d6a2214..6407283e773 100755 --- a/pkg/skaffold/schema/v4beta2/upgrade.go +++ b/pkg/skaffold/schema/v4beta2/upgrade.go @@ -17,8 +17,8 @@ limitations under the License. package v4beta2 import ( - next "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest" "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/util" + next "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/v4beta3" pkgutil "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/util" ) diff --git a/pkg/skaffold/schema/v4beta2/upgrade_test.go b/pkg/skaffold/schema/v4beta2/upgrade_test.go index bd41eaf8fc2..86b73718a17 100755 --- a/pkg/skaffold/schema/v4beta2/upgrade_test.go +++ b/pkg/skaffold/schema/v4beta2/upgrade_test.go @@ -19,7 +19,7 @@ package v4beta2 import ( "testing" - next "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest" + next "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/v4beta3" "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/yaml" "github.com/GoogleContainerTools/skaffold/v2/testutil" ) diff --git a/pkg/skaffold/schema/v4beta3/config.go b/pkg/skaffold/schema/v4beta3/config.go new file mode 100755 index 00000000000..2a71e6ac96d --- /dev/null +++ b/pkg/skaffold/schema/v4beta3/config.go @@ -0,0 +1,1838 @@ +/* +Copyright 2021 The Skaffold Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package v4beta3 + +import ( + "encoding/json" + + v1 "k8s.io/api/core/v1" + "sigs.k8s.io/kustomize/kyaml/yaml" + + "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/util" +) + +// !!! WARNING !!! This config version is already released, please DO NOT MODIFY the structs in this file. +const Version string = "skaffold/v4beta3" + +// NewSkaffoldConfig creates a SkaffoldConfig +func NewSkaffoldConfig() util.VersionedConfig { + return new(SkaffoldConfig) +} + +// SkaffoldConfig holds the fields parsed from the Skaffold configuration file (skaffold.yaml). +type SkaffoldConfig struct { + // APIVersion is the version of the configuration. + APIVersion string `yaml:"apiVersion" yamltags:"required"` + + // Kind is always `Config`. Defaults to `Config`. + Kind string `yaml:"kind" yamltags:"required"` + + // Metadata holds additional information about the config. + Metadata Metadata `yaml:"metadata,omitempty"` + + // Dependencies describes a list of other required configs for the current config. + Dependencies []ConfigDependency `yaml:"requires,omitempty"` + + // Pipeline defines the Build/Test/Deploy phases. + Pipeline `yaml:",inline"` + + // Profiles *beta* can override be used to `build`, `test` or `deploy` configuration. + Profiles []Profile `yaml:"profiles,omitempty"` +} + +// Metadata holds an optional name of the project. +type Metadata struct { + // Name is an identifier for the project. + Name string `yaml:"name,omitempty"` + + // Labels is a map of labels identifying the project. + Labels map[string]string `yaml:"labels,omitempty"` + + // Annotations is a map of annotations providing additional + // metadata about the project. + Annotations map[string]string `yaml:"annotations,omitempty"` +} + +// Pipeline describes a Skaffold pipeline. +type Pipeline struct { + // Build describes how images are built. + Build BuildConfig `yaml:"build,omitempty"` + + // Test describes how images are tested. + Test []*TestCase `yaml:"test,omitempty"` + + // Render describes how the original manifests are hydrated, validated and transformed. + Render RenderConfig `yaml:"manifests,omitempty"` + + // Deploy describes how the manifests are deployed. + Deploy DeployConfig `yaml:"deploy,omitempty"` + + // PortForward describes user defined resources to port-forward. + PortForward []*PortForwardResource `yaml:"portForward,omitempty"` + + // ResourceSelector describes user defined filters describing how skaffold should treat objects/fields during rendering. + ResourceSelector ResourceSelectorConfig `yaml:"resourceSelector,omitempty"` + + // Verify describes how images are verified (via verification tests). + Verify []*VerifyTestCase `yaml:"verify,omitempty"` +} + +// GitInfo contains information on the origin of skaffold configurations cloned from a git repository. +type GitInfo struct { + // Repo is the git repository the package should be cloned from. e.g. `https://github.com/GoogleContainerTools/skaffold.git`. + Repo string `yaml:"repo" yamltags:"required"` + + // Path is the relative path from the repo root to the skaffold configuration file. eg. `getting-started/skaffold.yaml`. + Path string `yaml:"path,omitempty"` + + // Ref is the git ref the package should be cloned from. eg. `master` or `main`. + Ref string `yaml:"ref,omitempty"` + + // Sync when set to `true` will reset the cached repository to the latest commit from remote on every run. To use the cached repository with uncommitted changes or unpushed commits, it needs to be set to `false`. + Sync *bool `yaml:"sync,omitempty"` +} + +// ConfigDependency describes a dependency on another skaffold configuration. +type ConfigDependency struct { + // Names includes specific named configs within the file path. If empty, then all configs in the file are included. + Names []string `yaml:"configs,omitempty"` + + // Path describes the path to the file containing the required configs. + Path string `yaml:"path,omitempty" skaffold:"filepath" yamltags:"oneOf=paths"` + + // GitRepo describes a remote git repository containing the required configs. + GitRepo *GitInfo `yaml:"git,omitempty" yamltags:"oneOf=paths"` + + // ActiveProfiles describes the list of profiles to activate when resolving the required configs. These profiles must exist in the imported config. + ActiveProfiles []ProfileDependency `yaml:"activeProfiles,omitempty"` +} + +// ProfileDependency describes a mapping from referenced config profiles to the current config profiles. +// If the current config is activated with a profile in this mapping then the dependency configs are also activated with the corresponding mapped profiles. +type ProfileDependency struct { + // Name describes name of the profile to activate in the dependency config. It should exist in the dependency config. + Name string `yaml:"name" yamltags:"required"` + + // ActivatedBy describes a list of profiles in the current config that when activated will also activate the named profile in the dependency config. If empty then the named profile is always activated. + ActivatedBy []string `yaml:"activatedBy,omitempty"` +} + +func (c *SkaffoldConfig) GetVersion() string { + return c.APIVersion +} + +// ResourceType describes the Kubernetes resource types used for port forwarding. +type ResourceType string + +// PortForwardResource describes a resource to port forward. +type PortForwardResource struct { + // Type is the resource type that should be port forwarded. + // Acceptable resource types include kubernetes types: `Service`, `Pod` and Controller resource type that has a pod spec: `ReplicaSet`, `ReplicationController`, `Deployment`, `StatefulSet`, `DaemonSet`, `Job`, `CronJob`. + // Standalone `Container` is also valid for Docker deployments. + Type ResourceType `yaml:"resourceType,omitempty"` + + // Name is the name of the Kubernetes resource or local container to port forward. + Name string `yaml:"resourceName,omitempty"` + + // Namespace is the namespace of the resource to port forward. Does not apply to local containers. + Namespace string `yaml:"namespace,omitempty"` + + // Port is the resource port that will be forwarded. + Port util.IntOrString `yaml:"port,omitempty"` + + // Address is the local address to bind to. Defaults to the loopback address 127.0.0.1. + Address string `yaml:"address,omitempty"` + + // LocalPort is the local port to forward to. If the port is unavailable, Skaffold will choose a random open port to forward to. *Optional*. + LocalPort int `yaml:"localPort,omitempty"` +} + +// ResourceSelectorConfig contains all the configuration needed by the deploy steps. +type ResourceSelectorConfig struct { + // Allow configures an allowlist for transforming manifests. + Allow []ResourceFilter `yaml:"allow,omitempty"` + // Deny configures an allowlist for transforming manifests. + Deny []ResourceFilter `yaml:"deny,omitempty"` +} + +// BuildConfig contains all the configuration for the build steps. +type BuildConfig struct { + // Artifacts lists the images you're going to be building. + Artifacts []*Artifact `yaml:"artifacts,omitempty"` + + // InsecureRegistries is a list of registries declared by the user to be insecure. + // These registries will be connected to via HTTP instead of HTTPS. + InsecureRegistries []string `yaml:"insecureRegistries,omitempty"` + + // TagPolicy *beta* determines how images are tagged. + // A few strategies are provided here, although you most likely won't need to care! + // If not specified, it defaults to `gitCommit: {variant: Tags}`. + TagPolicy TagPolicy `yaml:"tagPolicy,omitempty"` + + // Platforms is the list of platforms to build all artifact images for. + // It can be overridden by the individual artifact's `platforms` property. + // If the target builder cannot build for atleast one of the specified platforms, then the build fails. + // Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. + // Example: `["linux/amd64", "linux/arm64"]`. + Platforms []string `yaml:"platforms,omitempty"` + + BuildType `yaml:",inline"` +} + +// TagPolicy contains all the configuration for the tagging step. +type TagPolicy struct { + // GitTagger *beta* tags images with the git tag or commit of the artifact's workspace. + GitTagger *GitTagger `yaml:"gitCommit,omitempty" yamltags:"oneOf=tag"` + + // ShaTagger *beta* tags images with their sha256 digest. + ShaTagger *ShaTagger `yaml:"sha256,omitempty" yamltags:"oneOf=tag"` + + // EnvTemplateTagger *beta* tags images with a configurable template string. + EnvTemplateTagger *EnvTemplateTagger `yaml:"envTemplate,omitempty" yamltags:"oneOf=tag"` + + // DateTimeTagger *beta* tags images with the build timestamp. + DateTimeTagger *DateTimeTagger `yaml:"dateTime,omitempty" yamltags:"oneOf=tag"` + + // CustomTemplateTagger *beta* tags images with a configurable template string *composed of other taggers*. + CustomTemplateTagger *CustomTemplateTagger `yaml:"customTemplate,omitempty" yamltags:"oneOf=tag"` + + // InputDigest *beta* tags images with their sha256 digest of their content. + InputDigest *InputDigest `yaml:"inputDigest,omitempty" yamltags:"oneOf=tag"` +} + +// ShaTagger *beta* tags images with their sha256 digest. +type ShaTagger struct{} + +// InputDigest *beta* tags hashes the image content. +type InputDigest struct{} + +// GitTagger *beta* tags images with the git tag or commit of the artifact's workspace. +type GitTagger struct { + // Variant determines the behavior of the git tagger. Valid variants are: + // `Tags` (default): use git tags or fall back to abbreviated commit hash. + // `CommitSha`: use the full git commit sha. + // `AbbrevCommitSha`: use the abbreviated git commit sha. + // `TreeSha`: use the full tree hash of the artifact workingdir. + // `AbbrevTreeSha`: use the abbreviated tree hash of the artifact workingdir. + Variant string `yaml:"variant,omitempty"` + + // Prefix adds a fixed prefix to the tag. + Prefix string `yaml:"prefix,omitempty"` + + // IgnoreChanges specifies whether to omit the `-dirty` postfix if there are uncommitted changes. + IgnoreChanges bool `yaml:"ignoreChanges,omitempty"` +} + +// EnvTemplateTagger *beta* tags images with a configurable template string. +type EnvTemplateTagger struct { + // Template used to produce the image name and tag. + // See golang [text/template](https://golang.org/pkg/text/template/). + // The template is executed against the current environment, + // with those variables injected. + // For example: `{{.RELEASE}}`. + Template string `yaml:"template,omitempty" yamltags:"required"` +} + +// DateTimeTagger *beta* tags images with the build timestamp. +type DateTimeTagger struct { + // Format formats the date and time. + // See [#Time.Format](https://golang.org/pkg/time/#Time.Format). + // Defaults to `2006-01-02_15-04-05.999_MST`. + Format string `yaml:"format,omitempty"` + + // TimeZone sets the timezone for the date and time. + // See [Time.LoadLocation](https://golang.org/pkg/time/#Time.LoadLocation). + // Defaults to the local timezone. + TimeZone string `yaml:"timezone,omitempty"` +} + +// CustomTemplateTagger *beta* tags images with a configurable template string. +type CustomTemplateTagger struct { + // Template used to produce the image name and tag. + // See golang [text/template](https://golang.org/pkg/text/template/). + // The template is executed against the provided components with those variables injected. + // For example: `{{.DATE}}` where DATE references a TaggerComponent. + Template string `yaml:"template,omitempty" yamltags:"required"` + + // Components lists TaggerComponents that the template (see field above) can be executed against. + Components []TaggerComponent `yaml:"components,omitempty"` +} + +// TaggerComponent *beta* is a component of CustomTemplateTagger. +type TaggerComponent struct { + // Name is an identifier for the component. + Name string `yaml:"name,omitempty"` + + // Component is a tagging strategy to be used in CustomTemplateTagger. + Component TagPolicy `yaml:",inline" yamltags:"skipTrim"` +} + +// BuildType contains the specific implementation and parameters needed +// for the build step. Only one field should be populated. +type BuildType struct { + // LocalBuild *beta* describes how to do a build on the local docker daemon + // and optionally push to a repository. + LocalBuild *LocalBuild `yaml:"local,omitempty" yamltags:"oneOf=build"` + + // GoogleCloudBuild *beta* describes how to do a remote build on + // [Google Cloud Build](https://cloud.google.com/cloud-build/). + GoogleCloudBuild *GoogleCloudBuild `yaml:"googleCloudBuild,omitempty" yamltags:"oneOf=build"` + + // Cluster *beta* describes how to do an on-cluster build. + Cluster *ClusterDetails `yaml:"cluster,omitempty" yamltags:"oneOf=build"` +} + +// LocalBuild *beta* describes how to do a build on the local docker daemon +// and optionally push to a repository. +type LocalBuild struct { + // Push should images be pushed to a registry. + // If not specified, images are pushed only if the current Kubernetes context + // connects to a remote cluster. + Push *bool `yaml:"push,omitempty"` + + // TryImportMissing whether to attempt to import artifacts from + // Docker (either a local or remote registry) if not in the cache. + TryImportMissing bool `yaml:"tryImportMissing,omitempty"` + + // UseDockerCLI use `docker` command-line interface instead of Docker Engine APIs. + UseDockerCLI bool `yaml:"useDockerCLI,omitempty"` + + // UseBuildkit use BuildKit to build Docker images. If unspecified, uses the Docker default. + UseBuildkit *bool `yaml:"useBuildkit,omitempty"` + + // Concurrency is how many artifacts can be built concurrently. 0 means "no-limit". + // Defaults to `1`. + Concurrency *int `yaml:"concurrency,omitempty"` +} + +// GoogleCloudBuild *beta* describes how to do a remote build on +// [Google Cloud Build](https://cloud.google.com/cloud-build/docs/). +// Docker and Jib artifacts can be built on Cloud Build. The `projectId` needs +// to be provided and the currently logged in user should be given permissions to trigger +// new builds. +type GoogleCloudBuild struct { + // ProjectID is the ID of your Cloud Platform Project. + // If it is not provided, Skaffold will guess it from the image name. + // For example, given the artifact image name `gcr.io/myproject/image`, Skaffold + // will use the `myproject` GCP project. + ProjectID string `yaml:"projectId,omitempty"` + + // DiskSizeGb is the disk size of the VM that runs the build. + // See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions). + DiskSizeGb int64 `yaml:"diskSizeGb,omitempty"` + + // MachineType is the type of the VM that runs the build. + // See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions). + MachineType string `yaml:"machineType,omitempty"` + + // Timeout is the amount of time (in seconds) that this build should be allowed to run. + // See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#resource-build). + Timeout string `yaml:"timeout,omitempty"` + + // Logging specifies the logging mode. + // Valid modes are: + // `LOGGING_UNSPECIFIED`: The service determines the logging mode. + // `LEGACY`: Stackdriver logging and Cloud Storage logging are enabled (default). + // `GCS_ONLY`: Only Cloud Storage logging is enabled. + // See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#loggingmode). + Logging string `yaml:"logging,omitempty"` + + // LogStreamingOption specifies the behavior when writing build logs to Google Cloud Storage. + // Valid options are: + // `STREAM_DEFAULT`: Service may automatically determine build log streaming behavior. + // `STREAM_ON`: Build logs should be streamed to Google Cloud Storage. + // `STREAM_OFF`: Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed. + // See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#logstreamingoption). + LogStreamingOption string `yaml:"logStreamingOption,omitempty"` + + // DockerImage is the image that runs a Docker build. + // See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders). + // Defaults to `gcr.io/cloud-builders/docker`. + DockerImage string `yaml:"dockerImage,omitempty"` + + // KanikoImage is the image that runs a Kaniko build. + // See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders). + // Defaults to `gcr.io/kaniko-project/executor`. + KanikoImage string `yaml:"kanikoImage,omitempty"` + + // MavenImage is the image that runs a Maven build. + // See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders). + // Defaults to `gcr.io/cloud-builders/mvn`. + MavenImage string `yaml:"mavenImage,omitempty"` + + // GradleImage is the image that runs a Gradle build. + // See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders). + // Defaults to `gcr.io/cloud-builders/gradle`. + GradleImage string `yaml:"gradleImage,omitempty"` + + // PackImage is the image that runs a Cloud Native Buildpacks build. + // See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders). + // Defaults to `gcr.io/k8s-skaffold/pack`. + PackImage string `yaml:"packImage,omitempty"` + + // KoImage is the image that runs a ko build. + // The image must contain Skaffold, Go, and a shell (runnable as `sh`) that supports here documents. + // See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders). + // Defaults to `gcr.io/k8s-skaffold/skaffold`. + KoImage string `yaml:"koImage,omitempty"` + + // Concurrency is how many artifacts can be built concurrently. 0 means "no-limit". + // Defaults to `0`. + Concurrency int `yaml:"concurrency,omitempty"` + + // WorkerPool configures a pool of workers to run the build. + WorkerPool string `yaml:"workerPool,omitempty"` + + // Region configures the region to run the build. If WorkerPool is configured, the region will + // be deduced from the WorkerPool configuration. If neither WorkerPool nor Region is configured, + // the build will be run in global(non-regional). + // See [Cloud Build locations](https://cloud.google.com/build/docs/locations). + Region string `yaml:"region,omitempty"` + + // PlatformEmulatorInstallStep specifies a pre-build step to install the required tooling for QEMU emulation on the GoogleCloudBuild containers. This enables performing cross-platform builds on GoogleCloudBuild. + // If unspecified, Skaffold uses the `docker/binfmt` image by default. + PlatformEmulatorInstallStep *PlatformEmulatorInstallStep `yaml:"platformEmulatorInstallStep,omitempty"` + + // ServiceAccount is the Google Cloud platform service account used by Cloud Build. + // If unspecified, it defaults to the Cloud Build service account generated when + // the Cloud Build API is enabled. + ServiceAccount string `yaml:"serviceAccount,omitempty"` +} + +// PlatformEmulatorInstallStep specifies a pre-build step to install the required tooling for QEMU emulation on the GoogleCloudBuild containers. This enables performing cross-platform builds on GoogleCloudBuild. +type PlatformEmulatorInstallStep struct { + // Image specifies the image that will install the required tooling for QEMU emulation on the GoogleCloudBuild containers. + Image string `yaml:"image" yamltags:"required"` + // Args specifies arguments passed to the emulator installer image. + Args []string `yaml:"args,omitempty"` + // Entrypoint specifies the ENTRYPOINT argument to the emulator installer image. + Entrypoint string `yaml:"entrypoint,omitempty"` +} + +// KanikoCache configures Kaniko caching. If a cache is specified, Kaniko will +// use a remote cache which will speed up builds. +type KanikoCache struct { + // Repo is a remote repository to store cached layers. If none is specified, one will be + // inferred from the image name. See [Kaniko Caching](https://github.com/GoogleContainerTools/kaniko#caching). + Repo string `yaml:"repo,omitempty"` + // HostPath specifies a path on the host that is mounted to each pod as read only cache volume containing base images. + // If set, must exist on each node and prepopulated with kaniko-warmer. + HostPath string `yaml:"hostPath,omitempty"` + // TTL Cache timeout in hours. + TTL string `yaml:"ttl,omitempty"` + // CacheCopyLayers enables caching of copy layers. + CacheCopyLayers bool `yaml:"cacheCopyLayers,omitempty"` +} + +// ClusterDetails *beta* describes how to do an on-cluster build. +type ClusterDetails struct { + // HTTPProxy for kaniko pod. + HTTPProxy string `yaml:"HTTP_PROXY,omitempty"` + + // HTTPSProxy for kaniko pod. + HTTPSProxy string `yaml:"HTTPS_PROXY,omitempty"` + + // PullSecretPath is the path to the Google Cloud service account secret key file. + PullSecretPath string `yaml:"pullSecretPath,omitempty"` + + // PullSecretName is the name of the Kubernetes secret for pulling base images + // and pushing the final image. If given, the secret needs to contain the Google Cloud + // service account secret key under the key `kaniko-secret`. + // Defaults to `kaniko-secret`. + PullSecretName string `yaml:"pullSecretName,omitempty"` + + // PullSecretMountPath is the path the pull secret will be mounted at within the running container. + PullSecretMountPath string `yaml:"pullSecretMountPath,omitempty"` + + // Namespace is the Kubernetes namespace. + // Defaults to current namespace in Kubernetes configuration. + Namespace string `yaml:"namespace,omitempty"` + + // Timeout is the amount of time (in seconds) that this build is allowed to run. + // Defaults to 20 minutes (`20m`). + Timeout string `yaml:"timeout,omitempty"` + + // DockerConfig describes how to mount the local Docker configuration into a pod. + DockerConfig *DockerConfig `yaml:"dockerConfig,omitempty"` + + // ServiceAccountName describes the Kubernetes service account to use for the pod. + // Defaults to 'default'. + ServiceAccountName string `yaml:"serviceAccount,omitempty"` + + // Tolerations describes the Kubernetes tolerations for the pod. + Tolerations []v1.Toleration `yaml:"tolerations,omitempty"` + + // NodeSelector describes the Kubernetes node selector for the pod. + NodeSelector map[string]string `yaml:"nodeSelector,omitempty"` + + // Annotations describes the Kubernetes annotations for the pod. + Annotations map[string]string `yaml:"annotations,omitempty"` + + // RunAsUser defines the UID to request for running the container. + // If omitted, no SecurityContext will be specified for the pod and will therefore be inherited + // from the service account. + RunAsUser *int64 `yaml:"runAsUser,omitempty"` + + // Resources define the resource requirements for the kaniko pod. + Resources *ResourceRequirements `yaml:"resources,omitempty"` + + // Concurrency is how many artifacts can be built concurrently. 0 means "no-limit". + // Defaults to `0`. + Concurrency int `yaml:"concurrency,omitempty"` + + // Volumes defines container mounts for ConfigMap and Secret resources. + Volumes []v1.Volume `yaml:"volumes,omitempty"` + + // RandomPullSecret adds a random UUID postfix to the default name of the pull secret to facilitate parallel builds, e.g. kaniko-secretdocker-cfgfd154022-c761-416f-8eb3-cf8258450b85. + RandomPullSecret bool `yaml:"randomPullSecret,omitempty"` + + // RandomDockerConfigSecret adds a random UUID postfix to the default name of the docker secret to facilitate parallel builds, e.g. docker-cfgfd154022-c761-416f-8eb3-cf8258450b85. + RandomDockerConfigSecret bool `yaml:"randomDockerConfigSecret,omitempty"` +} + +// DockerConfig contains information about the docker `config.json` to mount. +type DockerConfig struct { + // Path is the path to the docker `config.json`. + Path string `yaml:"path,omitempty"` + + // SecretName is the Kubernetes secret that contains the `config.json` Docker configuration. + // Note that the expected secret type is not 'kubernetes.io/dockerconfigjson' but 'Opaque'. + SecretName string `yaml:"secretName,omitempty"` +} + +// ResourceRequirements describes the resource requirements for the kaniko pod. +type ResourceRequirements struct { + // Requests [resource requests](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod. + Requests *ResourceRequirement `yaml:"requests,omitempty"` + + // Limits [resource limits](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod. + Limits *ResourceRequirement `yaml:"limits,omitempty"` +} + +// ResourceRequirement stores the CPU/Memory requirements for the pod. +type ResourceRequirement struct { + // CPU the number cores to be used. + // For example: `2`, `2.0` or `200m`. + CPU string `yaml:"cpu,omitempty"` + + // Memory the amount of memory to allocate to the pod. + // For example: `1Gi` or `1000Mi`. + Memory string `yaml:"memory,omitempty"` + + // EphemeralStorage the amount of Ephemeral storage to allocate to the pod. + // For example: `1Gi` or `1000Mi`. + EphemeralStorage string `yaml:"ephemeralStorage,omitempty"` + + // ResourceStorage the amount of resource storage to allocate to the pod. + // For example: `1Gi` or `1000Mi`. + ResourceStorage string `yaml:"resourceStorage,omitempty"` +} + +// TestCase is a list of tests to run on images that Skaffold builds. +type TestCase struct { + // ImageName is the artifact on which to run those tests. + // For example: `gcr.io/k8s-skaffold/example`. + ImageName string `yaml:"image" yamltags:"required"` + + // Workspace is the directory containing the test sources. + // Defaults to `.`. + Workspace string `yaml:"context,omitempty" skaffold:"filepath"` + + // CustomTests lists the set of custom tests to run after an artifact is built. + CustomTests []CustomTest `yaml:"custom,omitempty"` + + // StructureTests lists the [Container Structure Tests](https://github.com/GoogleContainerTools/container-structure-test) + // to run on that artifact. + // For example: `["./test/*"]`. + StructureTests []string `yaml:"structureTests,omitempty" skaffold:"filepath"` + + // StructureTestArgs lists additional configuration arguments passed to `container-structure-test` binary. + // For example: `["--driver=tar", "--no-color", "-q"]`. + StructureTestArgs []string `yaml:"structureTestsArgs,omitempty"` +} + +// VerifyExecutionModeConfig contains all the configuration needed by the verify execution modes. +type VerifyExecutionModeConfig struct { + VerifyExecutionModeType `yaml:",inline"` +} + +// VerifyExecutionModeType contains the specific implementation and parameters for how the +// verify test case will be executed. +type VerifyExecutionModeType struct { + // LocalExecutionMode uses the `docker` CLI to create verify test case containers on the host machine in Docker. + LocalExecutionMode *LocalVerifier `yaml:"local,omitempty"` + + // KubernetesClusterExecutionMode uses the `kubectl` CLI to create veriy test case + // container in a kubernetes cluster. + KubernetesClusterExecutionMode *KubernetesClusterVerifier `yaml:"kubernetesCluster,omitempty"` +} + +// LocalVerifier uses the `docker` CLI to create verify test case containers on the host machine in Docker. +type LocalVerifier struct { + // LocalVerifyTestCases is a list of verify test cases to run locally. + // LocalVerifyTestCases []*LocalVerifyTestCase `yaml:"testCases,omitempty"` + +} + +// KubernetesClusterVerifier uses the `kubectl` CLI to create veriy test case +// container in a kubernetes cluster. +type KubernetesClusterVerifier struct { + // // Flags are additional flags passed to `kubectl`. + // Flags KubectlFlags `yaml:"flags,omitempty"` + + // // DefaultNamespace is the default namespace passed to kubectl on deployment if no other override is given. + // DefaultNamespace *string `yaml:"defaultNamespace,omitempty"` + + // Overrides is the inline JSON override to use for the generated kubernetes Job. + // If this is non-empty, it is used to override the generated object. Similar to + // the `--overrides` kubectl flag. + Overrides string `yaml:"overrides,omitempty"` + // JobManifestPath is the path to the kubernetes Job manifest to use for the verify test + // This manifest will be deployed into the cluster with the Container information replaced + // by the information in the Container field. + JobManifestPath string `yaml:"jobManifestPath,omitempty"` +} + +// VerifyTestCase is a list of tests to run on images that Skaffold builds. +type VerifyTestCase struct { + // Name is the name descriptor for the verify test. + Name string `yaml:"name" yamltags:"required"` + // Container is the container information for the verify test. + Container v1.Container `yaml:"container" yamltags:"required"` + // ExecutionMode is the execution mode used to execute the verify test case. + ExecutionMode VerifyExecutionModeConfig `yaml:"executionMode,omitempty"` +} + +// RenderConfig contains all the configuration needed by the render steps. +type RenderConfig struct { + + // Generate defines the dry manifests from a variety of sources. + Generate `yaml:",inline"` + + // Transform defines a set of transformation operations to run in series. + Transform *[]Transformer `yaml:"transform,omitempty"` + + // Validate defines a set of validator operations to run in series. + Validate *[]Validator `yaml:"validate,omitempty"` + + // Output is the path to the hydrated directory. + Output string `yaml:"output,omitempty"` +} + +// Generate defines the dry manifests from a variety of sources. +type Generate struct { + // RawK8s defines the raw kubernetes resources. + RawK8s []string `yaml:"rawYaml,omitempty" skaffold:"filepath"` + + // RemoteManifests lists Kubernetes manifests in remote clusters. + RemoteManifests []RemoteManifest `yaml:"remoteManifests,omitempty"` + + // Kustomize defines the paths to be modified with kustomize, along with extra + // flags to be passed to kustomize. + Kustomize *Kustomize `yaml:"kustomize,omitempty"` + + // Helm defines the helm charts used in the application. + // NOTE: Defines cherts in this section to render via helm but + // deployed via kubectl or kpt deployer. + // To use helm to deploy, please see deploy.helm section. + Helm *Helm `yaml:"helm,omitempty"` + + // Kpt defines the kpt resources in the application. + Kpt []string `yaml:"kpt,omitempty" skaffold:"filepath"` + + // LifecycleHooks describes a set of lifecycle hooks that are executed before and after every render. + LifecycleHooks RenderHooks `yaml:"hooks,omitempty"` +} + +// RemoteManifest defines the paths to be modified with kustomize, along with +// extra flags to be passed to kustomize. +type RemoteManifest struct { + // Manifest specifies the Kubernetes manifest in the remote cluster. + Manifest string `yaml:"manifest,omitempty"` + + // KubeContext is the Kubernetes context that Skaffold should deploy to. + // For example: `minikube`. + KubeContext string `yaml:"kubeContext,omitempty"` +} + +// Kustomize defines the paths to be modified with kustomize, along with +// extra flags to be passed to kustomize. +type Kustomize struct { + // Paths is the path to Kustomization files. + // Defaults to `["."]`. + Paths []string `yaml:"paths,omitempty" skaffold:"filepath"` + + // BuildArgs are additional args passed to `kustomize build`. + BuildArgs []string `yaml:"buildArgs,omitempty"` +} + +// Helm defines the manifests from helm releases. +type Helm struct { + // Flags are additional option flags that are passed on the command + // line to `helm`. + Flags HelmDeployFlags `yaml:"flags,omitempty"` + + // Releases is a list of Helm releases. + Releases []HelmRelease `yaml:"releases,omitempty" yamltags:"required"` +} + +// Transformer describes the supported kpt transformers. +type Transformer struct { + // Name is the transformer name. Can only accept skaffold whitelisted tools. + Name string `yaml:"name" yamltags:"required"` + // ConfigMap allows users to provide additional config data to the kpt function. + ConfigMap []string `yaml:"configMap,omitempty"` +} + +// Validator describes the supported kpt validators. +type Validator struct { + // Name is the Validator name. Can only accept skaffold whitelisted tools. + Name string `yaml:"name" yamltags:"required"` + // ConfigMap allows users to provide additional config data to the kpt function. + ConfigMap []string `yaml:"configMap,omitempty"` +} + +// KptDeploy contains all the configuration needed by the deploy steps. +type KptDeploy struct { + // Dir is equivalent to the dir in `kpt live apply `. If not provided, skaffold deploys from the default + // hydrated path `/.kpt-pipeline`. + Dir string `yaml:"dir,omitempty"` + + // ApplyFlags are additional flags passed to `kpt live apply`. + ApplyFlags []string `yaml:"applyFlags,omitempty"` + + // Flags are kpt global flags. + Flags []string `yaml:"flags,omitempty"` + + // Name *alpha* is the inventory object name. + Name string `yaml:"name,omitempty"` + + // InventoryID *alpha* is the inventory ID which annotates the resources being lively applied by kpt. + InventoryID string `yaml:"inventoryID,omitempty"` + + // InventoryNamespace *alpha* sets the inventory namespace. + InventoryNamespace string `yaml:"namespace,omitempty"` + + // Force is used in `kpt live init`, which forces the inventory values to be updated, even if they are already set. + Force bool `yaml:"false,omitempty"` + + // LifecycleHooks describes a set of lifecycle hooks that are executed before and after every deploy. + LifecycleHooks DeployHooks `yaml:"-"` + + // DefaultNamespace is the default namespace passed to kpt on deployment if no other override is given. + DefaultNamespace *string `yaml:"defaultNamespace,omitempty"` +} + +// DeployConfig contains all the configuration needed by the deploy steps. +type DeployConfig struct { + DeployType `yaml:",inline"` + + // StatusCheck *beta* enables waiting for deployments to stabilize. + StatusCheck *bool `yaml:"statusCheck,omitempty"` + + // StatusCheckDeadlineSeconds *beta* is the deadline for deployments to stabilize in seconds. + StatusCheckDeadlineSeconds int `yaml:"statusCheckDeadlineSeconds,omitempty"` + + // TolerateFailuresUntilDeadline configures the Skaffold "status-check" to tolerate failures + // (flapping deployments, etc.) until the statusCheckDeadlineSeconds duration or k8s object + // timeouts such as progressDeadlineSeconds, etc. + TolerateFailuresUntilDeadline bool `yaml:"tolerateFailuresUntilDeadline,omitempty"` + + // KubeContext is the Kubernetes context that Skaffold should deploy to. + // For example: `minikube`. + KubeContext string `yaml:"kubeContext,omitempty"` + + // Logs configures how container logs are printed as a result of a deployment. + Logs LogsConfig `yaml:"logs,omitempty"` + + // TransformableAllowList configures an allowlist for transforming manifests. + TransformableAllowList []ResourceFilter `yaml:"-"` +} + +// DeployType contains the specific implementation and parameters needed +// for the deploy step. All three deployer types can be used at the same +// time for hybrid workflows. +type DeployType struct { + // DockerDeploy *alpha* uses the `docker` CLI to create application containers in Docker. + DockerDeploy *DockerDeploy `yaml:"docker,omitempty"` + + // LegacyHelmDeploy *beta* uses the `helm` CLI to apply the charts to the cluster. + LegacyHelmDeploy *LegacyHelmDeploy `yaml:"helm,omitempty"` + + // KptDeploy *alpha* uses the `kpt` CLI to manage and deploy manifests. + KptDeploy *KptDeploy `yaml:"kpt,omitempty"` + + // KubectlDeploy *beta* uses a client side `kubectl apply` to deploy manifests. + // You'll need a `kubectl` CLI version installed that's compatible with your cluster. + KubectlDeploy *KubectlDeploy `yaml:"kubectl,omitempty"` + + // CloudRunDeploy *alpha* deploys to Google Cloud Run using the Cloud Run v1 API. + CloudRunDeploy *CloudRunDeploy `yaml:"cloudrun,omitempty"` +} + +// CloudRunDeploy *alpha* deploys the container to Google Cloud Run. +type CloudRunDeploy struct { + // ProjectID the GCP Project to use for Cloud Run. + // If specified, all Services will be deployed to this project. If not specified, + // each Service will be deployed to the project specified in `metadata.namespace` of + // the Cloud Run manifest. + ProjectID string `yaml:"projectid,omitempty"` + + // Region GCP location to use for the Cloud Run Deploy. + // Must be one of the regions listed in https://cloud.google.com/run/docs/locations. + Region string `yaml:"region,omitempty"` + + // LifecycleHooks describes a set of lifecycle host hooks that are executed before and after the Cloud Run deployer. + LifecycleHooks CloudRunDeployHooks `yaml:"hooks,omitempty"` +} + +// DockerDeploy uses the `docker` CLI to create application containers in Docker. +type DockerDeploy struct { + // UseCompose tells skaffold whether or not to deploy using `docker-compose`. + UseCompose bool `yaml:"useCompose,omitempty"` + + // Images are the container images to run in Docker. + Images []string `yaml:"images" yamltags:"required"` +} + +// KubectlDeploy *beta* uses a client side `kubectl apply` to deploy manifests. +// You'll need a `kubectl` CLI version installed that's compatible with your cluster. +type KubectlDeploy struct { + // Flags are additional flags passed to `kubectl`. + Flags KubectlFlags `yaml:"flags,omitempty"` + + // RemoteManifests lists Kubernetes manifests in remote clusters. + RemoteManifests []string `yaml:"remoteManifests,omitempty"` + + // DefaultNamespace is the default namespace passed to kubectl on deployment if no other override is given. + DefaultNamespace *string `yaml:"defaultNamespace,omitempty"` + + // LifecycleHooks describes a set of lifecycle hooks that are executed before and after every deploy. + LifecycleHooks DeployHooks `yaml:"hooks,omitempty"` +} + +// KubectlFlags are additional flags passed on the command +// line to kubectl either on every command (Global), on creations (Apply) +// or deletions (Delete). +type KubectlFlags struct { + // Global are additional flags passed on every command. + Global []string `yaml:"global,omitempty"` + + // Apply are additional flags passed on creations (`kubectl apply`). + Apply []string `yaml:"apply,omitempty"` + + // Delete are additional flags passed on deletions (`kubectl delete`). + Delete []string `yaml:"delete,omitempty"` + + // DisableValidation passes the `--validate=false` flag to supported + // `kubectl` commands when enabled. + DisableValidation bool `yaml:"disableValidation,omitempty"` +} + +// LegacyHelmDeploy *beta* uses the `helm` CLI to apply the charts to the cluster. +type LegacyHelmDeploy struct { + // Releases is a list of Helm releases. + Releases []HelmRelease `yaml:"releases,omitempty"` + + // Flags are additional option flags that are passed on the command + // line to `helm`. + Flags HelmDeployFlags `yaml:"flags,omitempty"` + + // LifecycleHooks describes a set of lifecycle hooks that are executed before and after every deploy. + LifecycleHooks DeployHooks `yaml:"hooks,omitempty"` +} + +// HelmDeployFlags are additional option flags that are passed on the command +// line to `helm`. +type HelmDeployFlags struct { + // Global are additional flags passed on every command. + Global []string `yaml:"global,omitempty"` + + // Install are additional flags passed to (`helm install`). + Install []string `yaml:"install,omitempty"` + + // Upgrade are additional flags passed to (`helm upgrade`). + Upgrade []string `yaml:"upgrade,omitempty"` +} + +// HelmRelease describes a helm release to be deployed. +type HelmRelease struct { + // Name is the name of the Helm release. + // It accepts environment variables via the go template syntax. + Name string `yaml:"name,omitempty" yamltags:"required"` + + // ChartPath is the local path to a packaged Helm chart or an unpacked Helm chart directory. + ChartPath string `yaml:"chartPath,omitempty" yamltags:"oneOf=chartSource" skaffold:"filepath"` + + // RemoteChart refers to a remote Helm chart reference or URL. + RemoteChart string `yaml:"remoteChart,omitempty" yamltags:"oneOf=chartSource"` + + // ValuesFiles are the paths to the Helm `values` files. + ValuesFiles []string `yaml:"valuesFiles,omitempty" skaffold:"filepath"` + + // Namespace is the Kubernetes namespace. + Namespace string `yaml:"namespace,omitempty"` + + // Version is the version of the chart. + Version string `yaml:"version,omitempty"` + + // SetValues are key-value pairs. + // If present, Skaffold will send `--set` flag to Helm CLI and append all pairs after the flag. + SetValues util.FlatMap `yaml:"setValues,omitempty"` + + // SetValueTemplates are key-value pairs. + // If present, Skaffold will try to parse the value part of each key-value pair using + // environment variables in the system, then send `--set` flag to Helm CLI and append + // all parsed pairs after the flag. + SetValueTemplates util.FlatMap `yaml:"setValueTemplates,omitempty"` + + // SetFiles are key-value pairs. + // If present, Skaffold will send `--set-file` flag to Helm CLI and append all pairs after the flag. + SetFiles map[string]string `yaml:"setFiles,omitempty" skaffold:"filepath"` + + // CreateNamespace if `true`, Skaffold will send `--create-namespace` flag to Helm CLI. + // `--create-namespace` flag is available in Helm since version 3.2. + // Defaults is `false`. + CreateNamespace *bool `yaml:"createNamespace,omitempty"` + + // Wait if `true`, Skaffold will send `--wait` flag to Helm CLI. + // Defaults to `false`. + Wait bool `yaml:"wait,omitempty"` + + // RecreatePods if `true`, Skaffold will send `--recreate-pods` flag to Helm CLI + // when upgrading a new version of a chart in subsequent dev loop deploy. + // Defaults to `false`. + RecreatePods bool `yaml:"recreatePods,omitempty"` + + // SkipBuildDependencies should build dependencies be skipped. + // Ignored for `remoteChart`. + SkipBuildDependencies bool `yaml:"skipBuildDependencies,omitempty"` + + // SkipTests should ignore helm test during manifests generation. + // Defaults to `false` + SkipTests bool `yaml:"skipTests,omitempty"` + + // UseHelmSecrets instructs skaffold to use secrets plugin on deployment. + UseHelmSecrets bool `yaml:"useHelmSecrets,omitempty"` + + // Repo specifies the helm repository for remote charts. + // If present, Skaffold will send `--repo` Helm CLI flag or flags. + Repo string `yaml:"repo,omitempty"` + + // UpgradeOnChange specifies whether to upgrade helm chart on code changes. + // Default is `true` when helm chart is local (has `chartPath`). + // Default is `false` when helm chart is remote (has `remoteChart`). + UpgradeOnChange *bool `yaml:"upgradeOnChange,omitempty"` + + // Overrides are key-value pairs. + // If present, Skaffold will build a Helm `values` file that overrides + // the original and use it to call Helm CLI (`--f` flag). + Overrides util.HelmOverrides `yaml:"overrides,omitempty"` + + // Packaged parameters for packaging helm chart (`helm package`). + Packaged *HelmPackaged `yaml:"packaged,omitempty"` +} + +// HelmPackaged parameters for packaging helm chart (`helm package`). +type HelmPackaged struct { + // Version sets the `version` on the chart to this semver version. + Version string `yaml:"version,omitempty"` + + // AppVersion sets the `appVersion` on the chart to this version. + AppVersion string `yaml:"appVersion,omitempty"` +} + +// LogsConfig configures how container logs are printed as a result of a deployment. +type LogsConfig struct { + // Prefix defines the prefix shown on each log line. Valid values are + // `container`: prefix logs lines with the name of the container. + // `podAndContainer`: prefix logs lines with the names of the pod and of the container. + // `auto`: same as `podAndContainer` except that the pod name is skipped if it's the same as the container name. + // `none`: don't add a prefix. + // Defaults to `auto`. + Prefix string `yaml:"prefix,omitempty"` + + // JSONParse defines the rules for parsing/outputting json logs. + JSONParse JSONParseConfig `yaml:"jsonParse,omitempty"` +} + +// JSONParseConfig defines the rules for parsing/outputting json logs. +type JSONParseConfig struct { + // Fields specifies which top level fields should be printed. + Fields []string `yaml:"fields,omitempty"` +} + +// Artifact are the items that need to be built, along with the context in which +// they should be built. +type Artifact struct { + // ImageName is the name of the image to be built. + // For example: `gcr.io/k8s-skaffold/example`. + ImageName string `yaml:"image,omitempty" yamltags:"required"` + + // Workspace is the directory containing the artifact's sources. + // Defaults to `.`. + Workspace string `yaml:"context,omitempty" skaffold:"filepath"` + + // Sync *beta* lists local files synced to pods instead + // of triggering an image build when modified. + // If no files are listed, sync all the files and infer the destination. + // Defaults to `infer: ["**/*"]`. + Sync *Sync `yaml:"sync,omitempty"` + + // ArtifactType describes how to build an artifact. + ArtifactType `yaml:",inline"` + + // Dependencies describes build artifacts that this artifact depends on. + Dependencies []*ArtifactDependency `yaml:"requires,omitempty"` + + // LifecycleHooks describes a set of lifecycle hooks that are executed before and after each build of the target artifact. + LifecycleHooks BuildHooks `yaml:"hooks,omitempty"` + + // Platforms is the list of platforms to build this artifact image for. + // It overrides the values inferred through heuristics or provided in the top level `platforms` property or in the global config. + // If the target builder cannot build for atleast one of the specified platforms, then the build fails. + // Each platform is of the format `os[/arch[/variant]]`, e.g., `linux/amd64`. + // Example: `["linux/amd64", "linux/arm64"]`. + Platforms []string `yaml:"platforms,omitempty"` + + // RuntimeType specifies the target language runtime for this artifact that is used to configure debug support. Should be one of `go`, `nodejs`, `jvm`, `python` or `netcore`. If unspecified the language runtime is inferred from common heuristics for the list of supported runtimes. + RuntimeType string `yaml:"runtimeType,omitempty"` +} + +// Sync *beta* specifies what files to sync into the container. +// This is a list of sync rules indicating the intent to sync for source files. +// If no files are listed, sync all the files and infer the destination. +// Defaults to `infer: ["**/*"]`. +type Sync struct { + // Manual lists manual sync rules indicating the source and destination. + Manual []*SyncRule `yaml:"manual,omitempty" yamltags:"oneOf=sync"` + + // Infer lists file patterns which may be synced into the container + // The container destination is inferred by the builder + // based on the instructions of a Dockerfile. + // Available for docker and kaniko artifacts and custom + // artifacts that declare dependencies on a dockerfile. + Infer []string `yaml:"infer,omitempty" yamltags:"oneOf=sync"` + + // Auto delegates discovery of sync rules to the build system. + // Only available for jib and buildpacks. + Auto *bool `yaml:"auto,omitempty" yamltags:"oneOf=sync"` + + // LifecycleHooks describes a set of lifecycle hooks that are executed before and after each file sync action on the target artifact's containers. + LifecycleHooks SyncHooks `yaml:"hooks,omitempty"` +} + +// SyncRule specifies which local files to sync to remote folders. +type SyncRule struct { + // Src is a glob pattern to match local paths against. + // Directories should be delimited by `/` on all platforms. + // For example: `"css/**/*.css"`. + Src string `yaml:"src,omitempty" yamltags:"required"` + + // Dest is the destination path in the container where the files should be synced to. + // For example: `"app/"` + Dest string `yaml:"dest,omitempty" yamltags:"required"` + + // Strip specifies the path prefix to remove from the source path when + // transplanting the files into the destination folder. + // For example: `"css/"` + Strip string `yaml:"strip,omitempty"` +} + +// Profile is used to override any `build`, `test` or `deploy` configuration. +type Profile struct { + // Name is a unique profile name. + // For example: `profile-prod`. + Name string `yaml:"name,omitempty" yamltags:"required"` + + // Activation criteria by which a profile can be auto-activated. + // The profile is auto-activated if any one of the activations are triggered. + // An activation is triggered if all of the criteria (env, kubeContext, command) are triggered. + Activation []Activation `yaml:"activation,omitempty"` + + // RequiresAllActivations is the activation strategy of the profile. + // When true, the profile is auto-activated only when all of its activations are triggered. + // When false, the profile is auto-activated when any one of its activations is triggered. + RequiresAllActivations bool `yaml:"requiresAllActivations,omitempty"` + + // Patches lists patches applied to the configuration. + // Patches use the JSON patch notation. + Patches []JSONPatch `yaml:"patches,omitempty"` + + // Pipeline contains the definitions to replace the default skaffold pipeline. + Pipeline `yaml:",inline"` +} + +// JSONPatch patch to be applied by a profile. +type JSONPatch struct { + // Op is the operation carried by the patch: `add`, `remove`, `replace`, `move`, `copy` or `test`. + // Defaults to `replace`. + Op string `yaml:"op,omitempty"` + + // Path is the position in the yaml where the operation takes place. + // For example, this targets the `dockerfile` of the first artifact built. + // For example: `/build/artifacts/0/docker/dockerfile`. + Path string `yaml:"path,omitempty" yamltags:"required"` + + // From is the source position in the yaml, used for `copy` or `move` operations. + From string `yaml:"from,omitempty"` + + // Value is the value to apply. Can be any portion of yaml. + Value *util.YamlpatchNode `yaml:"value,omitempty"` +} + +// Activation criteria by which a profile is auto-activated. +type Activation struct { + // Env is a `key=pattern` pair. The profile is auto-activated if an Environment + // Variable `key` matches the pattern. If the pattern starts with `!`, activation + // happens if the remaining pattern is _not_ matched. The pattern matches if the + // Environment Variable value is exactly `pattern`, or the regex `pattern` is + // found in it. An empty `pattern` (e.g. `env: "key="`) always only matches if + // the Environment Variable is undefined or empty. + // For example: `ENV=production` + Env string `yaml:"env,omitempty"` + + // KubeContext is a Kubernetes context for which the profile is auto-activated. + // For example: `minikube`. + KubeContext string `yaml:"kubeContext,omitempty"` + + // Command is a Skaffold command for which the profile is auto-activated. + // For example: `dev`. + Command string `yaml:"command,omitempty"` +} + +// ArtifactType describes how to build an artifact. +type ArtifactType struct { + // DockerArtifact *beta* describes an artifact built from a Dockerfile. + DockerArtifact *DockerArtifact `yaml:"docker,omitempty" yamltags:"oneOf=artifact"` + + // BazelArtifact *beta* requires bazel CLI to be installed and the sources to + // contain [Bazel](https://bazel.build/) configuration files. + BazelArtifact *BazelArtifact `yaml:"bazel,omitempty" yamltags:"oneOf=artifact"` + + // KoArtifact builds images using [ko](https://github.com/google/ko). + KoArtifact *KoArtifact `yaml:"ko,omitempty" yamltags:"oneOf=artifact"` + + // JibArtifact builds images using the + // [Jib plugins for Maven or Gradle](https://github.com/GoogleContainerTools/jib/). + JibArtifact *JibArtifact `yaml:"jib,omitempty" yamltags:"oneOf=artifact"` + + // KanikoArtifact builds images using [kaniko](https://github.com/GoogleContainerTools/kaniko). + KanikoArtifact *KanikoArtifact `yaml:"kaniko,omitempty" yamltags:"oneOf=artifact"` + + // BuildpackArtifact builds images using [Cloud Native Buildpacks](https://buildpacks.io/). + BuildpackArtifact *BuildpackArtifact `yaml:"buildpacks,omitempty" yamltags:"oneOf=artifact"` + + // CustomArtifact *beta* builds images using a custom build script written by the user. + CustomArtifact *CustomArtifact `yaml:"custom,omitempty" yamltags:"oneOf=artifact"` +} + +// ArtifactDependency describes a specific build dependency for an artifact. +type ArtifactDependency struct { + // ImageName is a reference to an artifact's image name. + ImageName string `yaml:"image" yamltags:"required"` + // Alias is a token that is replaced with the image reference in the builder definition files. + // For example, the `docker` builder will use the alias as a build-arg key. + // Defaults to the value of `image`. + Alias string `yaml:"alias,omitempty"` +} + +// BuildpackArtifact *alpha* describes an artifact built using [Cloud Native Buildpacks](https://buildpacks.io/). +// It can be used to build images out of project's sources without any additional configuration. +type BuildpackArtifact struct { + // Builder is the builder image used. + Builder string `yaml:"builder,omitempty"` + + // RunImage overrides the stack's default run image. + RunImage string `yaml:"runImage,omitempty"` + + // Env are environment variables, in the `key=value` form, passed to the build. + // Values can use the go template syntax. + // For example: `["key1=value1", "key2=value2", "key3={{.ENV_VARIABLE}}"]`. + Env []string `yaml:"env,omitempty"` + + // Buildpacks is a list of strings, where each string is a specific buildpack to use with the builder. + // If you specify buildpacks the builder image automatic detection will be ignored. These buildpacks will be used to build the Image from your source code. + // Order matters. + Buildpacks []string `yaml:"buildpacks,omitempty"` + + // TrustBuilder indicates that the builder should be trusted. + TrustBuilder bool `yaml:"trustBuilder,omitempty"` + + // ClearCache removes old cache volume associated with the specific image + // and supplies a clean cache volume for build. + ClearCache bool `yaml:"clearCache,omitempty"` + + // ProjectDescriptor is the path to the project descriptor file. + // Defaults to `project.toml` if it exists. + ProjectDescriptor string `yaml:"projectDescriptor,omitempty"` + + // Dependencies are the file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact. + Dependencies *BuildpackDependencies `yaml:"dependencies,omitempty"` + + // Volumes support mounting host volumes into the container. + Volumes []*BuildpackVolume `yaml:"volumes,omitempty"` +} + +// BuildpackDependencies *alpha* is used to specify dependencies for an artifact built by buildpacks. +type BuildpackDependencies struct { + // Paths should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization. + Paths []string `yaml:"paths,omitempty" yamltags:"oneOf=dependency"` + + // Ignore specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both `paths` and in `ignore`, it will be ignored, and will be excluded from both rebuilds and file synchronization. + // Will only work in conjunction with `paths`. + Ignore []string `yaml:"ignore,omitempty"` +} + +// BuildpackVolume *alpha* is used to mount host volumes or directories in the build container. +type BuildpackVolume struct { + // Host is the local volume or absolute directory of the path to mount. + Host string `yaml:"host" skaffold:"filepath" yamltags:"required"` + + // Target is the path where the file or directory is available in the container. + // It is strongly recommended to not specify locations under `/cnb` or `/layers`. + Target string `yaml:"target" yamltags:"required"` + + // Options specify a list of comma-separated mount options. + // Valid options are: + // `ro` (default): volume contents are read-only. + // `rw`: volume contents are readable and writable. + // `volume-opt==`: can be specified more than once, takes a key-value pair. + Options string `yaml:"options,omitempty"` +} + +// CustomArtifact *beta* describes an artifact built from a custom build script +// written by the user. It can be used to build images with builders that aren't directly integrated with skaffold. +type CustomArtifact struct { + // BuildCommand is the command executed to build the image. + BuildCommand string `yaml:"buildCommand,omitempty"` + // Dependencies are the file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact. + Dependencies *CustomDependencies `yaml:"dependencies,omitempty"` +} + +// CustomDependencies *beta* is used to specify dependencies for an artifact built by a custom build script. +// Either `dockerfile` or `paths` should be specified for file watching to work as expected. +type CustomDependencies struct { + // Dockerfile should be set if the artifact is built from a Dockerfile, from which skaffold can determine dependencies. + Dockerfile *DockerfileDependency `yaml:"dockerfile,omitempty" yamltags:"oneOf=dependency"` + + // Command represents a custom command that skaffold executes to obtain dependencies. The output of this command *must* be a valid JSON array. + Command string `yaml:"command,omitempty" yamltags:"oneOf=dependency"` + + // Paths should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization. + Paths []string `yaml:"paths,omitempty" yamltags:"oneOf=dependency"` + + // Ignore specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both `paths` and in `ignore`, it will be ignored, and will be excluded from both rebuilds and file synchronization. + // Will only work in conjunction with `paths`. + Ignore []string `yaml:"ignore,omitempty"` +} + +// CustomTest describes the custom test command provided by the user. +// Custom tests are run after an image build whenever build or test dependencies are changed. +type CustomTest struct { + // Command is the custom command to be executed. If the command exits with a non-zero return + // code, the test will be considered to have failed. + Command string `yaml:"command" yamltags:"required"` + + // TimeoutSeconds sets the wait time for skaffold for the command to complete. + // If unset or 0, Skaffold will wait until the command completes. + TimeoutSeconds int `yaml:"timeoutSeconds,omitempty"` + + // Dependencies are additional test-specific file dependencies; changes to these files will re-run this test. + Dependencies *CustomTestDependencies `yaml:"dependencies,omitempty"` +} + +// CustomTestDependencies is used to specify dependencies for custom test command. +// `paths` should be specified for file watching to work as expected. +type CustomTestDependencies struct { + // Command represents a command that skaffold executes to obtain dependencies. The output of this command *must* be a valid JSON array. + Command string `yaml:"command,omitempty" yamltags:"oneOf=dependency"` + + // Paths locates the file dependencies for the command relative to workspace. + // Paths should be set to the file dependencies for this command, so that the skaffold file watcher knows when to retest and perform file synchronization. + // For example: `["src/test/**"]` + Paths []string `yaml:"paths,omitempty" yamltags:"oneOf=dependency"` + + // Ignore specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both `paths` and in `ignore`, it will be ignored, and will be excluded from both retest and file synchronization. + // Will only work in conjunction with `paths`. + Ignore []string `yaml:"ignore,omitempty"` +} + +// DockerfileDependency *beta* is used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile. +type DockerfileDependency struct { + // Path locates the Dockerfile relative to workspace. + Path string `yaml:"path,omitempty"` + + // BuildArgs are key/value pairs used to resolve values of `ARG` instructions in a Dockerfile. + // Values can be constants or environment variables via the go template syntax. + // For example: `{"key1": "value1", "key2": "value2", "key3": "'{{.ENV_VARIABLE}}'"}`. + BuildArgs map[string]*string `yaml:"buildArgs,omitempty"` +} + +// KanikoArtifact describes an artifact built from a Dockerfile, +// with kaniko. +type KanikoArtifact struct { + + // Cleanup to clean the filesystem at the end of the build. + Cleanup bool `yaml:"cleanup,omitempty"` + + // Insecure if you want to push images to a plain HTTP registry. + Insecure bool `yaml:"insecure,omitempty"` + + // InsecurePull if you want to pull images from a plain HTTP registry. + InsecurePull bool `yaml:"insecurePull,omitempty"` + + // NoPush if you only want to build the image, without pushing to a registry. + NoPush bool `yaml:"noPush,omitempty"` + + // Force building outside of a container. + Force bool `yaml:"force,omitempty"` + + // LogTimestamp to add timestamps to log format. + LogTimestamp bool `yaml:"logTimestamp,omitempty"` + + // Reproducible is used to strip timestamps out of the built image. + Reproducible bool `yaml:"reproducible,omitempty"` + + // SingleSnapshot is takes a single snapshot of the filesystem at the end of the build. + // So only one layer will be appended to the base image. + SingleSnapshot bool `yaml:"singleSnapshot,omitempty"` + + // SkipTLS skips TLS certificate validation when pushing to a registry. + SkipTLS bool `yaml:"skipTLS,omitempty"` + + // SkipTLSVerifyPull skips TLS certificate validation when pulling from a registry. + SkipTLSVerifyPull bool `yaml:"skipTLSVerifyPull,omitempty"` + + // SkipUnusedStages builds only used stages if defined to true. + // Otherwise it builds by default all stages, even the unnecessaries ones until it reaches the target stage / end of Dockerfile. + SkipUnusedStages bool `yaml:"skipUnusedStages,omitempty"` + + // UseNewRun to Use the experimental run implementation for detecting changes without requiring file system snapshots. + // In some cases, this may improve build performance by 75%. + UseNewRun bool `yaml:"useNewRun,omitempty"` + + // WhitelistVarRun is used to ignore `/var/run` when taking image snapshot. + // Set it to false to preserve /var/run/* in destination image. + WhitelistVarRun bool `yaml:"whitelistVarRun,omitempty"` + + // DockerfilePath locates the Dockerfile relative to workspace. + // Defaults to `Dockerfile`. + DockerfilePath string `yaml:"dockerfile,omitempty"` + + // Target is to indicate which build stage is the target build stage. + Target string `yaml:"target,omitempty"` + + // InitImage is the image used to run init container which mounts kaniko context. + InitImage string `yaml:"initImage,omitempty"` + + // Image is the Docker image used by the Kaniko pod. + // Defaults to the latest released version of `gcr.io/kaniko-project/executor`. + Image string `yaml:"image,omitempty"` + + // DigestFile to specify a file in the container. This file will receive the digest of a built image. + // This can be used to automatically track the exact image built by kaniko. + DigestFile string `yaml:"digestFile,omitempty"` + + // ImageFSExtractRetry is the number of retries that should happen for extracting an image filesystem. + ImageFSExtractRetry string `yaml:"imageFSExtractRetry,omitempty"` + + // ImageNameWithDigestFile specify a file to save the image name with digest of the built image to. + ImageNameWithDigestFile string `yaml:"imageNameWithDigestFile,omitempty"` + + // LogFormat to set the log format. + LogFormat string `yaml:"logFormat,omitempty"` + + // OCILayoutPath is to specify a directory in the container where the OCI image layout of a built image will be placed. + // This can be used to automatically track the exact image built by kaniko. + OCILayoutPath string `yaml:"ociLayoutPath,omitempty"` + + // RegistryMirror if you want to use a registry mirror instead of default `index.docker.io`. + RegistryMirror string `yaml:"registryMirror,omitempty"` + + // SnapshotMode is how Kaniko will snapshot the filesystem. + SnapshotMode string `yaml:"snapshotMode,omitempty"` + + // PushRetry Set this flag to the number of retries that should happen for the push of an image to a remote destination. + PushRetry string `yaml:"pushRetry,omitempty"` + + // TarPath is path to save the image as a tarball at path instead of pushing the image. + TarPath string `yaml:"tarPath,omitempty"` + + // Verbosity to set the logging level. + Verbosity string `yaml:"verbosity,omitempty"` + + // InsecureRegistry is to use plain HTTP requests when accessing a registry. + InsecureRegistry []string `yaml:"insecureRegistry,omitempty"` + + // SkipTLSVerifyRegistry skips TLS certificate validation when accessing a registry. + SkipTLSVerifyRegistry []string `yaml:"skipTLSVerifyRegistry,omitempty"` + + // Env are environment variables passed to the kaniko pod. + // It also accepts environment variables via the go template syntax. + // For example: `[{"name": "key1", "value": "value1"}, {"name": "key2", "value": "value2"}, {"name": "key3", "value": "'{{.ENV_VARIABLE}}'"}]`. + Env []v1.EnvVar `yaml:"env,omitempty"` + + // Cache configures Kaniko caching. If a cache is specified, Kaniko will + // use a remote cache which will speed up builds. + Cache *KanikoCache `yaml:"cache,omitempty"` + + // RegistryCertificate is to provide a certificate for TLS communication with a given registry. + // my.registry.url: /path/to/the/certificate.cert is the expected format. + RegistryCertificate map[string]*string `yaml:"registryCertificate,omitempty"` + + // Label key: value to set some metadata to the final image. + // This is equivalent as using the LABEL within the Dockerfile. + Label map[string]*string `yaml:"label,omitempty"` + + // BuildArgs are arguments passed to the docker build. + // It also accepts environment variables and generated values via the go template syntax. + // Exposed generated values: IMAGE_REPO, IMAGE_NAME, IMAGE_TAG. + // For example: `{"key1": "value1", "key2": "value2", "key3": "'{{.ENV_VARIABLE}}'"}`. + BuildArgs map[string]*string `yaml:"buildArgs,omitempty"` + + // VolumeMounts are volume mounts passed to kaniko pod. + VolumeMounts []v1.VolumeMount `yaml:"volumeMounts,omitempty"` + + // ContextSubPath is to specify a sub path within the context. + ContextSubPath string `yaml:"contextSubPath,omitempty" skaffold:"filepath"` + + // IgnorePaths is a list of ignored paths when making an image snapshot. + IgnorePaths []string `yaml:"ignorePaths,omitempty"` +} + +// DockerArtifact describes an artifact built from a Dockerfile, +// usually using `docker build`. +type DockerArtifact struct { + // DockerfilePath locates the Dockerfile relative to workspace. + // Defaults to `Dockerfile`. + DockerfilePath string `yaml:"dockerfile,omitempty"` + + // Target is the Dockerfile target name to build. + Target string `yaml:"target,omitempty"` + + // BuildArgs are arguments passed to the docker build. + // For example: `{"key1": "value1", "key2": "{{ .ENV_VAR }}"}`. + BuildArgs map[string]*string `yaml:"buildArgs,omitempty"` + + // NetworkMode is passed through to docker and overrides the + // network configuration of docker builder. If unset, use whatever + // is configured in the underlying docker daemon. Valid modes are + // `host`: use the host's networking stack. + // `bridge`: use the bridged network configuration. + // `container:`: reuse another container's network stack. + // `none`: no networking in the container. + NetworkMode string `yaml:"network,omitempty"` + + // AddHost lists add host. + // For example: `["host1:ip1", "host2:ip2"]`. + AddHost []string `yaml:"addHost,omitempty"` + + // CacheFrom lists the Docker images used as cache sources. + // For example: `["golang:1.10.1-alpine3.7", "alpine:3.7"]`. + CacheFrom []string `yaml:"cacheFrom,omitempty"` + + // CliFlags are any additional flags to pass to the local daemon during a build. + // These flags are only used during a build through the Docker CLI. + CliFlags []string `yaml:"cliFlags,omitempty"` + + // PullParent is used to attempt pulling the parent image even if an older image exists locally. + PullParent bool `yaml:"pullParent,omitempty"` + + // NoCache set to true to pass in --no-cache to docker build, which will prevent caching. + NoCache bool `yaml:"noCache,omitempty"` + + // Squash is used to pass in --squash to docker build to squash docker image layers into single layer. + Squash bool `yaml:"squash,omitempty"` + + // Secrets is used to pass in --secret to docker build, `useBuildKit: true` is required. + Secrets []*DockerSecret `yaml:"secrets,omitempty"` + + // SSH is used to pass in --ssh to docker build to use SSH agent. Format is "default|[=|[,]]". + SSH string `yaml:"ssh,omitempty"` +} + +// DockerSecret is used to pass in --secret to docker build, `useBuildKit: true` is required. +type DockerSecret struct { + // ID is the id of the secret. + ID string `yaml:"id,omitempty" yamltags:"required"` + + // Source is the path to the secret on the host machine. + Source string `yaml:"src,omitempty" yamltags:"oneOf=secretSource"` + + // Env is the environment variable name containing the secret value. + Env string `yaml:"env,omitempty" yamltags:"oneOf=secretSource"` +} + +// BazelArtifact describes an artifact built with [Bazel](https://bazel.build/). +type BazelArtifact struct { + // BuildTarget is the `bazel build` target to run. + // For example: `//:skaffold_example.tar`. + BuildTarget string `yaml:"target,omitempty" yamltags:"required"` + + // BuildArgs are additional args to pass to `bazel build`. + // For example: `["-flag", "--otherflag"]`. + BuildArgs []string `yaml:"args,omitempty"` +} + +// KoArtifact builds images using [ko](https://github.com/google/ko). +type KoArtifact struct { + // BaseImage overrides the default ko base image (`gcr.io/distroless/static:nonroot`). + // Corresponds to, and overrides, the `defaultBaseImage` in `.ko.yaml`. + BaseImage string `yaml:"fromImage,omitempty"` + + // Dependencies are the file dependencies that Skaffold should watch for both rebuilding and file syncing for this artifact. + Dependencies *KoDependencies `yaml:"dependencies,omitempty"` + + // Dir is the directory where the `go` tool will be run. + // The value is a directory path relative to the `context` directory. + // If empty, the `go` tool will run in the `context` directory. + // Example: `./my-app-sources`. + Dir string `yaml:"dir,omitempty"` + + // Env are environment variables, in the `key=value` form, passed to the build. + // These environment variables are only used at build time. + // They are _not_ set in the resulting container image. + // For example: `["GOPRIVATE=git.example.com", "GOCACHE=/workspace/.gocache"]`. + Env []string `yaml:"env,omitempty"` + + // Flags are additional build flags passed to `go build`. + // For example: `["-trimpath", "-v"]`. + Flags []string `yaml:"flags,omitempty"` + + // Labels are key-value string pairs to add to the image config. + // For example: `{"foo":"bar"}`. + Labels map[string]string `yaml:"labels,omitempty"` + + // Ldflags are linker flags passed to the builder. + // For example: `["-buildid=", "-s", "-w"]`. + Ldflags []string `yaml:"ldflags,omitempty"` + + // Main is the location of the main package. It is the pattern passed to `go build`. + // If main is specified as a relative path, it is relative to the `context` directory. + // If main is empty, the ko builder uses a default value of `.`. + // If main is a pattern with wildcards, such as `./...`, the expansion must contain only one main package, otherwise ko fails. + // Main is ignored if the `ImageName` starts with `ko://`. + // Example: `./cmd/foo`. + Main string `yaml:"main,omitempty"` +} + +// KoDependencies is used to specify dependencies for an artifact built by ko. +type KoDependencies struct { + // Paths should be set to the file dependencies for this artifact, so that the Skaffold file watcher knows when to rebuild and perform file synchronization. + // Defaults to `["**/*.go"]`. + Paths []string `yaml:"paths,omitempty" yamltags:"oneOf=dependency"` + + // Ignore specifies the paths that should be ignored by Skaffold's file watcher. + // If a file exists in both `paths` and in `ignore`, it will be ignored, and will be excluded from both rebuilds and file synchronization. + Ignore []string `yaml:"ignore,omitempty"` +} + +// JibArtifact builds images using the +// [Jib plugins for Maven and Gradle](https://github.com/GoogleContainerTools/jib/). +type JibArtifact struct { + // Project selects which sub-project to build for multi-module builds. + Project string `yaml:"project,omitempty"` + + // Flags are additional build flags passed to the builder. + // For example: `["--no-build-cache"]`. + Flags []string `yaml:"args,omitempty"` + + // Type the Jib builder type; normally determined automatically. Valid types are + // `maven`: for Maven. + // `gradle`: for Gradle. + Type string `yaml:"type,omitempty"` + + // BaseImage overrides the configured jib base image. + BaseImage string `yaml:"fromImage,omitempty"` +} + +// BuildHooks describes the list of lifecycle hooks to execute before and after each artifact build step. +type BuildHooks struct { + // PreHooks describes the list of lifecycle hooks to execute *before* each artifact build step. + PreHooks []HostHook `yaml:"before,omitempty"` + // PostHooks describes the list of lifecycle hooks to execute *after* each artifact build step. + PostHooks []HostHook `yaml:"after,omitempty"` +} + +// SyncHookItem describes a single lifecycle hook to execute before or after each artifact sync step. +type SyncHookItem struct { + // HostHook describes a single lifecycle hook to run on the host machine. + HostHook *HostHook `yaml:"host,omitempty" yamltags:"oneOf=sync_hook"` + // ContainerHook describes a single lifecycle hook to run on a container. + ContainerHook *ContainerHook `yaml:"container,omitempty" yamltags:"oneOf=sync_hook"` +} + +// SyncHooks describes the list of lifecycle hooks to execute before and after each artifact sync step. +type SyncHooks struct { + // PreHooks describes the list of lifecycle hooks to execute *before* each artifact sync step. + PreHooks []SyncHookItem `yaml:"before,omitempty"` + // PostHooks describes the list of lifecycle hooks to execute *after* each artifact sync step. + PostHooks []SyncHookItem `yaml:"after,omitempty"` +} + +// RenderHookItem describes a single lifecycle hook to execute before or after each deployer step. +type RenderHookItem struct { + // HostHook describes a single lifecycle hook to run on the host machine. + HostHook *HostHook `yaml:"host,omitempty" yamltags:"oneOf=render_hook"` +} + +// RenderHooks describes the list of lifecycle hooks to execute before and after each render step. +type RenderHooks struct { + // PreHooks describes the list of lifecycle hooks to execute *before* each render step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during `skaffold dev`). + PreHooks []RenderHookItem `yaml:"before,omitempty"` + // PostHooks describes the list of lifecycle hooks to execute *after* each render step. + PostHooks []RenderHookItem `yaml:"after,omitempty"` +} + +// CloudRunDeployHooks describes the list of lifecycle hooks to execute in the host before and after the Cloud Run deployer. +type CloudRunDeployHooks struct { + // PreHooks describes the list of lifecycle hooks to execute *before* the Cloud Run deployer. + PreHooks []HostHook `yaml:"before,omitempty"` + // PostHooks describes the list of lifecycle hooks to execute *after* the Cloud Run deployer. + PostHooks []HostHook `yaml:"after,omitempty"` +} + +// DeployHookItem describes a single lifecycle hook to execute before or after each deployer step. +type DeployHookItem struct { + // HostHook describes a single lifecycle hook to run on the host machine. + HostHook *HostHook `yaml:"host,omitempty" yamltags:"oneOf=deploy_hook"` + // ContainerHook describes a single lifecycle hook to run on a container. + ContainerHook *NamedContainerHook `yaml:"container,omitempty" yamltags:"oneOf=deploy_hook"` +} + +// DeployHooks describes the list of lifecycle hooks to execute before and after each deployer step. +type DeployHooks struct { + // PreHooks describes the list of lifecycle hooks to execute *before* each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during `skaffold dev`). + PreHooks []DeployHookItem `yaml:"before,omitempty"` + // PostHooks describes the list of lifecycle hooks to execute *after* each deployer step. + PostHooks []DeployHookItem `yaml:"after,omitempty"` +} + +// HostHook describes a lifecycle hook definition to execute on the host machine. +type HostHook struct { + // Command is the command to execute. + Command []string `yaml:"command" yamltags:"required"` + // OS is an optional slice of operating system names. If the host machine OS is different, then it skips execution. + OS []string `yaml:"os,omitempty"` + // Dir specifies the working directory of the command. + // If empty, the command runs in the calling process's current directory. + Dir string `yaml:"dir,omitempty" skaffold:"filepath"` +} + +// ContainerHook describes a lifecycle hook definition to execute on a container. The container name is inferred from the scope in which this hook is defined. +type ContainerHook struct { + // Command is the command to execute. + Command []string `yaml:"command" yamltags:"required"` +} + +// NamedContainerHook describes a lifecycle hook definition to execute on a named container. +type NamedContainerHook struct { + // ContainerHook describes a lifecycle hook definition to execute on a container. + ContainerHook `yaml:",inline" yamlTags:"skipTrim"` + // PodName is the name of the pod to execute the command in. + PodName string `yaml:"podName" yamltags:"required"` + // ContainerName is the name of the container to execute the command in. + ContainerName string `yaml:"containerName,omitempty"` +} + +// ResourceFilter contains definition to filter which resource to transform. +type ResourceFilter struct { + // GroupKind is the compact format of a resource type. + GroupKind string `yaml:"groupKind" yamltags:"required"` + // Image is an optional slice of JSON-path-like paths of where to rewrite images. + Image []string `yaml:"image,omitempty"` + // Labels is an optional slice of JSON-path-like paths of where to add a labels block if missing. + Labels []string `yaml:"labels,omitempty"` + // PodSpec is an optional slice of JSON-path-like paths of where pod spec properties can be overwritten. + PodSpec []string `yaml:"podSpec,omitempty"` +} + +// UnmarshalYAML provides a custom unmarshaller to deal with +// https://github.com/GoogleContainerTools/skaffold/issues/4175 +func (clusterDetails *ClusterDetails) UnmarshalYAML(value *yaml.Node) error { + // We do this as follows + // 1. We zero out the fields in the node that require custom processing + // 2. We unmarshal all the non special fields using the aliased type resource + // we use an alias type to avoid recursion caused by invoking this function infinitely + // 3. We deserialize the special fields as required. + type ClusterDetailsForUnmarshaling ClusterDetails + + volumes, remaining, err := util.UnmarshalClusterVolumes(value) + + if err != nil { + return err + } + + // Unmarshal the remaining values + aux := (*ClusterDetailsForUnmarshaling)(clusterDetails) + err = yaml.Unmarshal(remaining, aux) + + if err != nil { + return err + } + + clusterDetails.Volumes = volumes + return nil +} + +// UnmarshalYAML provides a custom unmarshaller to deal with +// https://github.com/GoogleContainerTools/skaffold/issues/4175 +func (ka *KanikoArtifact) UnmarshalYAML(value *yaml.Node) error { + // We do this as follows + // 1. We zero out the fields in the node that require custom processing + // 2. We unmarshal all the non special fields using the aliased type resource + // we use an alias type to avoid recursion caused by invoking this function infinitely + // 3. We deserialize the special fields as required. + type KanikoArtifactForUnmarshaling KanikoArtifact + + mounts, remaining, err := util.UnmarshalKanikoArtifact(value) + + if err != nil { + return err + } + + // Unmarshal the remaining values + aux := (*KanikoArtifactForUnmarshaling)(ka) + err = yaml.Unmarshal(remaining, aux) + + if err != nil { + return err + } + + ka.VolumeMounts = mounts + return nil +} + +// MarshalYAML provides a custom marshaller to deal with +// https://github.com/GoogleContainerTools/skaffold/issues/4175 +func (clusterDetails *ClusterDetails) MarshalYAML() (interface{}, error) { + // We do this as follows + // 1. We zero out the fields in the node that require custom processing + // 2. We marshall all the non special fields using the aliased type resource + // we use an alias type to avoid recursion caused by invoking this function infinitely + // 3. We unmarshal to a map + // 4. We marshal the special fields to json and unmarshal to a map + // * This leverages the json struct annotations to marshal as expected + // 5. We combine the two maps and return + type ClusterDetailsForUnmarshaling ClusterDetails + + // Marshal volumes to a list. Use json because the Kubernetes resources have json annotations. + volumes := clusterDetails.Volumes + + j, err := json.Marshal(volumes) + + if err != nil { + return err, nil + } + + vList := []interface{}{} + + if err := json.Unmarshal(j, &vList); err != nil { + return nil, err + } + + // Make a deep copy of clusterDetails because we need to zero out volumes and we don't want to modify the + // current object. + aux := &ClusterDetailsForUnmarshaling{} + + b, err := json.Marshal(clusterDetails) + + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, aux); err != nil { + return nil, err + } + + aux.Volumes = nil + + marshaled, err := yaml.Marshal(aux) + + if err != nil { + return nil, err + } + + m := map[string]interface{}{} + + err = yaml.Unmarshal(marshaled, m) + + if len(vList) > 0 { + m["volumes"] = vList + } + return m, err +} + +// MarshalYAML provides a custom marshaller to deal with +// https://github.com/GoogleContainerTools/skaffold/issues/4175 +func (ka *KanikoArtifact) MarshalYAML() (interface{}, error) { + // We do this as follows + // 1. We zero out the fields in the node that require custom processing + // 2. We marshal all the non special fields using the aliased type resource + // we use an alias type to avoid recursion caused by invoking this function infinitely + // 3. We unmarshal to a map + // 4. We marshal the special fields to json and unmarshal to a map + // * This leverages the json struct annotations to marshal as expected + // 5. We combine the two maps and return + type KanikoArtifactForUnmarshaling KanikoArtifact + + // Marshal volumes to a map. User json because the Kubernetes resources have json annotations. + volumeMounts := ka.VolumeMounts + + j, err := json.Marshal(volumeMounts) + + if err != nil { + return err, nil + } + + vList := []interface{}{} + + if err := json.Unmarshal(j, &vList); err != nil { + return nil, err + } + + // Make a deep copy of kanikoArtifact because we need to zero out volumeMounts and we don't want to modify the + // current object. + aux := &KanikoArtifactForUnmarshaling{} + + b, err := json.Marshal(ka) + + if err != nil { + return nil, err + } + + if err := json.Unmarshal(b, aux); err != nil { + return nil, err + } + aux.VolumeMounts = nil + + marshaled, err := yaml.Marshal(aux) + + if err != nil { + return nil, err + } + + m := map[string]interface{}{} + + err = yaml.Unmarshal(marshaled, m) + + if len(vList) > 0 { + m["volumeMounts"] = vList + } + return m, err +} diff --git a/pkg/skaffold/schema/v4beta3/upgrade.go b/pkg/skaffold/schema/v4beta3/upgrade.go new file mode 100755 index 00000000000..4b55128a9a4 --- /dev/null +++ b/pkg/skaffold/schema/v4beta3/upgrade.go @@ -0,0 +1,38 @@ +/* +Copyright 2020 The Skaffold Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package v4beta3 + +import ( + next "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest" + "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/util" + pkgutil "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/util" +) + +// Upgrade upgrades a configuration to the next version. +// Config changes from v4beta3 to v4beta4 +func (c *SkaffoldConfig) Upgrade() (util.VersionedConfig, error) { + var newConfig next.SkaffoldConfig + pkgutil.CloneThroughJSON(c, &newConfig) + newConfig.APIVersion = next.Version + + err := util.UpgradePipelines(c, &newConfig, upgradeOnePipeline) + return &newConfig, err +} + +func upgradeOnePipeline(oldPipeline, newPipeline interface{}) error { + return nil +} diff --git a/pkg/skaffold/schema/v4beta3/upgrade_test.go b/pkg/skaffold/schema/v4beta3/upgrade_test.go new file mode 100755 index 00000000000..1f9607837f3 --- /dev/null +++ b/pkg/skaffold/schema/v4beta3/upgrade_test.go @@ -0,0 +1,235 @@ +/* +Copyright 2020 The Skaffold Authors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +package v4beta3 + +import ( + "testing" + + next "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/latest" + "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/yaml" + "github.com/GoogleContainerTools/skaffold/v2/testutil" +) + +func TestUpgrade(t *testing.T) { + yaml := `apiVersion: skaffold/v4beta3 +kind: Config +build: + artifacts: + - image: gcr.io/k8s-skaffold/skaffold-example + docker: + dockerfile: path/to/Dockerfile + secrets: + - id: id + src: /file.txt + - image: gcr.io/k8s-skaffold/bazel + bazel: + target: //mytarget + - image: gcr.io/k8s-skaffold/jib-maven + jib: + args: ['-v', '--activate-profiles', 'prof'] + project: dir + - image: gcr.io/k8s-skaffold/jib-gradle + jib: + args: ['-v'] + - image: gcr.io/k8s-skaffold/buildpacks + buildpacks: + builder: gcr.io/buildpacks/builder:v1 + sync: + auto: true + - image: ko://github.com/GoogleContainerTools/skaffold/cmd/skaffold + ko: {} + platforms: ['linux/arm64', 'linux/amd64'] + - image: gcr.io/k8s-skaffold/leeroy-app + context: leeroy-web + googleCloudBuild: + projectId: test-project +test: + - image: gcr.io/k8s-skaffold/skaffold-example + structureTests: + - ./test/* +manifests: + rawYaml: + - k8s-* + kustomize: + paths: + - kustomization-main + helm: + releases: + - name: skaffold-helm + chartPath: charts +deploy: + kubectl: + remoteManifests: + - deploy/test + helm: {} +portForward: + - resourceType: deployment + resourceName: leeroy-app + port: 8080 + localPort: 9001 +profiles: + - name: test profile + build: + artifacts: + - image: gcr.io/k8s-skaffold/skaffold-example + kaniko: + cache: {} + cluster: + pullSecretName: e2esecret + pullSecretPath: secret.json + namespace: default + test: + - image: gcr.io/k8s-skaffold/skaffold-example + structureTests: + - ./test/* + manifests: + rawYaml: + - k8s-* + kustomize: + paths: + - kustomization-test + deploy: + kubectl: {} + - name: test local + build: + artifacts: + - image: gcr.io/k8s-skaffold/skaffold-example + docker: + dockerfile: path/to/Dockerfile + local: + push: false + manifests: + rawYaml: + - k8s-* + kustomize: + paths: + - "." + deploy: + kubectl: {} +` + expected := `apiVersion: skaffold/v4beta4 +kind: Config +build: + artifacts: + - image: gcr.io/k8s-skaffold/skaffold-example + docker: + dockerfile: path/to/Dockerfile + secrets: + - id: id + src: /file.txt + - image: gcr.io/k8s-skaffold/bazel + bazel: + target: //mytarget + - image: gcr.io/k8s-skaffold/jib-maven + jib: + args: ['-v', '--activate-profiles', 'prof'] + project: dir + - image: gcr.io/k8s-skaffold/jib-gradle + jib: + args: ['-v'] + - image: gcr.io/k8s-skaffold/buildpacks + buildpacks: + builder: gcr.io/buildpacks/builder:v1 + sync: + auto: true + - image: ko://github.com/GoogleContainerTools/skaffold/cmd/skaffold + ko: {} + platforms: ['linux/arm64', 'linux/amd64'] + - image: gcr.io/k8s-skaffold/leeroy-app + context: leeroy-web + googleCloudBuild: + projectId: test-project +test: + - image: gcr.io/k8s-skaffold/skaffold-example + structureTests: + - ./test/* +manifests: + rawYaml: + - k8s-* + kustomize: + paths: + - kustomization-main + helm: + releases: + - name: skaffold-helm + chartPath: charts +deploy: + kubectl: + remoteManifests: + - deploy/test + helm: {} +portForward: + - resourceType: deployment + resourceName: leeroy-app + port: 8080 + localPort: 9001 +profiles: + - name: test profile + build: + artifacts: + - image: gcr.io/k8s-skaffold/skaffold-example + kaniko: + cache: {} + cluster: + pullSecretName: e2esecret + pullSecretPath: secret.json + namespace: default + test: + - image: gcr.io/k8s-skaffold/skaffold-example + structureTests: + - ./test/* + manifests: + rawYaml: + - k8s-* + kustomize: + paths: + - kustomization-test + deploy: + kubectl: {} + - name: test local + build: + artifacts: + - image: gcr.io/k8s-skaffold/skaffold-example + docker: + dockerfile: path/to/Dockerfile + local: + push: false + manifests: + rawYaml: + - k8s-* + kustomize: + paths: + - "." + deploy: + kubectl: {} +` + verifyUpgrade(t, yaml, expected) +} + +func verifyUpgrade(t *testing.T, input, output string) { + config := NewSkaffoldConfig() + err := yaml.UnmarshalStrict([]byte(input), config) + testutil.CheckErrorAndDeepEqual(t, false, err, Version, config.GetVersion()) + + upgraded, err := config.Upgrade() + testutil.CheckError(t, false, err) + + expected := next.NewSkaffoldConfig() + err = yaml.UnmarshalStrict([]byte(output), expected) + + testutil.CheckErrorAndDeepEqual(t, false, err, expected, upgraded) +} diff --git a/pkg/skaffold/schema/versions.go b/pkg/skaffold/schema/versions.go index 40d318bc97d..811b3739f99 100644 --- a/pkg/skaffold/schema/versions.go +++ b/pkg/skaffold/schema/versions.go @@ -92,6 +92,7 @@ import ( "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/v3alpha1" "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/v4beta1" "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/v4beta2" + "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/schema/v4beta3" misc "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/util" ) @@ -168,6 +169,7 @@ var SchemaVersionsV1 = Versions{ {v3.Version, v3.NewSkaffoldConfig}, {v4beta1.Version, v4beta1.NewSkaffoldConfig}, {v4beta2.Version, v4beta2.NewSkaffoldConfig}, + {v4beta3.Version, v4beta3.NewSkaffoldConfig}, } // SchemaVersionsV2 refers to all the supported API Schemas for skaffold v2 executables. The API schema versions are