github.com/GoogleContainerTools/skaffold/v2@v2.13.2/docs-v2/content/en/schemas/v2beta11.json (about) 1 { 2 "type": "object", 3 "anyOf": [ 4 { 5 "$ref": "#/definitions/SkaffoldConfig" 6 } 7 ], 8 "$schema": "http://json-schema.org/draft-07/schema#", 9 "definitions": { 10 "Activation": { 11 "properties": { 12 "command": { 13 "type": "string", 14 "description": "a Skaffold command for which the profile is auto-activated.", 15 "x-intellij-html-description": "a Skaffold command for which the profile is auto-activated.", 16 "examples": [ 17 "dev" 18 ] 19 }, 20 "env": { 21 "type": "string", 22 "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.", 23 "x-intellij-html-description": "a <code>key=pattern</code> pair. The profile is auto-activated if an Environment Variable <code>key</code> matches the pattern. If the pattern starts with <code>!</code>, activation happens if the remaining pattern is <em>not</em> matched. The pattern matches if the Environment Variable value is exactly <code>pattern</code>, or the regex <code>pattern</code> is found in it. An empty <code>pattern</code> (e.g. <code>env: "key="</code>) always only matches if the Environment Variable is undefined or empty.", 24 "examples": [ 25 "ENV=production" 26 ] 27 }, 28 "kubeContext": { 29 "type": "string", 30 "description": "a Kubernetes context for which the profile is auto-activated.", 31 "x-intellij-html-description": "a Kubernetes context for which the profile is auto-activated.", 32 "examples": [ 33 "minikube" 34 ] 35 } 36 }, 37 "preferredOrder": [ 38 "env", 39 "kubeContext", 40 "command" 41 ], 42 "additionalProperties": false, 43 "type": "object", 44 "description": "criteria by which a profile is auto-activated.", 45 "x-intellij-html-description": "criteria by which a profile is auto-activated." 46 }, 47 "Artifact": { 48 "required": [ 49 "image" 50 ], 51 "type": "object", 52 "anyOf": [ 53 { 54 "properties": { 55 "context": { 56 "type": "string", 57 "description": "directory containing the artifact's sources.", 58 "x-intellij-html-description": "directory containing the artifact's sources.", 59 "default": "." 60 }, 61 "image": { 62 "type": "string", 63 "description": "name of the image to be built.", 64 "x-intellij-html-description": "name of the image to be built.", 65 "examples": [ 66 "gcr.io/k8s-skaffold/example" 67 ] 68 }, 69 "requires": { 70 "items": { 71 "$ref": "#/definitions/ArtifactDependency" 72 }, 73 "type": "array", 74 "description": "describes build artifacts that this artifact depends on.", 75 "x-intellij-html-description": "describes build artifacts that this artifact depends on." 76 }, 77 "sync": { 78 "$ref": "#/definitions/Sync", 79 "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.", 80 "x-intellij-html-description": "<em>beta</em> 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.", 81 "default": "infer: [\"**/*\"]" 82 } 83 }, 84 "preferredOrder": [ 85 "image", 86 "context", 87 "sync", 88 "requires" 89 ], 90 "additionalProperties": false 91 }, 92 { 93 "properties": { 94 "context": { 95 "type": "string", 96 "description": "directory containing the artifact's sources.", 97 "x-intellij-html-description": "directory containing the artifact's sources.", 98 "default": "." 99 }, 100 "docker": { 101 "$ref": "#/definitions/DockerArtifact", 102 "description": "*beta* describes an artifact built from a Dockerfile.", 103 "x-intellij-html-description": "<em>beta</em> describes an artifact built from a Dockerfile." 104 }, 105 "image": { 106 "type": "string", 107 "description": "name of the image to be built.", 108 "x-intellij-html-description": "name of the image to be built.", 109 "examples": [ 110 "gcr.io/k8s-skaffold/example" 111 ] 112 }, 113 "requires": { 114 "items": { 115 "$ref": "#/definitions/ArtifactDependency" 116 }, 117 "type": "array", 118 "description": "describes build artifacts that this artifact depends on.", 119 "x-intellij-html-description": "describes build artifacts that this artifact depends on." 120 }, 121 "sync": { 122 "$ref": "#/definitions/Sync", 123 "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.", 124 "x-intellij-html-description": "<em>beta</em> 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.", 125 "default": "infer: [\"**/*\"]" 126 } 127 }, 128 "preferredOrder": [ 129 "image", 130 "context", 131 "sync", 132 "requires", 133 "docker" 134 ], 135 "additionalProperties": false 136 }, 137 { 138 "properties": { 139 "bazel": { 140 "$ref": "#/definitions/BazelArtifact", 141 "description": "*beta* requires bazel CLI to be installed and the sources to contain [Bazel](https://bazel.build/) configuration files.", 142 "x-intellij-html-description": "<em>beta</em> requires bazel CLI to be installed and the sources to contain <a href=\"https://bazel.build/\">Bazel</a> configuration files." 143 }, 144 "context": { 145 "type": "string", 146 "description": "directory containing the artifact's sources.", 147 "x-intellij-html-description": "directory containing the artifact's sources.", 148 "default": "." 149 }, 150 "image": { 151 "type": "string", 152 "description": "name of the image to be built.", 153 "x-intellij-html-description": "name of the image to be built.", 154 "examples": [ 155 "gcr.io/k8s-skaffold/example" 156 ] 157 }, 158 "requires": { 159 "items": { 160 "$ref": "#/definitions/ArtifactDependency" 161 }, 162 "type": "array", 163 "description": "describes build artifacts that this artifact depends on.", 164 "x-intellij-html-description": "describes build artifacts that this artifact depends on." 165 }, 166 "sync": { 167 "$ref": "#/definitions/Sync", 168 "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.", 169 "x-intellij-html-description": "<em>beta</em> 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.", 170 "default": "infer: [\"**/*\"]" 171 } 172 }, 173 "preferredOrder": [ 174 "image", 175 "context", 176 "sync", 177 "requires", 178 "bazel" 179 ], 180 "additionalProperties": false 181 }, 182 { 183 "properties": { 184 "context": { 185 "type": "string", 186 "description": "directory containing the artifact's sources.", 187 "x-intellij-html-description": "directory containing the artifact's sources.", 188 "default": "." 189 }, 190 "image": { 191 "type": "string", 192 "description": "name of the image to be built.", 193 "x-intellij-html-description": "name of the image to be built.", 194 "examples": [ 195 "gcr.io/k8s-skaffold/example" 196 ] 197 }, 198 "jib": { 199 "$ref": "#/definitions/JibArtifact", 200 "description": "builds images using the [Jib plugins for Maven or Gradle](https://github.com/GoogleContainerTools/jib/).", 201 "x-intellij-html-description": "builds images using the <a href=\"https://github.com/GoogleContainerTools/jib/\">Jib plugins for Maven or Gradle</a>." 202 }, 203 "requires": { 204 "items": { 205 "$ref": "#/definitions/ArtifactDependency" 206 }, 207 "type": "array", 208 "description": "describes build artifacts that this artifact depends on.", 209 "x-intellij-html-description": "describes build artifacts that this artifact depends on." 210 }, 211 "sync": { 212 "$ref": "#/definitions/Sync", 213 "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.", 214 "x-intellij-html-description": "<em>beta</em> 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.", 215 "default": "infer: [\"**/*\"]" 216 } 217 }, 218 "preferredOrder": [ 219 "image", 220 "context", 221 "sync", 222 "requires", 223 "jib" 224 ], 225 "additionalProperties": false 226 }, 227 { 228 "properties": { 229 "context": { 230 "type": "string", 231 "description": "directory containing the artifact's sources.", 232 "x-intellij-html-description": "directory containing the artifact's sources.", 233 "default": "." 234 }, 235 "image": { 236 "type": "string", 237 "description": "name of the image to be built.", 238 "x-intellij-html-description": "name of the image to be built.", 239 "examples": [ 240 "gcr.io/k8s-skaffold/example" 241 ] 242 }, 243 "kaniko": { 244 "$ref": "#/definitions/KanikoArtifact", 245 "description": "builds images using [kaniko](https://github.com/GoogleContainerTools/kaniko).", 246 "x-intellij-html-description": "builds images using <a href=\"https://github.com/GoogleContainerTools/kaniko\">kaniko</a>." 247 }, 248 "requires": { 249 "items": { 250 "$ref": "#/definitions/ArtifactDependency" 251 }, 252 "type": "array", 253 "description": "describes build artifacts that this artifact depends on.", 254 "x-intellij-html-description": "describes build artifacts that this artifact depends on." 255 }, 256 "sync": { 257 "$ref": "#/definitions/Sync", 258 "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.", 259 "x-intellij-html-description": "<em>beta</em> 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.", 260 "default": "infer: [\"**/*\"]" 261 } 262 }, 263 "preferredOrder": [ 264 "image", 265 "context", 266 "sync", 267 "requires", 268 "kaniko" 269 ], 270 "additionalProperties": false 271 }, 272 { 273 "properties": { 274 "buildpacks": { 275 "$ref": "#/definitions/BuildpackArtifact", 276 "description": "builds images using [Cloud Native Buildpacks](https://buildpacks.io/).", 277 "x-intellij-html-description": "builds images using <a href=\"https://buildpacks.io/\">Cloud Native Buildpacks</a>." 278 }, 279 "context": { 280 "type": "string", 281 "description": "directory containing the artifact's sources.", 282 "x-intellij-html-description": "directory containing the artifact's sources.", 283 "default": "." 284 }, 285 "image": { 286 "type": "string", 287 "description": "name of the image to be built.", 288 "x-intellij-html-description": "name of the image to be built.", 289 "examples": [ 290 "gcr.io/k8s-skaffold/example" 291 ] 292 }, 293 "requires": { 294 "items": { 295 "$ref": "#/definitions/ArtifactDependency" 296 }, 297 "type": "array", 298 "description": "describes build artifacts that this artifact depends on.", 299 "x-intellij-html-description": "describes build artifacts that this artifact depends on." 300 }, 301 "sync": { 302 "$ref": "#/definitions/Sync", 303 "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.", 304 "x-intellij-html-description": "<em>beta</em> 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.", 305 "default": "infer: [\"**/*\"]" 306 } 307 }, 308 "preferredOrder": [ 309 "image", 310 "context", 311 "sync", 312 "requires", 313 "buildpacks" 314 ], 315 "additionalProperties": false 316 }, 317 { 318 "properties": { 319 "context": { 320 "type": "string", 321 "description": "directory containing the artifact's sources.", 322 "x-intellij-html-description": "directory containing the artifact's sources.", 323 "default": "." 324 }, 325 "custom": { 326 "$ref": "#/definitions/CustomArtifact", 327 "description": "*beta* builds images using a custom build script written by the user.", 328 "x-intellij-html-description": "<em>beta</em> builds images using a custom build script written by the user." 329 }, 330 "image": { 331 "type": "string", 332 "description": "name of the image to be built.", 333 "x-intellij-html-description": "name of the image to be built.", 334 "examples": [ 335 "gcr.io/k8s-skaffold/example" 336 ] 337 }, 338 "requires": { 339 "items": { 340 "$ref": "#/definitions/ArtifactDependency" 341 }, 342 "type": "array", 343 "description": "describes build artifacts that this artifact depends on.", 344 "x-intellij-html-description": "describes build artifacts that this artifact depends on." 345 }, 346 "sync": { 347 "$ref": "#/definitions/Sync", 348 "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.", 349 "x-intellij-html-description": "<em>beta</em> 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.", 350 "default": "infer: [\"**/*\"]" 351 } 352 }, 353 "preferredOrder": [ 354 "image", 355 "context", 356 "sync", 357 "requires", 358 "custom" 359 ], 360 "additionalProperties": false 361 } 362 ], 363 "description": "items that need to be built, along with the context in which they should be built.", 364 "x-intellij-html-description": "items that need to be built, along with the context in which they should be built." 365 }, 366 "ArtifactDependency": { 367 "required": [ 368 "image" 369 ], 370 "properties": { 371 "alias": { 372 "type": "string", 373 "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`.", 374 "x-intellij-html-description": "a token that is replaced with the image reference in the builder definition files. For example, the <code>docker</code> builder will use the alias as a build-arg key. Defaults to the value of <code>image</code>." 375 }, 376 "image": { 377 "type": "string", 378 "description": "a reference to an artifact's image name.", 379 "x-intellij-html-description": "a reference to an artifact's image name." 380 } 381 }, 382 "preferredOrder": [ 383 "image", 384 "alias" 385 ], 386 "additionalProperties": false, 387 "type": "object", 388 "description": "describes a specific build dependency for an artifact.", 389 "x-intellij-html-description": "describes a specific build dependency for an artifact." 390 }, 391 "BazelArtifact": { 392 "required": [ 393 "target" 394 ], 395 "properties": { 396 "args": { 397 "items": { 398 "type": "string" 399 }, 400 "type": "array", 401 "description": "additional args to pass to `bazel build`.", 402 "x-intellij-html-description": "additional args to pass to <code>bazel build</code>.", 403 "default": "[]", 404 "examples": [ 405 "[\"-flag\", \"--otherflag\"]" 406 ] 407 }, 408 "target": { 409 "type": "string", 410 "description": "`bazel build` target to run.", 411 "x-intellij-html-description": "<code>bazel build</code> target to run.", 412 "examples": [ 413 "//:skaffold_example.tar" 414 ] 415 } 416 }, 417 "preferredOrder": [ 418 "target", 419 "args" 420 ], 421 "additionalProperties": false, 422 "type": "object", 423 "description": "describes an artifact built with [Bazel](https://bazel.build/).", 424 "x-intellij-html-description": "describes an artifact built with <a href=\"https://bazel.build/\">Bazel</a>." 425 }, 426 "BuildConfig": { 427 "type": "object", 428 "anyOf": [ 429 { 430 "properties": { 431 "artifacts": { 432 "items": { 433 "$ref": "#/definitions/Artifact" 434 }, 435 "type": "array", 436 "description": "the images you're going to be building.", 437 "x-intellij-html-description": "the images you're going to be building." 438 }, 439 "insecureRegistries": { 440 "items": { 441 "type": "string" 442 }, 443 "type": "array", 444 "description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", 445 "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.", 446 "default": "[]" 447 }, 448 "tagPolicy": { 449 "$ref": "#/definitions/TagPolicy", 450 "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}`.", 451 "x-intellij-html-description": "<em>beta</em> 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 <code>gitCommit: {variant: Tags}</code>." 452 } 453 }, 454 "preferredOrder": [ 455 "artifacts", 456 "insecureRegistries", 457 "tagPolicy" 458 ], 459 "additionalProperties": false 460 }, 461 { 462 "properties": { 463 "artifacts": { 464 "items": { 465 "$ref": "#/definitions/Artifact" 466 }, 467 "type": "array", 468 "description": "the images you're going to be building.", 469 "x-intellij-html-description": "the images you're going to be building." 470 }, 471 "insecureRegistries": { 472 "items": { 473 "type": "string" 474 }, 475 "type": "array", 476 "description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", 477 "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.", 478 "default": "[]" 479 }, 480 "local": { 481 "$ref": "#/definitions/LocalBuild", 482 "description": "*beta* describes how to do a build on the local docker daemon and optionally push to a repository.", 483 "x-intellij-html-description": "<em>beta</em> describes how to do a build on the local docker daemon and optionally push to a repository." 484 }, 485 "tagPolicy": { 486 "$ref": "#/definitions/TagPolicy", 487 "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}`.", 488 "x-intellij-html-description": "<em>beta</em> 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 <code>gitCommit: {variant: Tags}</code>." 489 } 490 }, 491 "preferredOrder": [ 492 "artifacts", 493 "insecureRegistries", 494 "tagPolicy", 495 "local" 496 ], 497 "additionalProperties": false 498 }, 499 { 500 "properties": { 501 "artifacts": { 502 "items": { 503 "$ref": "#/definitions/Artifact" 504 }, 505 "type": "array", 506 "description": "the images you're going to be building.", 507 "x-intellij-html-description": "the images you're going to be building." 508 }, 509 "googleCloudBuild": { 510 "$ref": "#/definitions/GoogleCloudBuild", 511 "description": "*beta* describes how to do a remote build on [Google Cloud Build](https://cloud.google.com/cloud-build/).", 512 "x-intellij-html-description": "<em>beta</em> describes how to do a remote build on <a href=\"https://cloud.google.com/cloud-build/\">Google Cloud Build</a>." 513 }, 514 "insecureRegistries": { 515 "items": { 516 "type": "string" 517 }, 518 "type": "array", 519 "description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", 520 "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.", 521 "default": "[]" 522 }, 523 "tagPolicy": { 524 "$ref": "#/definitions/TagPolicy", 525 "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}`.", 526 "x-intellij-html-description": "<em>beta</em> 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 <code>gitCommit: {variant: Tags}</code>." 527 } 528 }, 529 "preferredOrder": [ 530 "artifacts", 531 "insecureRegistries", 532 "tagPolicy", 533 "googleCloudBuild" 534 ], 535 "additionalProperties": false 536 }, 537 { 538 "properties": { 539 "artifacts": { 540 "items": { 541 "$ref": "#/definitions/Artifact" 542 }, 543 "type": "array", 544 "description": "the images you're going to be building.", 545 "x-intellij-html-description": "the images you're going to be building." 546 }, 547 "cluster": { 548 "$ref": "#/definitions/ClusterDetails", 549 "description": "*beta* describes how to do an on-cluster build.", 550 "x-intellij-html-description": "<em>beta</em> describes how to do an on-cluster build." 551 }, 552 "insecureRegistries": { 553 "items": { 554 "type": "string" 555 }, 556 "type": "array", 557 "description": "a list of registries declared by the user to be insecure. These registries will be connected to via HTTP instead of HTTPS.", 558 "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.", 559 "default": "[]" 560 }, 561 "tagPolicy": { 562 "$ref": "#/definitions/TagPolicy", 563 "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}`.", 564 "x-intellij-html-description": "<em>beta</em> 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 <code>gitCommit: {variant: Tags}</code>." 565 } 566 }, 567 "preferredOrder": [ 568 "artifacts", 569 "insecureRegistries", 570 "tagPolicy", 571 "cluster" 572 ], 573 "additionalProperties": false 574 } 575 ], 576 "description": "contains all the configuration for the build steps.", 577 "x-intellij-html-description": "contains all the configuration for the build steps." 578 }, 579 "BuildpackArtifact": { 580 "required": [ 581 "builder" 582 ], 583 "properties": { 584 "builder": { 585 "type": "string", 586 "description": "builder image used.", 587 "x-intellij-html-description": "builder image used." 588 }, 589 "buildpacks": { 590 "items": { 591 "type": "string" 592 }, 593 "type": "array", 594 "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.", 595 "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.", 596 "default": "[]" 597 }, 598 "dependencies": { 599 "$ref": "#/definitions/BuildpackDependencies", 600 "description": "file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact.", 601 "x-intellij-html-description": "file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact." 602 }, 603 "env": { 604 "items": { 605 "type": "string" 606 }, 607 "type": "array", 608 "description": "environment variables, in the `key=value` form, passed to the build. Values can use the go template syntax.", 609 "x-intellij-html-description": "environment variables, in the <code>key=value</code> form, passed to the build. Values can use the go template syntax.", 610 "default": "[]", 611 "examples": [ 612 "[\"key1=value1\", \"key2=value2\", \"key3={{.ENV_VARIABLE}}\"]" 613 ] 614 }, 615 "projectDescriptor": { 616 "type": "string", 617 "description": "path to the project descriptor file.", 618 "x-intellij-html-description": "path to the project descriptor file.", 619 "default": "project.toml" 620 }, 621 "runImage": { 622 "type": "string", 623 "description": "overrides the stack's default run image.", 624 "x-intellij-html-description": "overrides the stack's default run image." 625 }, 626 "trustBuilder": { 627 "type": "boolean", 628 "description": "indicates that the builder should be trusted.", 629 "x-intellij-html-description": "indicates that the builder should be trusted.", 630 "default": "false" 631 } 632 }, 633 "preferredOrder": [ 634 "builder", 635 "runImage", 636 "env", 637 "buildpacks", 638 "trustBuilder", 639 "projectDescriptor", 640 "dependencies" 641 ], 642 "additionalProperties": false, 643 "type": "object", 644 "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.", 645 "x-intellij-html-description": "<em>alpha</em> describes an artifact built using <a href=\"https://buildpacks.io/\">Cloud Native Buildpacks</a>. It can be used to build images out of project's sources without any additional configuration." 646 }, 647 "BuildpackDependencies": { 648 "properties": { 649 "ignore": { 650 "items": { 651 "type": "string" 652 }, 653 "type": "array", 654 "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`.", 655 "x-intellij-html-description": "specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both <code>paths</code> and in <code>ignore</code>, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with <code>paths</code>.", 656 "default": "[]" 657 }, 658 "paths": { 659 "items": { 660 "type": "string" 661 }, 662 "type": "array", 663 "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.", 664 "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.", 665 "default": "[]" 666 } 667 }, 668 "preferredOrder": [ 669 "paths", 670 "ignore" 671 ], 672 "additionalProperties": false, 673 "type": "object", 674 "description": "*alpha* used to specify dependencies for an artifact built by buildpacks.", 675 "x-intellij-html-description": "<em>alpha</em> used to specify dependencies for an artifact built by buildpacks." 676 }, 677 "ClusterDetails": { 678 "properties": { 679 "HTTPS_PROXY": { 680 "type": "string", 681 "description": "for kaniko pod.", 682 "x-intellij-html-description": "for kaniko pod." 683 }, 684 "HTTP_PROXY": { 685 "type": "string", 686 "description": "for kaniko pod.", 687 "x-intellij-html-description": "for kaniko pod." 688 }, 689 "annotations": { 690 "additionalProperties": { 691 "type": "string" 692 }, 693 "type": "object", 694 "description": "describes the Kubernetes annotations for the pod.", 695 "x-intellij-html-description": "describes the Kubernetes annotations for the pod.", 696 "default": "{}" 697 }, 698 "concurrency": { 699 "type": "integer", 700 "description": "how many artifacts can be built concurrently. 0 means \"no-limit\".", 701 "x-intellij-html-description": "how many artifacts can be built concurrently. 0 means "no-limit".", 702 "default": "0" 703 }, 704 "dockerConfig": { 705 "$ref": "#/definitions/DockerConfig", 706 "description": "describes how to mount the local Docker configuration into a pod.", 707 "x-intellij-html-description": "describes how to mount the local Docker configuration into a pod." 708 }, 709 "namespace": { 710 "type": "string", 711 "description": "Kubernetes namespace. Defaults to current namespace in Kubernetes configuration.", 712 "x-intellij-html-description": "Kubernetes namespace. Defaults to current namespace in Kubernetes configuration." 713 }, 714 "pullSecretMountPath": { 715 "type": "string", 716 "description": "path the pull secret will be mounted at within the running container.", 717 "x-intellij-html-description": "path the pull secret will be mounted at within the running container." 718 }, 719 "pullSecretName": { 720 "type": "string", 721 "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`.", 722 "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 <code>kaniko-secret</code>.", 723 "default": "kaniko-secret" 724 }, 725 "pullSecretPath": { 726 "type": "string", 727 "description": "path to the Google Cloud service account secret key file.", 728 "x-intellij-html-description": "path to the Google Cloud service account secret key file." 729 }, 730 "randomDockerConfigSecret": { 731 "type": "boolean", 732 "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.", 733 "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.", 734 "default": "false" 735 }, 736 "randomPullSecret": { 737 "type": "boolean", 738 "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.", 739 "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.", 740 "default": "false" 741 }, 742 "resources": { 743 "$ref": "#/definitions/ResourceRequirements", 744 "description": "define the resource requirements for the kaniko pod.", 745 "x-intellij-html-description": "define the resource requirements for the kaniko pod." 746 }, 747 "runAsUser": { 748 "type": "integer", 749 "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.", 750 "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." 751 }, 752 "serviceAccount": { 753 "type": "string", 754 "description": "describes the Kubernetes service account to use for the pod. Defaults to 'default'.", 755 "x-intellij-html-description": "describes the Kubernetes service account to use for the pod. Defaults to 'default'." 756 }, 757 "timeout": { 758 "type": "string", 759 "description": "amount of time (in seconds) that this build is allowed to run. Defaults to 20 minutes (`20m`).", 760 "x-intellij-html-description": "amount of time (in seconds) that this build is allowed to run. Defaults to 20 minutes (<code>20m</code>)." 761 }, 762 "tolerations": { 763 "items": {}, 764 "type": "array", 765 "description": "describes the Kubernetes tolerations for the pod.", 766 "x-intellij-html-description": "describes the Kubernetes tolerations for the pod.", 767 "default": "[]" 768 }, 769 "volumes": { 770 "items": {}, 771 "type": "array", 772 "description": "defines container mounts for ConfigMap and Secret resources.", 773 "x-intellij-html-description": "defines container mounts for ConfigMap and Secret resources.", 774 "default": "[]" 775 } 776 }, 777 "preferredOrder": [ 778 "HTTP_PROXY", 779 "HTTPS_PROXY", 780 "pullSecretPath", 781 "pullSecretName", 782 "pullSecretMountPath", 783 "namespace", 784 "timeout", 785 "dockerConfig", 786 "serviceAccount", 787 "tolerations", 788 "annotations", 789 "runAsUser", 790 "resources", 791 "concurrency", 792 "volumes", 793 "randomPullSecret", 794 "randomDockerConfigSecret" 795 ], 796 "additionalProperties": false, 797 "type": "object", 798 "description": "*beta* describes how to do an on-cluster build.", 799 "x-intellij-html-description": "<em>beta</em> describes how to do an on-cluster build." 800 }, 801 "ConfigDependency": { 802 "properties": { 803 "activeProfiles": { 804 "items": { 805 "$ref": "#/definitions/ProfileDependency" 806 }, 807 "type": "array", 808 "description": "describes the list of profiles to activate when resolving the required configs. These profiles must exist in the imported config.", 809 "x-intellij-html-description": "describes the list of profiles to activate when resolving the required configs. These profiles must exist in the imported config." 810 }, 811 "configs": { 812 "items": { 813 "type": "string" 814 }, 815 "type": "array", 816 "description": "describes the names of the required configs.", 817 "x-intellij-html-description": "describes the names of the required configs.", 818 "default": "[]" 819 }, 820 "path": { 821 "type": "string", 822 "description": "describes the path to the file containing the required configs.", 823 "x-intellij-html-description": "describes the path to the file containing the required configs." 824 } 825 }, 826 "preferredOrder": [ 827 "configs", 828 "path", 829 "activeProfiles" 830 ], 831 "additionalProperties": false, 832 "type": "object", 833 "description": "describes a dependency on another skaffold configuration.", 834 "x-intellij-html-description": "describes a dependency on another skaffold configuration." 835 }, 836 "CustomArtifact": { 837 "properties": { 838 "buildCommand": { 839 "type": "string", 840 "description": "command executed to build the image.", 841 "x-intellij-html-description": "command executed to build the image." 842 }, 843 "dependencies": { 844 "$ref": "#/definitions/CustomDependencies", 845 "description": "file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact.", 846 "x-intellij-html-description": "file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact." 847 } 848 }, 849 "preferredOrder": [ 850 "buildCommand", 851 "dependencies" 852 ], 853 "additionalProperties": false, 854 "type": "object", 855 "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.", 856 "x-intellij-html-description": "<em>beta</em> 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." 857 }, 858 "CustomDependencies": { 859 "properties": { 860 "command": { 861 "type": "string", 862 "description": "represents a custom command that skaffold executes to obtain dependencies. The output of this command *must* be a valid JSON array.", 863 "x-intellij-html-description": "represents a custom command that skaffold executes to obtain dependencies. The output of this command <em>must</em> be a valid JSON array." 864 }, 865 "dockerfile": { 866 "$ref": "#/definitions/DockerfileDependency", 867 "description": "should be set if the artifact is built from a Dockerfile, from which skaffold can determine dependencies.", 868 "x-intellij-html-description": "should be set if the artifact is built from a Dockerfile, from which skaffold can determine dependencies." 869 }, 870 "ignore": { 871 "items": { 872 "type": "string" 873 }, 874 "type": "array", 875 "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`.", 876 "x-intellij-html-description": "specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both <code>paths</code> and in <code>ignore</code>, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with <code>paths</code>.", 877 "default": "[]" 878 }, 879 "paths": { 880 "items": { 881 "type": "string" 882 }, 883 "type": "array", 884 "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.", 885 "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.", 886 "default": "[]" 887 } 888 }, 889 "preferredOrder": [ 890 "dockerfile", 891 "command", 892 "paths", 893 "ignore" 894 ], 895 "additionalProperties": false, 896 "type": "object", 897 "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.", 898 "x-intellij-html-description": "<em>beta</em> used to specify dependencies for an artifact built by a custom build script. Either <code>dockerfile</code> or <code>paths</code> should be specified for file watching to work as expected." 899 }, 900 "CustomTemplateTagger": { 901 "required": [ 902 "template" 903 ], 904 "properties": { 905 "components": { 906 "items": { 907 "$ref": "#/definitions/TaggerComponent" 908 }, 909 "type": "array", 910 "description": "TaggerComponents that the template (see field above) can be executed against.", 911 "x-intellij-html-description": "TaggerComponents that the template (see field above) can be executed against." 912 }, 913 "template": { 914 "type": "string", 915 "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.", 916 "x-intellij-html-description": "used to produce the image name and tag. See golang <a href=\"https://golang.org/pkg/text/template/\">text/template</a>. The template is executed against the provided components with those variables injected.", 917 "examples": [ 918 "{{.DATE}}" 919 ] 920 } 921 }, 922 "preferredOrder": [ 923 "template", 924 "components" 925 ], 926 "additionalProperties": false, 927 "type": "object", 928 "description": "*beta* tags images with a configurable template string.", 929 "x-intellij-html-description": "<em>beta</em> tags images with a configurable template string." 930 }, 931 "DateTimeTagger": { 932 "properties": { 933 "format": { 934 "type": "string", 935 "description": "formats the date and time. See [#Time.Format](https://golang.org/pkg/time/#Time.Format).", 936 "x-intellij-html-description": "formats the date and time. See <a href=\"https://golang.org/pkg/time/#Time.Format\">#Time.Format</a>.", 937 "default": "2006-01-02_15-04-05.999_MST" 938 }, 939 "timezone": { 940 "type": "string", 941 "description": "sets the timezone for the date and time. See [Time.LoadLocation](https://golang.org/pkg/time/#Time.LoadLocation). Defaults to the local timezone.", 942 "x-intellij-html-description": "sets the timezone for the date and time. See <a href=\"https://golang.org/pkg/time/#Time.LoadLocation\">Time.LoadLocation</a>. Defaults to the local timezone." 943 } 944 }, 945 "preferredOrder": [ 946 "format", 947 "timezone" 948 ], 949 "additionalProperties": false, 950 "type": "object", 951 "description": "*beta* tags images with the build timestamp.", 952 "x-intellij-html-description": "<em>beta</em> tags images with the build timestamp." 953 }, 954 "DeployConfig": { 955 "properties": { 956 "helm": { 957 "$ref": "#/definitions/HelmDeploy", 958 "description": "*beta* uses the `helm` CLI to apply the charts to the cluster.", 959 "x-intellij-html-description": "<em>beta</em> uses the <code>helm</code> CLI to apply the charts to the cluster." 960 }, 961 "kpt": { 962 "$ref": "#/definitions/KptDeploy", 963 "description": "*alpha* uses the `kpt` CLI to manage and deploy manifests.", 964 "x-intellij-html-description": "<em>alpha</em> uses the <code>kpt</code> CLI to manage and deploy manifests." 965 }, 966 "kubeContext": { 967 "type": "string", 968 "description": "Kubernetes context that Skaffold should deploy to.", 969 "x-intellij-html-description": "Kubernetes context that Skaffold should deploy to.", 970 "examples": [ 971 "minikube" 972 ] 973 }, 974 "kubectl": { 975 "$ref": "#/definitions/KubectlDeploy", 976 "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.", 977 "x-intellij-html-description": "<em>beta</em> uses a client side <code>kubectl apply</code> to deploy manifests. You'll need a <code>kubectl</code> CLI version installed that's compatible with your cluster." 978 }, 979 "kustomize": { 980 "$ref": "#/definitions/KustomizeDeploy", 981 "description": "*beta* uses the `kustomize` CLI to \"patch\" a deployment for a target environment.", 982 "x-intellij-html-description": "<em>beta</em> uses the <code>kustomize</code> CLI to "patch" a deployment for a target environment." 983 }, 984 "logs": { 985 "$ref": "#/definitions/LogsConfig", 986 "description": "configures how container logs are printed as a result of a deployment.", 987 "x-intellij-html-description": "configures how container logs are printed as a result of a deployment." 988 }, 989 "statusCheckDeadlineSeconds": { 990 "type": "integer", 991 "description": "*beta* deadline for deployments to stabilize in seconds.", 992 "x-intellij-html-description": "<em>beta</em> deadline for deployments to stabilize in seconds." 993 } 994 }, 995 "preferredOrder": [ 996 "helm", 997 "kpt", 998 "kubectl", 999 "kustomize", 1000 "statusCheckDeadlineSeconds", 1001 "kubeContext", 1002 "logs" 1003 ], 1004 "additionalProperties": false, 1005 "type": "object", 1006 "description": "contains all the configuration needed by the deploy steps.", 1007 "x-intellij-html-description": "contains all the configuration needed by the deploy steps." 1008 }, 1009 "DockerArtifact": { 1010 "properties": { 1011 "buildArgs": { 1012 "additionalProperties": { 1013 "type": "string" 1014 }, 1015 "type": "object", 1016 "description": "arguments passed to the docker build.", 1017 "x-intellij-html-description": "arguments passed to the docker build.", 1018 "default": "{}", 1019 "examples": [ 1020 "{\"key1\": \"value1\", \"key2\": \"value2\"}" 1021 ] 1022 }, 1023 "cacheFrom": { 1024 "items": { 1025 "type": "string" 1026 }, 1027 "type": "array", 1028 "description": "the Docker images used as cache sources.", 1029 "x-intellij-html-description": "the Docker images used as cache sources.", 1030 "default": "[]", 1031 "examples": [ 1032 "[\"golang:1.10.1-alpine3.7\", \"alpine:3.7\"]" 1033 ] 1034 }, 1035 "dockerfile": { 1036 "type": "string", 1037 "description": "locates the Dockerfile relative to workspace.", 1038 "x-intellij-html-description": "locates the Dockerfile relative to workspace.", 1039 "default": "Dockerfile" 1040 }, 1041 "network": { 1042 "type": "string", 1043 "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.", 1044 "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 <code>host</code>: use the host's networking stack. <code>bridge</code>: use the bridged network configuration. <code>container:<name|id></code>: reuse another container's network stack. <code>none</code>: no networking in the container.", 1045 "enum": [ 1046 "host", 1047 "bridge", 1048 "container:<name|id>", 1049 "none" 1050 ] 1051 }, 1052 "noCache": { 1053 "type": "boolean", 1054 "description": "used to pass in --no-cache to docker build to prevent caching.", 1055 "x-intellij-html-description": "used to pass in --no-cache to docker build to prevent caching.", 1056 "default": "false" 1057 }, 1058 "secret": { 1059 "$ref": "#/definitions/DockerSecret", 1060 "description": "contains information about a local secret passed to `docker build`, along with optional destination information.", 1061 "x-intellij-html-description": "contains information about a local secret passed to <code>docker build</code>, along with optional destination information." 1062 }, 1063 "squash": { 1064 "type": "boolean", 1065 "description": "used to pass in --squash to docker build to squash docker image layers into single layer.", 1066 "x-intellij-html-description": "used to pass in --squash to docker build to squash docker image layers into single layer.", 1067 "default": "false" 1068 }, 1069 "ssh": { 1070 "type": "string", 1071 "description": "used to pass in --ssh to docker build to use SSH agent. Format is \"default|<id>[=<socket>|<key>[,<key>]]\".", 1072 "x-intellij-html-description": "used to pass in --ssh to docker build to use SSH agent. Format is "default|<id>[=<socket>|<key>[,<key>]]"." 1073 }, 1074 "target": { 1075 "type": "string", 1076 "description": "Dockerfile target name to build.", 1077 "x-intellij-html-description": "Dockerfile target name to build." 1078 } 1079 }, 1080 "preferredOrder": [ 1081 "dockerfile", 1082 "target", 1083 "buildArgs", 1084 "network", 1085 "cacheFrom", 1086 "noCache", 1087 "squash", 1088 "secret", 1089 "ssh" 1090 ], 1091 "additionalProperties": false, 1092 "type": "object", 1093 "description": "describes an artifact built from a Dockerfile, usually using `docker build`.", 1094 "x-intellij-html-description": "describes an artifact built from a Dockerfile, usually using <code>docker build</code>." 1095 }, 1096 "DockerConfig": { 1097 "properties": { 1098 "path": { 1099 "type": "string", 1100 "description": "path to the docker `config.json`.", 1101 "x-intellij-html-description": "path to the docker <code>config.json</code>." 1102 }, 1103 "secretName": { 1104 "type": "string", 1105 "description": "Kubernetes secret that contains the `config.json` Docker configuration. Note that the expected secret type is not 'kubernetes.io/dockerconfigjson' but 'Opaque'.", 1106 "x-intellij-html-description": "Kubernetes secret that contains the <code>config.json</code> Docker configuration. Note that the expected secret type is not 'kubernetes.io/dockerconfigjson' but 'Opaque'." 1107 } 1108 }, 1109 "preferredOrder": [ 1110 "path", 1111 "secretName" 1112 ], 1113 "additionalProperties": false, 1114 "type": "object", 1115 "description": "contains information about the docker `config.json` to mount.", 1116 "x-intellij-html-description": "contains information about the docker <code>config.json</code> to mount." 1117 }, 1118 "DockerSecret": { 1119 "required": [ 1120 "id" 1121 ], 1122 "properties": { 1123 "dst": { 1124 "type": "string", 1125 "description": "path in the container to mount the secret.", 1126 "x-intellij-html-description": "path in the container to mount the secret." 1127 }, 1128 "id": { 1129 "type": "string", 1130 "description": "id of the secret.", 1131 "x-intellij-html-description": "id of the secret." 1132 }, 1133 "src": { 1134 "type": "string", 1135 "description": "path to the secret on the host machine.", 1136 "x-intellij-html-description": "path to the secret on the host machine." 1137 } 1138 }, 1139 "preferredOrder": [ 1140 "id", 1141 "src", 1142 "dst" 1143 ], 1144 "additionalProperties": false, 1145 "type": "object", 1146 "description": "contains information about a local secret passed to `docker build`, along with optional destination information.", 1147 "x-intellij-html-description": "contains information about a local secret passed to <code>docker build</code>, along with optional destination information." 1148 }, 1149 "DockerfileDependency": { 1150 "properties": { 1151 "buildArgs": { 1152 "additionalProperties": { 1153 "type": "string" 1154 }, 1155 "type": "object", 1156 "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.", 1157 "x-intellij-html-description": "key/value pairs used to resolve values of <code>ARG</code> instructions in a Dockerfile. Values can be constants or environment variables via the go template syntax.", 1158 "default": "{}", 1159 "examples": [ 1160 "{\"key1\": \"value1\", \"key2\": \"value2\", \"key3\": \"'{{.ENV_VARIABLE}}'\"}" 1161 ] 1162 }, 1163 "path": { 1164 "type": "string", 1165 "description": "locates the Dockerfile relative to workspace.", 1166 "x-intellij-html-description": "locates the Dockerfile relative to workspace." 1167 } 1168 }, 1169 "preferredOrder": [ 1170 "path", 1171 "buildArgs" 1172 ], 1173 "additionalProperties": false, 1174 "type": "object", 1175 "description": "*beta* used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile.", 1176 "x-intellij-html-description": "<em>beta</em> used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile." 1177 }, 1178 "EnvTemplateTagger": { 1179 "required": [ 1180 "template" 1181 ], 1182 "properties": { 1183 "template": { 1184 "type": "string", 1185 "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.", 1186 "x-intellij-html-description": "used to produce the image name and tag. See golang <a href=\"https://golang.org/pkg/text/template/\">text/template</a>. The template is executed against the current environment, with those variables injected.", 1187 "examples": [ 1188 "{{.RELEASE}}" 1189 ] 1190 } 1191 }, 1192 "preferredOrder": [ 1193 "template" 1194 ], 1195 "additionalProperties": false, 1196 "type": "object", 1197 "description": "*beta* tags images with a configurable template string.", 1198 "x-intellij-html-description": "<em>beta</em> tags images with a configurable template string." 1199 }, 1200 "GitTagger": { 1201 "properties": { 1202 "ignoreChanges": { 1203 "type": "boolean", 1204 "description": "specifies whether to omit the `-dirty` postfix if there are uncommitted changes.", 1205 "x-intellij-html-description": "specifies whether to omit the <code>-dirty</code> postfix if there are uncommitted changes.", 1206 "default": "false" 1207 }, 1208 "prefix": { 1209 "type": "string", 1210 "description": "adds a fixed prefix to the tag.", 1211 "x-intellij-html-description": "adds a fixed prefix to the tag." 1212 }, 1213 "variant": { 1214 "type": "string", 1215 "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.", 1216 "x-intellij-html-description": "determines the behavior of the git tagger. Valid variants are: <code>Tags</code> (default): use git tags or fall back to abbreviated commit hash. <code>CommitSha</code>: use the full git commit sha. <code>AbbrevCommitSha</code>: use the abbreviated git commit sha. <code>TreeSha</code>: use the full tree hash of the artifact workingdir. <code>AbbrevTreeSha</code>: use the abbreviated tree hash of the artifact workingdir.", 1217 "enum": [ 1218 "Tags", 1219 "CommitSha", 1220 "AbbrevCommitSha", 1221 "TreeSha", 1222 "AbbrevTreeSha" 1223 ] 1224 } 1225 }, 1226 "preferredOrder": [ 1227 "variant", 1228 "prefix", 1229 "ignoreChanges" 1230 ], 1231 "additionalProperties": false, 1232 "type": "object", 1233 "description": "*beta* tags images with the git tag or commit of the artifact's workspace.", 1234 "x-intellij-html-description": "<em>beta</em> tags images with the git tag or commit of the artifact's workspace." 1235 }, 1236 "GoogleCloudBuild": { 1237 "properties": { 1238 "concurrency": { 1239 "type": "integer", 1240 "description": "how many artifacts can be built concurrently. 0 means \"no-limit\".", 1241 "x-intellij-html-description": "how many artifacts can be built concurrently. 0 means "no-limit".", 1242 "default": "0" 1243 }, 1244 "diskSizeGb": { 1245 "type": "integer", 1246 "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).", 1247 "x-intellij-html-description": "disk size of the VM that runs the build. See <a href=\"https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions\">Cloud Build Reference</a>." 1248 }, 1249 "dockerImage": { 1250 "type": "string", 1251 "description": "image that runs a Docker build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", 1252 "x-intellij-html-description": "image that runs a Docker build. See <a href=\"https://cloud.google.com/cloud-build/docs/cloud-builders\">Cloud Builders</a>.", 1253 "default": "gcr.io/cloud-builders/docker" 1254 }, 1255 "gradleImage": { 1256 "type": "string", 1257 "description": "image that runs a Gradle build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", 1258 "x-intellij-html-description": "image that runs a Gradle build. See <a href=\"https://cloud.google.com/cloud-build/docs/cloud-builders\">Cloud Builders</a>.", 1259 "default": "gcr.io/cloud-builders/gradle" 1260 }, 1261 "kanikoImage": { 1262 "type": "string", 1263 "description": "image that runs a Kaniko build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", 1264 "x-intellij-html-description": "image that runs a Kaniko build. See <a href=\"https://cloud.google.com/cloud-build/docs/cloud-builders\">Cloud Builders</a>.", 1265 "default": "gcr.io/kaniko-project/executor" 1266 }, 1267 "logStreamingOption": { 1268 "type": "string", 1269 "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).", 1270 "x-intellij-html-description": "specifies the behavior when writing build logs to Google Cloud Storage. Valid options are: <code>STREAM_DEFAULT</code>: Service may automatically determine build log streaming behavior. <code>STREAM_ON</code>: Build logs should be streamed to Google Cloud Storage. <code>STREAM_OFF</code>: Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed. See <a href=\"https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#logstreamingoption\">Cloud Build Reference</a>.", 1271 "enum": [ 1272 "STREAM_DEFAULT", 1273 "STREAM_ON", 1274 "STREAM_OFF" 1275 ] 1276 }, 1277 "logging": { 1278 "type": "string", 1279 "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).", 1280 "x-intellij-html-description": "specifies the logging mode. Valid modes are: <code>LOGGING_UNSPECIFIED</code>: The service determines the logging mode. <code>LEGACY</code>: Stackdriver logging and Cloud Storage logging are enabled (default). <code>GCS_ONLY</code>: Only Cloud Storage logging is enabled. See <a href=\"https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#loggingmode\">Cloud Build Reference</a>.", 1281 "enum": [ 1282 "LOGGING_UNSPECIFIED", 1283 "LEGACY", 1284 "GCS_ONLY" 1285 ] 1286 }, 1287 "machineType": { 1288 "type": "string", 1289 "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).", 1290 "x-intellij-html-description": "type of the VM that runs the build. See <a href=\"https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions\">Cloud Build Reference</a>." 1291 }, 1292 "mavenImage": { 1293 "type": "string", 1294 "description": "image that runs a Maven build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", 1295 "x-intellij-html-description": "image that runs a Maven build. See <a href=\"https://cloud.google.com/cloud-build/docs/cloud-builders\">Cloud Builders</a>.", 1296 "default": "gcr.io/cloud-builders/mvn" 1297 }, 1298 "packImage": { 1299 "type": "string", 1300 "description": "image that runs a Cloud Native Buildpacks build. See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).", 1301 "x-intellij-html-description": "image that runs a Cloud Native Buildpacks build. See <a href=\"https://cloud.google.com/cloud-build/docs/cloud-builders\">Cloud Builders</a>.", 1302 "default": "gcr.io/k8s-skaffold/pack" 1303 }, 1304 "projectId": { 1305 "type": "string", 1306 "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.", 1307 "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 <code>gcr.io/myproject/image</code>, Skaffold will use the <code>myproject</code> GCP project." 1308 }, 1309 "timeout": { 1310 "type": "string", 1311 "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).", 1312 "x-intellij-html-description": "amount of time (in seconds) that this build should be allowed to run. See <a href=\"https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#resource-build\">Cloud Build Reference</a>." 1313 }, 1314 "workerPool": { 1315 "type": "string", 1316 "description": "configures a pool of workers to run the build.", 1317 "x-intellij-html-description": "configures a pool of workers to run the build." 1318 } 1319 }, 1320 "preferredOrder": [ 1321 "projectId", 1322 "diskSizeGb", 1323 "machineType", 1324 "timeout", 1325 "logging", 1326 "logStreamingOption", 1327 "dockerImage", 1328 "kanikoImage", 1329 "mavenImage", 1330 "gradleImage", 1331 "packImage", 1332 "concurrency", 1333 "workerPool" 1334 ], 1335 "additionalProperties": false, 1336 "type": "object", 1337 "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.", 1338 "x-intellij-html-description": "<em>beta</em> describes how to do a remote build on <a href=\"https://cloud.google.com/cloud-build/docs/\">Google Cloud Build</a>. Docker and Jib artifacts can be built on Cloud Build. The <code>projectId</code> needs to be provided and the currently logged in user should be given permissions to trigger new builds." 1339 }, 1340 "HelmConventionConfig": { 1341 "properties": { 1342 "explicitRegistry": { 1343 "type": "boolean", 1344 "description": "separates `image.registry` to the image config syntax. Useful for some charts e.g. `postgresql`.", 1345 "x-intellij-html-description": "separates <code>image.registry</code> to the image config syntax. Useful for some charts e.g. <code>postgresql</code>.", 1346 "default": "false" 1347 } 1348 }, 1349 "preferredOrder": [ 1350 "explicitRegistry" 1351 ], 1352 "additionalProperties": false, 1353 "type": "object", 1354 "description": "image config in the syntax of image.repository and image.tag.", 1355 "x-intellij-html-description": "image config in the syntax of image.repository and image.tag." 1356 }, 1357 "HelmDeploy": { 1358 "required": [ 1359 "releases" 1360 ], 1361 "properties": { 1362 "flags": { 1363 "$ref": "#/definitions/HelmDeployFlags", 1364 "description": "additional option flags that are passed on the command line to `helm`.", 1365 "x-intellij-html-description": "additional option flags that are passed on the command line to <code>helm</code>." 1366 }, 1367 "releases": { 1368 "items": { 1369 "$ref": "#/definitions/HelmRelease" 1370 }, 1371 "type": "array", 1372 "description": "a list of Helm releases.", 1373 "x-intellij-html-description": "a list of Helm releases." 1374 } 1375 }, 1376 "preferredOrder": [ 1377 "releases", 1378 "flags" 1379 ], 1380 "additionalProperties": false, 1381 "type": "object", 1382 "description": "*beta* uses the `helm` CLI to apply the charts to the cluster.", 1383 "x-intellij-html-description": "<em>beta</em> uses the <code>helm</code> CLI to apply the charts to the cluster." 1384 }, 1385 "HelmDeployFlags": { 1386 "properties": { 1387 "global": { 1388 "items": { 1389 "type": "string" 1390 }, 1391 "type": "array", 1392 "description": "additional flags passed on every command.", 1393 "x-intellij-html-description": "additional flags passed on every command.", 1394 "default": "[]" 1395 }, 1396 "install": { 1397 "items": { 1398 "type": "string" 1399 }, 1400 "type": "array", 1401 "description": "additional flags passed to (`helm install`).", 1402 "x-intellij-html-description": "additional flags passed to (<code>helm install</code>).", 1403 "default": "[]" 1404 }, 1405 "upgrade": { 1406 "items": { 1407 "type": "string" 1408 }, 1409 "type": "array", 1410 "description": "additional flags passed to (`helm upgrade`).", 1411 "x-intellij-html-description": "additional flags passed to (<code>helm upgrade</code>).", 1412 "default": "[]" 1413 } 1414 }, 1415 "preferredOrder": [ 1416 "global", 1417 "install", 1418 "upgrade" 1419 ], 1420 "additionalProperties": false, 1421 "type": "object", 1422 "description": "additional option flags that are passed on the command line to `helm`.", 1423 "x-intellij-html-description": "additional option flags that are passed on the command line to <code>helm</code>." 1424 }, 1425 "HelmFQNConfig": { 1426 "properties": { 1427 "property": { 1428 "type": "string", 1429 "description": "defines the image config.", 1430 "x-intellij-html-description": "defines the image config." 1431 } 1432 }, 1433 "preferredOrder": [ 1434 "property" 1435 ], 1436 "additionalProperties": false, 1437 "type": "object", 1438 "description": "image config to use the FullyQualifiedImageName as param to set.", 1439 "x-intellij-html-description": "image config to use the FullyQualifiedImageName as param to set." 1440 }, 1441 "HelmImageStrategy": { 1442 "type": "object", 1443 "anyOf": [ 1444 { 1445 "additionalProperties": false 1446 }, 1447 { 1448 "properties": { 1449 "fqn": { 1450 "$ref": "#/definitions/HelmFQNConfig", 1451 "description": "image configuration uses the syntax `IMAGE-NAME=IMAGE-REPOSITORY:IMAGE-TAG`.", 1452 "x-intellij-html-description": "image configuration uses the syntax <code>IMAGE-NAME=IMAGE-REPOSITORY:IMAGE-TAG</code>." 1453 } 1454 }, 1455 "preferredOrder": [ 1456 "fqn" 1457 ], 1458 "additionalProperties": false 1459 }, 1460 { 1461 "properties": { 1462 "helm": { 1463 "$ref": "#/definitions/HelmConventionConfig", 1464 "description": "image configuration uses the syntax `IMAGE-NAME.repository=IMAGE-REPOSITORY, IMAGE-NAME.tag=IMAGE-TAG`.", 1465 "x-intellij-html-description": "image configuration uses the syntax <code>IMAGE-NAME.repository=IMAGE-REPOSITORY, IMAGE-NAME.tag=IMAGE-TAG</code>." 1466 } 1467 }, 1468 "preferredOrder": [ 1469 "helm" 1470 ], 1471 "additionalProperties": false 1472 } 1473 ], 1474 "description": "adds image configurations to the Helm `values` file.", 1475 "x-intellij-html-description": "adds image configurations to the Helm <code>values</code> file." 1476 }, 1477 "HelmPackaged": { 1478 "properties": { 1479 "appVersion": { 1480 "type": "string", 1481 "description": "sets the `appVersion` on the chart to this version.", 1482 "x-intellij-html-description": "sets the <code>appVersion</code> on the chart to this version." 1483 }, 1484 "version": { 1485 "type": "string", 1486 "description": "sets the `version` on the chart to this semver version.", 1487 "x-intellij-html-description": "sets the <code>version</code> on the chart to this semver version." 1488 } 1489 }, 1490 "preferredOrder": [ 1491 "version", 1492 "appVersion" 1493 ], 1494 "additionalProperties": false, 1495 "type": "object", 1496 "description": "parameters for packaging helm chart (`helm package`).", 1497 "x-intellij-html-description": "parameters for packaging helm chart (<code>helm package</code>)." 1498 }, 1499 "HelmRelease": { 1500 "required": [ 1501 "name", 1502 "chartPath" 1503 ], 1504 "properties": { 1505 "artifactOverrides": { 1506 "description": "key value pairs where the key represents the parameter used in the `--set-string` Helm CLI flag to define a container image and the value corresponds to artifact i.e. `ImageName` defined in `Build.Artifacts` section. The resulting command-line is controlled by `ImageStrategy`.", 1507 "x-intellij-html-description": "key value pairs where the key represents the parameter used in the <code>--set-string</code> Helm CLI flag to define a container image and the value corresponds to artifact i.e. <code>ImageName</code> defined in <code>Build.Artifacts</code> section. The resulting command-line is controlled by <code>ImageStrategy</code>." 1508 }, 1509 "chartPath": { 1510 "type": "string", 1511 "description": "path to the Helm chart.", 1512 "x-intellij-html-description": "path to the Helm chart." 1513 }, 1514 "createNamespace": { 1515 "type": "boolean", 1516 "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`.", 1517 "x-intellij-html-description": "if <code>true</code>, Skaffold will send <code>--create-namespace</code> flag to Helm CLI. <code>--create-namespace</code> flag is available in Helm since version 3.2. Defaults is <code>false</code>." 1518 }, 1519 "imageStrategy": { 1520 "$ref": "#/definitions/HelmImageStrategy", 1521 "description": "controls how an `ArtifactOverrides` entry is turned into `--set-string` Helm CLI flag or flags.", 1522 "x-intellij-html-description": "controls how an <code>ArtifactOverrides</code> entry is turned into <code>--set-string</code> Helm CLI flag or flags." 1523 }, 1524 "name": { 1525 "type": "string", 1526 "description": "name of the Helm release. It accepts environment variables via the go template syntax.", 1527 "x-intellij-html-description": "name of the Helm release. It accepts environment variables via the go template syntax." 1528 }, 1529 "namespace": { 1530 "type": "string", 1531 "description": "Kubernetes namespace.", 1532 "x-intellij-html-description": "Kubernetes namespace." 1533 }, 1534 "overrides": { 1535 "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).", 1536 "x-intellij-html-description": "key-value pairs. If present, Skaffold will build a Helm <code>values</code> file that overrides the original and use it to call Helm CLI (<code>--f</code> flag)." 1537 }, 1538 "packaged": { 1539 "$ref": "#/definitions/HelmPackaged", 1540 "description": "parameters for packaging helm chart (`helm package`).", 1541 "x-intellij-html-description": "parameters for packaging helm chart (<code>helm package</code>)." 1542 }, 1543 "recreatePods": { 1544 "type": "boolean", 1545 "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.", 1546 "x-intellij-html-description": "if <code>true</code>, Skaffold will send <code>--recreate-pods</code> flag to Helm CLI when upgrading a new version of a chart in subsequent dev loop deploy.", 1547 "default": "false" 1548 }, 1549 "remote": { 1550 "type": "boolean", 1551 "description": "specifies whether the chart path is remote, or exists on the host filesystem.", 1552 "x-intellij-html-description": "specifies whether the chart path is remote, or exists on the host filesystem.", 1553 "default": "false" 1554 }, 1555 "setFiles": { 1556 "additionalProperties": { 1557 "type": "string" 1558 }, 1559 "type": "object", 1560 "description": "key-value pairs. If present, Skaffold will send `--set-file` flag to Helm CLI and append all pairs after the flag.", 1561 "x-intellij-html-description": "key-value pairs. If present, Skaffold will send <code>--set-file</code> flag to Helm CLI and append all pairs after the flag.", 1562 "default": "{}" 1563 }, 1564 "setValueTemplates": { 1565 "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.", 1566 "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 <code>--set</code> flag to Helm CLI and append all parsed pairs after the flag." 1567 }, 1568 "setValues": { 1569 "description": "key-value pairs. If present, Skaffold will send `--set` flag to Helm CLI and append all pairs after the flag.", 1570 "x-intellij-html-description": "key-value pairs. If present, Skaffold will send <code>--set</code> flag to Helm CLI and append all pairs after the flag." 1571 }, 1572 "skipBuildDependencies": { 1573 "type": "boolean", 1574 "description": "should build dependencies be skipped. Ignored when `remote: true`.", 1575 "x-intellij-html-description": "should build dependencies be skipped. Ignored when <code>remote: true</code>.", 1576 "default": "false" 1577 }, 1578 "upgradeOnChange": { 1579 "type": "boolean", 1580 "description": "specifies whether to upgrade helm chart on code changes. Default is `true` when helm chart is local (`remote: false`). Default is `false` if `remote: true`.", 1581 "x-intellij-html-description": "specifies whether to upgrade helm chart on code changes. Default is <code>true</code> when helm chart is local (<code>remote: false</code>). Default is <code>false</code> if <code>remote: true</code>." 1582 }, 1583 "useHelmSecrets": { 1584 "type": "boolean", 1585 "description": "instructs skaffold to use secrets plugin on deployment.", 1586 "x-intellij-html-description": "instructs skaffold to use secrets plugin on deployment.", 1587 "default": "false" 1588 }, 1589 "valuesFiles": { 1590 "items": { 1591 "type": "string" 1592 }, 1593 "type": "array", 1594 "description": "paths to the Helm `values` files.", 1595 "x-intellij-html-description": "paths to the Helm <code>values</code> files.", 1596 "default": "[]" 1597 }, 1598 "version": { 1599 "type": "string", 1600 "description": "version of the chart.", 1601 "x-intellij-html-description": "version of the chart." 1602 }, 1603 "wait": { 1604 "type": "boolean", 1605 "description": "if `true`, Skaffold will send `--wait` flag to Helm CLI.", 1606 "x-intellij-html-description": "if <code>true</code>, Skaffold will send <code>--wait</code> flag to Helm CLI.", 1607 "default": "false" 1608 } 1609 }, 1610 "preferredOrder": [ 1611 "name", 1612 "chartPath", 1613 "valuesFiles", 1614 "artifactOverrides", 1615 "namespace", 1616 "version", 1617 "setValues", 1618 "setValueTemplates", 1619 "setFiles", 1620 "createNamespace", 1621 "wait", 1622 "recreatePods", 1623 "skipBuildDependencies", 1624 "useHelmSecrets", 1625 "remote", 1626 "upgradeOnChange", 1627 "overrides", 1628 "packaged", 1629 "imageStrategy" 1630 ], 1631 "additionalProperties": false, 1632 "type": "object", 1633 "description": "describes a helm release to be deployed.", 1634 "x-intellij-html-description": "describes a helm release to be deployed." 1635 }, 1636 "JSONPatch": { 1637 "required": [ 1638 "path" 1639 ], 1640 "properties": { 1641 "from": { 1642 "type": "string", 1643 "description": "source position in the yaml, used for `copy` or `move` operations.", 1644 "x-intellij-html-description": "source position in the yaml, used for <code>copy</code> or <code>move</code> operations." 1645 }, 1646 "op": { 1647 "type": "string", 1648 "description": "operation carried by the patch: `add`, `remove`, `replace`, `move`, `copy` or `test`.", 1649 "x-intellij-html-description": "operation carried by the patch: <code>add</code>, <code>remove</code>, <code>replace</code>, <code>move</code>, <code>copy</code> or <code>test</code>.", 1650 "default": "replace" 1651 }, 1652 "path": { 1653 "type": "string", 1654 "description": "position in the yaml where the operation takes place. For example, this targets the `dockerfile` of the first artifact built.", 1655 "x-intellij-html-description": "position in the yaml where the operation takes place. For example, this targets the <code>dockerfile</code> of the first artifact built.", 1656 "examples": [ 1657 "/build/artifacts/0/docker/dockerfile" 1658 ] 1659 }, 1660 "value": { 1661 "description": "value to apply. Can be any portion of yaml.", 1662 "x-intellij-html-description": "value to apply. Can be any portion of yaml." 1663 } 1664 }, 1665 "preferredOrder": [ 1666 "op", 1667 "path", 1668 "from", 1669 "value" 1670 ], 1671 "additionalProperties": false, 1672 "type": "object", 1673 "description": "patch to be applied by a profile.", 1674 "x-intellij-html-description": "patch to be applied by a profile." 1675 }, 1676 "JibArtifact": { 1677 "properties": { 1678 "args": { 1679 "items": { 1680 "type": "string" 1681 }, 1682 "type": "array", 1683 "description": "additional build flags passed to the builder.", 1684 "x-intellij-html-description": "additional build flags passed to the builder.", 1685 "default": "[]", 1686 "examples": [ 1687 "[\"--no-build-cache\"]" 1688 ] 1689 }, 1690 "fromImage": { 1691 "type": "string", 1692 "description": "overrides the configured jib base image.", 1693 "x-intellij-html-description": "overrides the configured jib base image." 1694 }, 1695 "project": { 1696 "type": "string", 1697 "description": "selects which sub-project to build for multi-module builds.", 1698 "x-intellij-html-description": "selects which sub-project to build for multi-module builds." 1699 }, 1700 "type": { 1701 "type": "string", 1702 "description": "the Jib builder type; normally determined automatically. Valid types are `maven`: for Maven. `gradle`: for Gradle.", 1703 "x-intellij-html-description": "the Jib builder type; normally determined automatically. Valid types are <code>maven</code>: for Maven. <code>gradle</code>: for Gradle.", 1704 "enum": [ 1705 "maven", 1706 "gradle" 1707 ] 1708 } 1709 }, 1710 "preferredOrder": [ 1711 "project", 1712 "args", 1713 "type", 1714 "fromImage" 1715 ], 1716 "additionalProperties": false, 1717 "type": "object", 1718 "description": "builds images using the [Jib plugins for Maven and Gradle](https://github.com/GoogleContainerTools/jib/).", 1719 "x-intellij-html-description": "builds images using the <a href=\"https://github.com/GoogleContainerTools/jib/\">Jib plugins for Maven and Gradle</a>." 1720 }, 1721 "KanikoArtifact": { 1722 "properties": { 1723 "buildArgs": { 1724 "additionalProperties": { 1725 "type": "string" 1726 }, 1727 "type": "object", 1728 "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.", 1729 "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: IMAGE<em>REPO, IMAGE</em>NAME, IMAGE_TAG.", 1730 "default": "{}", 1731 "examples": [ 1732 "{\"key1\": \"value1\", \"key2\": \"value2\", \"key3\": \"'{{.ENV_VARIABLE}}'\"}" 1733 ] 1734 }, 1735 "cache": { 1736 "$ref": "#/definitions/KanikoCache", 1737 "description": "configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds.", 1738 "x-intellij-html-description": "configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds." 1739 }, 1740 "cleanup": { 1741 "type": "boolean", 1742 "description": "to clean the filesystem at the end of the build.", 1743 "x-intellij-html-description": "to clean the filesystem at the end of the build.", 1744 "default": "false" 1745 }, 1746 "digestFile": { 1747 "type": "string", 1748 "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.", 1749 "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." 1750 }, 1751 "dockerfile": { 1752 "type": "string", 1753 "description": "locates the Dockerfile relative to workspace.", 1754 "x-intellij-html-description": "locates the Dockerfile relative to workspace.", 1755 "default": "Dockerfile" 1756 }, 1757 "env": { 1758 "items": {}, 1759 "type": "array", 1760 "description": "environment variables passed to the kaniko pod. It also accepts environment variables via the go template syntax.", 1761 "x-intellij-html-description": "environment variables passed to the kaniko pod. It also accepts environment variables via the go template syntax.", 1762 "default": "[]", 1763 "examples": [ 1764 "[{\"name\": \"key1\", \"value\": \"value1\"}, {\"name\": \"key2\", \"value\": \"value2\"}, {\"name\": \"key3\", \"value\": \"'{{.ENV_VARIABLE}}'\"}]" 1765 ] 1766 }, 1767 "force": { 1768 "type": "boolean", 1769 "description": "building outside of a container.", 1770 "x-intellij-html-description": "building outside of a container.", 1771 "default": "false" 1772 }, 1773 "image": { 1774 "type": "string", 1775 "description": "Docker image used by the Kaniko pod. Defaults to the latest released version of `gcr.io/kaniko-project/executor`.", 1776 "x-intellij-html-description": "Docker image used by the Kaniko pod. Defaults to the latest released version of <code>gcr.io/kaniko-project/executor</code>." 1777 }, 1778 "imageNameWithDigestFile": { 1779 "type": "string", 1780 "description": "specify a file to save the image name with digest of the built image to.", 1781 "x-intellij-html-description": "specify a file to save the image name with digest of the built image to." 1782 }, 1783 "initImage": { 1784 "type": "string", 1785 "description": "image used to run init container which mounts kaniko context.", 1786 "x-intellij-html-description": "image used to run init container which mounts kaniko context." 1787 }, 1788 "insecure": { 1789 "type": "boolean", 1790 "description": "if you want to push images to a plain HTTP registry.", 1791 "x-intellij-html-description": "if you want to push images to a plain HTTP registry.", 1792 "default": "false" 1793 }, 1794 "insecurePull": { 1795 "type": "boolean", 1796 "description": "if you want to pull images from a plain HTTP registry.", 1797 "x-intellij-html-description": "if you want to pull images from a plain HTTP registry.", 1798 "default": "false" 1799 }, 1800 "insecureRegistry": { 1801 "items": { 1802 "type": "string" 1803 }, 1804 "type": "array", 1805 "description": "to use plain HTTP requests when accessing a registry.", 1806 "x-intellij-html-description": "to use plain HTTP requests when accessing a registry.", 1807 "default": "[]" 1808 }, 1809 "label": { 1810 "additionalProperties": { 1811 "type": "string" 1812 }, 1813 "type": "object", 1814 "description": "key: value to set some metadata to the final image. This is equivalent as using the LABEL within the Dockerfile.", 1815 "x-intellij-html-description": "key: value to set some metadata to the final image. This is equivalent as using the LABEL within the Dockerfile.", 1816 "default": "{}" 1817 }, 1818 "logFormat": { 1819 "type": "string", 1820 "description": "<text|color|json> to set the log format.", 1821 "x-intellij-html-description": "<text|color|json> to set the log format." 1822 }, 1823 "logTimestamp": { 1824 "type": "boolean", 1825 "description": "to add timestamps to log format.", 1826 "x-intellij-html-description": "to add timestamps to log format.", 1827 "default": "false" 1828 }, 1829 "noPush": { 1830 "type": "boolean", 1831 "description": "if you only want to build the image, without pushing to a registry.", 1832 "x-intellij-html-description": "if you only want to build the image, without pushing to a registry.", 1833 "default": "false" 1834 }, 1835 "ociLayoutPath": { 1836 "type": "string", 1837 "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.", 1838 "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." 1839 }, 1840 "registryCertificate": { 1841 "additionalProperties": { 1842 "type": "string" 1843 }, 1844 "type": "object", 1845 "description": "to provide a certificate for TLS communication with a given registry. my.registry.url: /path/to/the/certificate.cert is the expected format.", 1846 "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.", 1847 "default": "{}" 1848 }, 1849 "registryMirror": { 1850 "type": "string", 1851 "description": "if you want to use a registry mirror instead of default `index.docker.io`.", 1852 "x-intellij-html-description": "if you want to use a registry mirror instead of default <code>index.docker.io</code>." 1853 }, 1854 "reproducible": { 1855 "type": "boolean", 1856 "description": "used to strip timestamps out of the built image.", 1857 "x-intellij-html-description": "used to strip timestamps out of the built image.", 1858 "default": "false" 1859 }, 1860 "singleSnapshot": { 1861 "type": "boolean", 1862 "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.", 1863 "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.", 1864 "default": "false" 1865 }, 1866 "skipTLS": { 1867 "type": "boolean", 1868 "description": "skips TLS certificate validation when pushing to a registry.", 1869 "x-intellij-html-description": "skips TLS certificate validation when pushing to a registry.", 1870 "default": "false" 1871 }, 1872 "skipTLSVerifyPull": { 1873 "type": "boolean", 1874 "description": "skips TLS certificate validation when pulling from a registry.", 1875 "x-intellij-html-description": "skips TLS certificate validation when pulling from a registry.", 1876 "default": "false" 1877 }, 1878 "skipTLSVerifyRegistry": { 1879 "items": { 1880 "type": "string" 1881 }, 1882 "type": "array", 1883 "description": "skips TLS certificate validation when accessing a registry.", 1884 "x-intellij-html-description": "skips TLS certificate validation when accessing a registry.", 1885 "default": "[]" 1886 }, 1887 "skipUnusedStages": { 1888 "type": "boolean", 1889 "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.", 1890 "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.", 1891 "default": "false" 1892 }, 1893 "snapshotMode": { 1894 "type": "string", 1895 "description": "how Kaniko will snapshot the filesystem.", 1896 "x-intellij-html-description": "how Kaniko will snapshot the filesystem." 1897 }, 1898 "tarPath": { 1899 "type": "string", 1900 "description": "path to save the image as a tarball at path instead of pushing the image.", 1901 "x-intellij-html-description": "path to save the image as a tarball at path instead of pushing the image." 1902 }, 1903 "target": { 1904 "type": "string", 1905 "description": "to indicate which build stage is the target build stage.", 1906 "x-intellij-html-description": "to indicate which build stage is the target build stage." 1907 }, 1908 "useNewRun": { 1909 "type": "boolean", 1910 "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%.", 1911 "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%.", 1912 "default": "false" 1913 }, 1914 "verbosity": { 1915 "type": "string", 1916 "description": "<panic|fatal|error|warn|info|debug|trace> to set the logging level.", 1917 "x-intellij-html-description": "<panic|fatal|error|warn|info|debug|trace> to set the logging level." 1918 }, 1919 "volumeMounts": { 1920 "items": {}, 1921 "type": "array", 1922 "description": "volume mounts passed to kaniko pod.", 1923 "x-intellij-html-description": "volume mounts passed to kaniko pod.", 1924 "default": "[]" 1925 }, 1926 "whitelistVarRun": { 1927 "type": "boolean", 1928 "description": "used to ignore `/var/run` when taking image snapshot. Set it to false to preserve /var/run/* in destination image.", 1929 "x-intellij-html-description": "used to ignore <code>/var/run</code> when taking image snapshot. Set it to false to preserve /var/run/* in destination image.", 1930 "default": "false" 1931 } 1932 }, 1933 "preferredOrder": [ 1934 "cleanup", 1935 "insecure", 1936 "insecurePull", 1937 "noPush", 1938 "force", 1939 "logTimestamp", 1940 "reproducible", 1941 "singleSnapshot", 1942 "skipTLS", 1943 "skipTLSVerifyPull", 1944 "skipUnusedStages", 1945 "useNewRun", 1946 "whitelistVarRun", 1947 "dockerfile", 1948 "target", 1949 "initImage", 1950 "image", 1951 "digestFile", 1952 "imageNameWithDigestFile", 1953 "logFormat", 1954 "ociLayoutPath", 1955 "registryMirror", 1956 "snapshotMode", 1957 "tarPath", 1958 "verbosity", 1959 "insecureRegistry", 1960 "skipTLSVerifyRegistry", 1961 "env", 1962 "cache", 1963 "registryCertificate", 1964 "label", 1965 "buildArgs", 1966 "volumeMounts" 1967 ], 1968 "additionalProperties": false, 1969 "type": "object", 1970 "description": "describes an artifact built from a Dockerfile, with kaniko.", 1971 "x-intellij-html-description": "describes an artifact built from a Dockerfile, with kaniko." 1972 }, 1973 "KanikoCache": { 1974 "properties": { 1975 "hostPath": { 1976 "type": "string", 1977 "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.", 1978 "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." 1979 }, 1980 "repo": { 1981 "type": "string", 1982 "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).", 1983 "x-intellij-html-description": "a remote repository to store cached layers. If none is specified, one will be inferred from the image name. See <a href=\"https://github.com/GoogleContainerTools/kaniko#caching\">Kaniko Caching</a>." 1984 }, 1985 "ttl": { 1986 "type": "string", 1987 "description": "Cache timeout in hours.", 1988 "x-intellij-html-description": "Cache timeout in hours." 1989 } 1990 }, 1991 "preferredOrder": [ 1992 "repo", 1993 "hostPath", 1994 "ttl" 1995 ], 1996 "additionalProperties": false, 1997 "type": "object", 1998 "description": "configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds.", 1999 "x-intellij-html-description": "configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds." 2000 }, 2001 "KptApplyInventory": { 2002 "properties": { 2003 "dir": { 2004 "type": "string", 2005 "description": "equivalent to the dir in `kpt live apply <dir>`. If not provided, kpt deployer will create a hidden directory `.kpt-hydrated` to store the manipulated resource output and the kpt inventory-template.yaml file.", 2006 "x-intellij-html-description": "equivalent to the dir in <code>kpt live apply <dir></code>. If not provided, kpt deployer will create a hidden directory <code>.kpt-hydrated</code> to store the manipulated resource output and the kpt inventory-template.yaml file." 2007 }, 2008 "inventoryID": { 2009 "type": "string", 2010 "description": "*alpha* identifier for a group of applied resources. This value is only needed when the `kpt live` is working on a pre-applied cluster resources.", 2011 "x-intellij-html-description": "<em>alpha</em> identifier for a group of applied resources. This value is only needed when the <code>kpt live</code> is working on a pre-applied cluster resources." 2012 }, 2013 "inventoryNamespace": { 2014 "type": "string", 2015 "description": "*alpha* sets the inventory namespace.", 2016 "x-intellij-html-description": "<em>alpha</em> sets the inventory namespace." 2017 } 2018 }, 2019 "preferredOrder": [ 2020 "dir", 2021 "inventoryID", 2022 "inventoryNamespace" 2023 ], 2024 "additionalProperties": false, 2025 "type": "object", 2026 "description": "sets the kpt inventory directory.", 2027 "x-intellij-html-description": "sets the kpt inventory directory." 2028 }, 2029 "KptApplyOptions": { 2030 "properties": { 2031 "pollPeriod": { 2032 "type": "string", 2033 "description": "sets for the polling period for resource statuses. Default to 2s.", 2034 "x-intellij-html-description": "sets for the polling period for resource statuses. Default to 2s." 2035 }, 2036 "prunePropagationPolicy": { 2037 "type": "string", 2038 "description": "sets the propagation policy for pruning. Possible settings are Background, Foreground, Orphan. Default to \"Background\".", 2039 "x-intellij-html-description": "sets the propagation policy for pruning. Possible settings are Background, Foreground, Orphan. Default to "Background"." 2040 }, 2041 "pruneTimeout": { 2042 "type": "string", 2043 "description": "sets the time threshold to wait for all pruned resources to be deleted.", 2044 "x-intellij-html-description": "sets the time threshold to wait for all pruned resources to be deleted." 2045 }, 2046 "reconcileTimeout": { 2047 "type": "string", 2048 "description": "sets the time threshold to wait for all resources to reach the current status.", 2049 "x-intellij-html-description": "sets the time threshold to wait for all resources to reach the current status." 2050 } 2051 }, 2052 "preferredOrder": [ 2053 "pollPeriod", 2054 "prunePropagationPolicy", 2055 "pruneTimeout", 2056 "reconcileTimeout" 2057 ], 2058 "additionalProperties": false, 2059 "type": "object", 2060 "description": "adds additional configurations used when calling `kpt live apply`.", 2061 "x-intellij-html-description": "adds additional configurations used when calling <code>kpt live apply</code>." 2062 }, 2063 "KptDeploy": { 2064 "required": [ 2065 "dir" 2066 ], 2067 "properties": { 2068 "dir": { 2069 "type": "string", 2070 "description": "path to the config directory (Required). By default, the Dir contains the application configurations, [kustomize config files](https://kubectl.docs.kubernetes.io/pages/examples/kustomize.html) and [declarative kpt functions](https://googlecontainertools.github.io/kpt/guides/consumer/function/#declarative-run).", 2071 "x-intellij-html-description": "path to the config directory (Required). By default, the Dir contains the application configurations, <a href=\"https://kubectl.docs.kubernetes.io/pages/examples/kustomize.html\">kustomize config files</a> and <a href=\"https://googlecontainertools.github.io/kpt/guides/consumer/function/#declarative-run\">declarative kpt functions</a>." 2072 }, 2073 "fn": { 2074 "$ref": "#/definitions/KptFn", 2075 "description": "adds additional configurations for `kpt fn`.", 2076 "x-intellij-html-description": "adds additional configurations for <code>kpt fn</code>." 2077 }, 2078 "live": { 2079 "$ref": "#/definitions/KptLive", 2080 "description": "adds additional configurations for `kpt live`.", 2081 "x-intellij-html-description": "adds additional configurations for <code>kpt live</code>." 2082 } 2083 }, 2084 "preferredOrder": [ 2085 "dir", 2086 "fn", 2087 "live" 2088 ], 2089 "additionalProperties": false, 2090 "type": "object", 2091 "description": "*alpha* uses the `kpt` CLI to manage and deploy manifests.", 2092 "x-intellij-html-description": "<em>alpha</em> uses the <code>kpt</code> CLI to manage and deploy manifests." 2093 }, 2094 "KptFn": { 2095 "properties": { 2096 "fnPath": { 2097 "type": "string", 2098 "description": "directory to discover the declarative kpt functions. If not provided, kpt deployer uses `kpt.Dir`.", 2099 "x-intellij-html-description": "directory to discover the declarative kpt functions. If not provided, kpt deployer uses <code>kpt.Dir</code>." 2100 }, 2101 "globalScope": { 2102 "type": "boolean", 2103 "description": "sets the global scope for the kpt functions. see `kpt help fn run`.", 2104 "x-intellij-html-description": "sets the global scope for the kpt functions. see <code>kpt help fn run</code>.", 2105 "default": "false" 2106 }, 2107 "image": { 2108 "type": "string", 2109 "description": "a kpt function image to run the configs imperatively. If provided, kpt.fn.fnPath will be ignored.", 2110 "x-intellij-html-description": "a kpt function image to run the configs imperatively. If provided, kpt.fn.fnPath will be ignored." 2111 }, 2112 "mount": { 2113 "items": { 2114 "type": "string" 2115 }, 2116 "type": "array", 2117 "description": "a list of storage options to mount to the fn image.", 2118 "x-intellij-html-description": "a list of storage options to mount to the fn image.", 2119 "default": "[]" 2120 }, 2121 "network": { 2122 "type": "boolean", 2123 "description": "enables network access for the kpt function containers.", 2124 "x-intellij-html-description": "enables network access for the kpt function containers.", 2125 "default": "false" 2126 }, 2127 "networkName": { 2128 "type": "string", 2129 "description": "docker network name to run the kpt function containers (default \"bridge\").", 2130 "x-intellij-html-description": "docker network name to run the kpt function containers (default "bridge")." 2131 }, 2132 "sinkDir": { 2133 "type": "string", 2134 "description": "directory to where the manipulated resource output is stored.", 2135 "x-intellij-html-description": "directory to where the manipulated resource output is stored." 2136 } 2137 }, 2138 "preferredOrder": [ 2139 "fnPath", 2140 "image", 2141 "networkName", 2142 "globalScope", 2143 "network", 2144 "mount", 2145 "sinkDir" 2146 ], 2147 "additionalProperties": false, 2148 "type": "object", 2149 "description": "adds additional configurations used when calling `kpt fn`.", 2150 "x-intellij-html-description": "adds additional configurations used when calling <code>kpt fn</code>." 2151 }, 2152 "KptLive": { 2153 "properties": { 2154 "apply": { 2155 "$ref": "#/definitions/KptApplyInventory", 2156 "description": "sets the kpt inventory directory.", 2157 "x-intellij-html-description": "sets the kpt inventory directory." 2158 }, 2159 "options": { 2160 "$ref": "#/definitions/KptApplyOptions", 2161 "description": "adds additional configurations for `kpt live apply` commands.", 2162 "x-intellij-html-description": "adds additional configurations for <code>kpt live apply</code> commands." 2163 } 2164 }, 2165 "preferredOrder": [ 2166 "apply", 2167 "options" 2168 ], 2169 "additionalProperties": false, 2170 "type": "object", 2171 "description": "adds additional configurations used when calling `kpt live`.", 2172 "x-intellij-html-description": "adds additional configurations used when calling <code>kpt live</code>." 2173 }, 2174 "KubectlDeploy": { 2175 "properties": { 2176 "defaultNamespace": { 2177 "type": "string", 2178 "description": "default namespace passed to kubectl on deployment if no other override is given.", 2179 "x-intellij-html-description": "default namespace passed to kubectl on deployment if no other override is given." 2180 }, 2181 "flags": { 2182 "$ref": "#/definitions/KubectlFlags", 2183 "description": "additional flags passed to `kubectl`.", 2184 "x-intellij-html-description": "additional flags passed to <code>kubectl</code>." 2185 }, 2186 "manifests": { 2187 "items": { 2188 "type": "string" 2189 }, 2190 "type": "array", 2191 "description": "the Kubernetes yaml or json manifests.", 2192 "x-intellij-html-description": "the Kubernetes yaml or json manifests.", 2193 "default": "[\"k8s/*.yaml\"]" 2194 }, 2195 "remoteManifests": { 2196 "items": { 2197 "type": "string" 2198 }, 2199 "type": "array", 2200 "description": "Kubernetes manifests in remote clusters.", 2201 "x-intellij-html-description": "Kubernetes manifests in remote clusters.", 2202 "default": "[]" 2203 } 2204 }, 2205 "preferredOrder": [ 2206 "manifests", 2207 "remoteManifests", 2208 "flags", 2209 "defaultNamespace" 2210 ], 2211 "additionalProperties": false, 2212 "type": "object", 2213 "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.", 2214 "x-intellij-html-description": "<em>beta</em> uses a client side <code>kubectl apply</code> to deploy manifests. You'll need a <code>kubectl</code> CLI version installed that's compatible with your cluster." 2215 }, 2216 "KubectlFlags": { 2217 "properties": { 2218 "apply": { 2219 "items": { 2220 "type": "string" 2221 }, 2222 "type": "array", 2223 "description": "additional flags passed on creations (`kubectl apply`).", 2224 "x-intellij-html-description": "additional flags passed on creations (<code>kubectl apply</code>).", 2225 "default": "[]" 2226 }, 2227 "delete": { 2228 "items": { 2229 "type": "string" 2230 }, 2231 "type": "array", 2232 "description": "additional flags passed on deletions (`kubectl delete`).", 2233 "x-intellij-html-description": "additional flags passed on deletions (<code>kubectl delete</code>).", 2234 "default": "[]" 2235 }, 2236 "disableValidation": { 2237 "type": "boolean", 2238 "description": "passes the `--validate=false` flag to supported `kubectl` commands when enabled.", 2239 "x-intellij-html-description": "passes the <code>--validate=false</code> flag to supported <code>kubectl</code> commands when enabled.", 2240 "default": "false" 2241 }, 2242 "global": { 2243 "items": { 2244 "type": "string" 2245 }, 2246 "type": "array", 2247 "description": "additional flags passed on every command.", 2248 "x-intellij-html-description": "additional flags passed on every command.", 2249 "default": "[]" 2250 } 2251 }, 2252 "preferredOrder": [ 2253 "global", 2254 "apply", 2255 "delete", 2256 "disableValidation" 2257 ], 2258 "additionalProperties": false, 2259 "type": "object", 2260 "description": "additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).", 2261 "x-intellij-html-description": "additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete)." 2262 }, 2263 "KustomizeDeploy": { 2264 "properties": { 2265 "buildArgs": { 2266 "items": { 2267 "type": "string" 2268 }, 2269 "type": "array", 2270 "description": "additional args passed to `kustomize build`.", 2271 "x-intellij-html-description": "additional args passed to <code>kustomize build</code>.", 2272 "default": "[]" 2273 }, 2274 "defaultNamespace": { 2275 "type": "string", 2276 "description": "default namespace passed to kubectl on deployment if no other override is given.", 2277 "x-intellij-html-description": "default namespace passed to kubectl on deployment if no other override is given." 2278 }, 2279 "flags": { 2280 "$ref": "#/definitions/KubectlFlags", 2281 "description": "additional flags passed to `kubectl`.", 2282 "x-intellij-html-description": "additional flags passed to <code>kubectl</code>." 2283 }, 2284 "paths": { 2285 "items": { 2286 "type": "string" 2287 }, 2288 "type": "array", 2289 "description": "path to Kustomization files.", 2290 "x-intellij-html-description": "path to Kustomization files.", 2291 "default": "[\".\"]" 2292 } 2293 }, 2294 "preferredOrder": [ 2295 "paths", 2296 "flags", 2297 "buildArgs", 2298 "defaultNamespace" 2299 ], 2300 "additionalProperties": false, 2301 "type": "object", 2302 "description": "*beta* uses the `kustomize` CLI to \"patch\" a deployment for a target environment.", 2303 "x-intellij-html-description": "<em>beta</em> uses the <code>kustomize</code> CLI to "patch" a deployment for a target environment." 2304 }, 2305 "LocalBuild": { 2306 "properties": { 2307 "concurrency": { 2308 "type": "integer", 2309 "description": "how many artifacts can be built concurrently. 0 means \"no-limit\".", 2310 "x-intellij-html-description": "how many artifacts can be built concurrently. 0 means "no-limit".", 2311 "default": "1" 2312 }, 2313 "push": { 2314 "type": "boolean", 2315 "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.", 2316 "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." 2317 }, 2318 "tryImportMissing": { 2319 "type": "boolean", 2320 "description": "whether to attempt to import artifacts from Docker (either a local or remote registry) if not in the cache.", 2321 "x-intellij-html-description": "whether to attempt to import artifacts from Docker (either a local or remote registry) if not in the cache.", 2322 "default": "false" 2323 }, 2324 "useBuildkit": { 2325 "type": "boolean", 2326 "description": "use BuildKit to build Docker images. If unspecified, uses the Docker default.", 2327 "x-intellij-html-description": "use BuildKit to build Docker images. If unspecified, uses the Docker default." 2328 }, 2329 "useDockerCLI": { 2330 "type": "boolean", 2331 "description": "use `docker` command-line interface instead of Docker Engine APIs.", 2332 "x-intellij-html-description": "use <code>docker</code> command-line interface instead of Docker Engine APIs.", 2333 "default": "false" 2334 } 2335 }, 2336 "preferredOrder": [ 2337 "push", 2338 "tryImportMissing", 2339 "useDockerCLI", 2340 "useBuildkit", 2341 "concurrency" 2342 ], 2343 "additionalProperties": false, 2344 "type": "object", 2345 "description": "*beta* describes how to do a build on the local docker daemon and optionally push to a repository.", 2346 "x-intellij-html-description": "<em>beta</em> describes how to do a build on the local docker daemon and optionally push to a repository." 2347 }, 2348 "LogsConfig": { 2349 "properties": { 2350 "prefix": { 2351 "type": "string", 2352 "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.", 2353 "x-intellij-html-description": "defines the prefix shown on each log line. Valid values are <code>container</code>: prefix logs lines with the name of the container. <code>podAndContainer</code>: prefix logs lines with the names of the pod and of the container. <code>auto</code>: same as <code>podAndContainer</code> except that the pod name is skipped if it's the same as the container name. <code>none</code>: don't add a prefix.", 2354 "default": "auto", 2355 "enum": [ 2356 "container", 2357 "podAndContainer", 2358 "auto", 2359 "none" 2360 ] 2361 } 2362 }, 2363 "preferredOrder": [ 2364 "prefix" 2365 ], 2366 "additionalProperties": false, 2367 "type": "object", 2368 "description": "configures how container logs are printed as a result of a deployment.", 2369 "x-intellij-html-description": "configures how container logs are printed as a result of a deployment." 2370 }, 2371 "Metadata": { 2372 "properties": { 2373 "name": { 2374 "type": "string", 2375 "description": "an identifier for the project.", 2376 "x-intellij-html-description": "an identifier for the project." 2377 } 2378 }, 2379 "preferredOrder": [ 2380 "name" 2381 ], 2382 "additionalProperties": false, 2383 "type": "object", 2384 "description": "holds an optional name of the project.", 2385 "x-intellij-html-description": "holds an optional name of the project." 2386 }, 2387 "PortForwardResource": { 2388 "properties": { 2389 "address": { 2390 "type": "string", 2391 "description": "local address to bind to. Defaults to the loopback address 127.0.0.1.", 2392 "x-intellij-html-description": "local address to bind to. Defaults to the loopback address 127.0.0.1." 2393 }, 2394 "localPort": { 2395 "type": "integer", 2396 "description": "local port to forward to. If the port is unavailable, Skaffold will choose a random open port to forward to. *Optional*.", 2397 "x-intellij-html-description": "local port to forward to. If the port is unavailable, Skaffold will choose a random open port to forward to. <em>Optional</em>." 2398 }, 2399 "namespace": { 2400 "type": "string", 2401 "description": "namespace of the resource to port forward.", 2402 "x-intellij-html-description": "namespace of the resource to port forward." 2403 }, 2404 "port": { 2405 "anyOf": [ 2406 { 2407 "type": "string" 2408 }, 2409 { 2410 "type": "integer" 2411 } 2412 ], 2413 "description": "resource port that will be forwarded.", 2414 "x-intellij-html-description": "resource port that will be forwarded." 2415 }, 2416 "resourceName": { 2417 "type": "string", 2418 "description": "name of the Kubernetes resource to port forward.", 2419 "x-intellij-html-description": "name of the Kubernetes resource to port forward." 2420 }, 2421 "resourceType": { 2422 "type": "string", 2423 "description": "Kubernetes type that should be port forwarded. Acceptable resource types include: `Service`, `Pod` and Controller resource type that has a pod spec: `ReplicaSet`, `ReplicationController`, `Deployment`, `StatefulSet`, `DaemonSet`, `Job`, `CronJob`.", 2424 "x-intellij-html-description": "Kubernetes type that should be port forwarded. Acceptable resource types include: <code>Service</code>, <code>Pod</code> and Controller resource type that has a pod spec: <code>ReplicaSet</code>, <code>ReplicationController</code>, <code>Deployment</code>, <code>StatefulSet</code>, <code>DaemonSet</code>, <code>Job</code>, <code>CronJob</code>." 2425 } 2426 }, 2427 "preferredOrder": [ 2428 "resourceType", 2429 "resourceName", 2430 "namespace", 2431 "port", 2432 "address", 2433 "localPort" 2434 ], 2435 "additionalProperties": false, 2436 "type": "object", 2437 "description": "describes a resource to port forward.", 2438 "x-intellij-html-description": "describes a resource to port forward." 2439 }, 2440 "Profile": { 2441 "required": [ 2442 "name" 2443 ], 2444 "properties": { 2445 "activation": { 2446 "items": { 2447 "$ref": "#/definitions/Activation" 2448 }, 2449 "type": "array", 2450 "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.", 2451 "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." 2452 }, 2453 "build": { 2454 "$ref": "#/definitions/BuildConfig", 2455 "description": "describes how images are built.", 2456 "x-intellij-html-description": "describes how images are built." 2457 }, 2458 "deploy": { 2459 "$ref": "#/definitions/DeployConfig", 2460 "description": "describes how images are deployed.", 2461 "x-intellij-html-description": "describes how images are deployed." 2462 }, 2463 "name": { 2464 "type": "string", 2465 "description": "a unique profile name.", 2466 "x-intellij-html-description": "a unique profile name.", 2467 "examples": [ 2468 "profile-prod" 2469 ] 2470 }, 2471 "patches": { 2472 "items": { 2473 "$ref": "#/definitions/JSONPatch" 2474 }, 2475 "type": "array", 2476 "description": "patches applied to the configuration. Patches use the JSON patch notation.", 2477 "x-intellij-html-description": "patches applied to the configuration. Patches use the JSON patch notation." 2478 }, 2479 "portForward": { 2480 "items": { 2481 "$ref": "#/definitions/PortForwardResource" 2482 }, 2483 "type": "array", 2484 "description": "describes user defined resources to port-forward.", 2485 "x-intellij-html-description": "describes user defined resources to port-forward." 2486 }, 2487 "test": { 2488 "items": { 2489 "$ref": "#/definitions/TestCase" 2490 }, 2491 "type": "array", 2492 "description": "describes how images are tested.", 2493 "x-intellij-html-description": "describes how images are tested." 2494 } 2495 }, 2496 "preferredOrder": [ 2497 "name", 2498 "activation", 2499 "patches", 2500 "build", 2501 "test", 2502 "deploy", 2503 "portForward" 2504 ], 2505 "additionalProperties": false, 2506 "type": "object", 2507 "description": "used to override any `build`, `test` or `deploy` configuration.", 2508 "x-intellij-html-description": "used to override any <code>build</code>, <code>test</code> or <code>deploy</code> configuration." 2509 }, 2510 "ProfileDependency": { 2511 "required": [ 2512 "name" 2513 ], 2514 "properties": { 2515 "activatedBy": { 2516 "items": { 2517 "type": "string" 2518 }, 2519 "type": "array", 2520 "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.", 2521 "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.", 2522 "default": "[]" 2523 }, 2524 "name": { 2525 "type": "string", 2526 "description": "describes name of the profile to activate in the dependency config. It should exist in the dependency config.", 2527 "x-intellij-html-description": "describes name of the profile to activate in the dependency config. It should exist in the dependency config." 2528 } 2529 }, 2530 "preferredOrder": [ 2531 "name", 2532 "activatedBy" 2533 ], 2534 "additionalProperties": false, 2535 "type": "object", 2536 "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.", 2537 "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." 2538 }, 2539 "ResourceRequirement": { 2540 "properties": { 2541 "cpu": { 2542 "type": "string", 2543 "description": "the number cores to be used.", 2544 "x-intellij-html-description": "the number cores to be used.", 2545 "examples": [ 2546 "2`, `2.0` or `200m" 2547 ] 2548 }, 2549 "ephemeralStorage": { 2550 "type": "string", 2551 "description": "the amount of Ephemeral storage to allocate to the pod.", 2552 "x-intellij-html-description": "the amount of Ephemeral storage to allocate to the pod.", 2553 "examples": [ 2554 "1Gi` or `1000Mi" 2555 ] 2556 }, 2557 "memory": { 2558 "type": "string", 2559 "description": "the amount of memory to allocate to the pod.", 2560 "x-intellij-html-description": "the amount of memory to allocate to the pod.", 2561 "examples": [ 2562 "1Gi` or `1000Mi" 2563 ] 2564 }, 2565 "resourceStorage": { 2566 "type": "string", 2567 "description": "the amount of resource storage to allocate to the pod.", 2568 "x-intellij-html-description": "the amount of resource storage to allocate to the pod.", 2569 "examples": [ 2570 "1Gi` or `1000Mi" 2571 ] 2572 } 2573 }, 2574 "preferredOrder": [ 2575 "cpu", 2576 "memory", 2577 "ephemeralStorage", 2578 "resourceStorage" 2579 ], 2580 "additionalProperties": false, 2581 "type": "object", 2582 "description": "stores the CPU/Memory requirements for the pod.", 2583 "x-intellij-html-description": "stores the CPU/Memory requirements for the pod." 2584 }, 2585 "ResourceRequirements": { 2586 "properties": { 2587 "limits": { 2588 "$ref": "#/definitions/ResourceRequirement", 2589 "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.", 2590 "x-intellij-html-description": "<a href=\"https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container\">resource limits</a> for the Kaniko pod." 2591 }, 2592 "requests": { 2593 "$ref": "#/definitions/ResourceRequirement", 2594 "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.", 2595 "x-intellij-html-description": "<a href=\"https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container\">resource requests</a> for the Kaniko pod." 2596 } 2597 }, 2598 "preferredOrder": [ 2599 "requests", 2600 "limits" 2601 ], 2602 "additionalProperties": false, 2603 "type": "object", 2604 "description": "describes the resource requirements for the kaniko pod.", 2605 "x-intellij-html-description": "describes the resource requirements for the kaniko pod." 2606 }, 2607 "ResourceType": { 2608 "type": "string", 2609 "description": "describes the Kubernetes resource types used for port forwarding.", 2610 "x-intellij-html-description": "describes the Kubernetes resource types used for port forwarding." 2611 }, 2612 "ShaTagger": { 2613 "type": "object", 2614 "description": "*beta* tags images with their sha256 digest.", 2615 "x-intellij-html-description": "<em>beta</em> tags images with their sha256 digest." 2616 }, 2617 "SkaffoldConfig": { 2618 "required": [ 2619 "apiVersion", 2620 "kind" 2621 ], 2622 "properties": { 2623 "apiVersion": { 2624 "type": "string", 2625 "description": "version of the configuration.", 2626 "x-intellij-html-description": "version of the configuration." 2627 }, 2628 "build": { 2629 "$ref": "#/definitions/BuildConfig", 2630 "description": "describes how images are built.", 2631 "x-intellij-html-description": "describes how images are built." 2632 }, 2633 "deploy": { 2634 "$ref": "#/definitions/DeployConfig", 2635 "description": "describes how images are deployed.", 2636 "x-intellij-html-description": "describes how images are deployed." 2637 }, 2638 "kind": { 2639 "type": "string", 2640 "description": "always `Config`.", 2641 "x-intellij-html-description": "always <code>Config</code>.", 2642 "default": "Config" 2643 }, 2644 "metadata": { 2645 "$ref": "#/definitions/Metadata", 2646 "description": "holds additional information about the config.", 2647 "x-intellij-html-description": "holds additional information about the config." 2648 }, 2649 "portForward": { 2650 "items": { 2651 "$ref": "#/definitions/PortForwardResource" 2652 }, 2653 "type": "array", 2654 "description": "describes user defined resources to port-forward.", 2655 "x-intellij-html-description": "describes user defined resources to port-forward." 2656 }, 2657 "profiles": { 2658 "items": { 2659 "$ref": "#/definitions/Profile" 2660 }, 2661 "type": "array", 2662 "description": "*beta* can override be used to `build`, `test` or `deploy` configuration.", 2663 "x-intellij-html-description": "<em>beta</em> can override be used to <code>build</code>, <code>test</code> or <code>deploy</code> configuration." 2664 }, 2665 "requires": { 2666 "items": { 2667 "$ref": "#/definitions/ConfigDependency" 2668 }, 2669 "type": "array", 2670 "description": "describes a list of other required configs for the current config.", 2671 "x-intellij-html-description": "describes a list of other required configs for the current config." 2672 }, 2673 "test": { 2674 "items": { 2675 "$ref": "#/definitions/TestCase" 2676 }, 2677 "type": "array", 2678 "description": "describes how images are tested.", 2679 "x-intellij-html-description": "describes how images are tested." 2680 } 2681 }, 2682 "preferredOrder": [ 2683 "apiVersion", 2684 "kind", 2685 "metadata", 2686 "requires", 2687 "build", 2688 "test", 2689 "deploy", 2690 "portForward", 2691 "profiles" 2692 ], 2693 "additionalProperties": false, 2694 "type": "object", 2695 "description": "holds the fields parsed from the Skaffold configuration file (skaffold.yaml).", 2696 "x-intellij-html-description": "holds the fields parsed from the Skaffold configuration file (skaffold.yaml)." 2697 }, 2698 "Sync": { 2699 "properties": { 2700 "auto": { 2701 "type": "boolean", 2702 "description": "delegates discovery of sync rules to the build system. Only available for jib and buildpacks.", 2703 "x-intellij-html-description": "delegates discovery of sync rules to the build system. Only available for jib and buildpacks." 2704 }, 2705 "infer": { 2706 "items": { 2707 "type": "string" 2708 }, 2709 "type": "array", 2710 "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.", 2711 "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.", 2712 "default": "[]" 2713 }, 2714 "manual": { 2715 "items": { 2716 "$ref": "#/definitions/SyncRule" 2717 }, 2718 "type": "array", 2719 "description": "manual sync rules indicating the source and destination.", 2720 "x-intellij-html-description": "manual sync rules indicating the source and destination." 2721 } 2722 }, 2723 "preferredOrder": [ 2724 "manual", 2725 "infer", 2726 "auto" 2727 ], 2728 "additionalProperties": false, 2729 "type": "object", 2730 "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.", 2731 "x-intellij-html-description": "<em>beta</em> 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.", 2732 "default": "infer: [\"**/*\"]" 2733 }, 2734 "SyncRule": { 2735 "required": [ 2736 "src", 2737 "dest" 2738 ], 2739 "properties": { 2740 "dest": { 2741 "type": "string", 2742 "description": "destination path in the container where the files should be synced to.", 2743 "x-intellij-html-description": "destination path in the container where the files should be synced to.", 2744 "examples": [ 2745 "\"app/\"" 2746 ] 2747 }, 2748 "src": { 2749 "type": "string", 2750 "description": "a glob pattern to match local paths against. Directories should be delimited by `/` on all platforms.", 2751 "x-intellij-html-description": "a glob pattern to match local paths against. Directories should be delimited by <code>/</code> on all platforms.", 2752 "examples": [ 2753 "\"css/**/*.css\"" 2754 ] 2755 }, 2756 "strip": { 2757 "type": "string", 2758 "description": "specifies the path prefix to remove from the source path when transplanting the files into the destination folder.", 2759 "x-intellij-html-description": "specifies the path prefix to remove from the source path when transplanting the files into the destination folder.", 2760 "examples": [ 2761 "\"css/\"" 2762 ] 2763 } 2764 }, 2765 "preferredOrder": [ 2766 "src", 2767 "dest", 2768 "strip" 2769 ], 2770 "additionalProperties": false, 2771 "type": "object", 2772 "description": "specifies which local files to sync to remote folders.", 2773 "x-intellij-html-description": "specifies which local files to sync to remote folders." 2774 }, 2775 "TagPolicy": { 2776 "properties": { 2777 "customTemplate": { 2778 "$ref": "#/definitions/CustomTemplateTagger", 2779 "description": "*beta* tags images with a configurable template string *composed of other taggers*.", 2780 "x-intellij-html-description": "<em>beta</em> tags images with a configurable template string <em>composed of other taggers</em>." 2781 }, 2782 "dateTime": { 2783 "$ref": "#/definitions/DateTimeTagger", 2784 "description": "*beta* tags images with the build timestamp.", 2785 "x-intellij-html-description": "<em>beta</em> tags images with the build timestamp." 2786 }, 2787 "envTemplate": { 2788 "$ref": "#/definitions/EnvTemplateTagger", 2789 "description": "*beta* tags images with a configurable template string.", 2790 "x-intellij-html-description": "<em>beta</em> tags images with a configurable template string." 2791 }, 2792 "gitCommit": { 2793 "$ref": "#/definitions/GitTagger", 2794 "description": "*beta* tags images with the git tag or commit of the artifact's workspace.", 2795 "x-intellij-html-description": "<em>beta</em> tags images with the git tag or commit of the artifact's workspace." 2796 }, 2797 "sha256": { 2798 "$ref": "#/definitions/ShaTagger", 2799 "description": "*beta* tags images with their sha256 digest.", 2800 "x-intellij-html-description": "<em>beta</em> tags images with their sha256 digest." 2801 } 2802 }, 2803 "preferredOrder": [ 2804 "gitCommit", 2805 "sha256", 2806 "envTemplate", 2807 "dateTime", 2808 "customTemplate" 2809 ], 2810 "additionalProperties": false, 2811 "type": "object", 2812 "description": "contains all the configuration for the tagging step.", 2813 "x-intellij-html-description": "contains all the configuration for the tagging step." 2814 }, 2815 "TaggerComponent": { 2816 "type": "object", 2817 "anyOf": [ 2818 { 2819 "properties": { 2820 "name": { 2821 "type": "string", 2822 "description": "an identifier for the component.", 2823 "x-intellij-html-description": "an identifier for the component." 2824 } 2825 }, 2826 "preferredOrder": [ 2827 "name" 2828 ], 2829 "additionalProperties": false 2830 }, 2831 { 2832 "properties": { 2833 "gitCommit": { 2834 "$ref": "#/definitions/GitTagger", 2835 "description": "*beta* tags images with the git tag or commit of the artifact's workspace.", 2836 "x-intellij-html-description": "<em>beta</em> tags images with the git tag or commit of the artifact's workspace." 2837 }, 2838 "name": { 2839 "type": "string", 2840 "description": "an identifier for the component.", 2841 "x-intellij-html-description": "an identifier for the component." 2842 } 2843 }, 2844 "preferredOrder": [ 2845 "name", 2846 "gitCommit" 2847 ], 2848 "additionalProperties": false 2849 }, 2850 { 2851 "properties": { 2852 "name": { 2853 "type": "string", 2854 "description": "an identifier for the component.", 2855 "x-intellij-html-description": "an identifier for the component." 2856 }, 2857 "sha256": { 2858 "$ref": "#/definitions/ShaTagger", 2859 "description": "*beta* tags images with their sha256 digest.", 2860 "x-intellij-html-description": "<em>beta</em> tags images with their sha256 digest." 2861 } 2862 }, 2863 "preferredOrder": [ 2864 "name", 2865 "sha256" 2866 ], 2867 "additionalProperties": false 2868 }, 2869 { 2870 "properties": { 2871 "envTemplate": { 2872 "$ref": "#/definitions/EnvTemplateTagger", 2873 "description": "*beta* tags images with a configurable template string.", 2874 "x-intellij-html-description": "<em>beta</em> tags images with a configurable template string." 2875 }, 2876 "name": { 2877 "type": "string", 2878 "description": "an identifier for the component.", 2879 "x-intellij-html-description": "an identifier for the component." 2880 } 2881 }, 2882 "preferredOrder": [ 2883 "name", 2884 "envTemplate" 2885 ], 2886 "additionalProperties": false 2887 }, 2888 { 2889 "properties": { 2890 "dateTime": { 2891 "$ref": "#/definitions/DateTimeTagger", 2892 "description": "*beta* tags images with the build timestamp.", 2893 "x-intellij-html-description": "<em>beta</em> tags images with the build timestamp." 2894 }, 2895 "name": { 2896 "type": "string", 2897 "description": "an identifier for the component.", 2898 "x-intellij-html-description": "an identifier for the component." 2899 } 2900 }, 2901 "preferredOrder": [ 2902 "name", 2903 "dateTime" 2904 ], 2905 "additionalProperties": false 2906 }, 2907 { 2908 "properties": { 2909 "customTemplate": { 2910 "$ref": "#/definitions/CustomTemplateTagger", 2911 "description": "*beta* tags images with a configurable template string *composed of other taggers*.", 2912 "x-intellij-html-description": "<em>beta</em> tags images with a configurable template string <em>composed of other taggers</em>." 2913 }, 2914 "name": { 2915 "type": "string", 2916 "description": "an identifier for the component.", 2917 "x-intellij-html-description": "an identifier for the component." 2918 } 2919 }, 2920 "preferredOrder": [ 2921 "name", 2922 "customTemplate" 2923 ], 2924 "additionalProperties": false 2925 } 2926 ], 2927 "description": "*beta* a component of CustomTemplateTagger.", 2928 "x-intellij-html-description": "<em>beta</em> a component of CustomTemplateTagger." 2929 }, 2930 "TestCase": { 2931 "required": [ 2932 "image" 2933 ], 2934 "properties": { 2935 "image": { 2936 "type": "string", 2937 "description": "artifact on which to run those tests.", 2938 "x-intellij-html-description": "artifact on which to run those tests.", 2939 "examples": [ 2940 "gcr.io/k8s-skaffold/example" 2941 ] 2942 }, 2943 "structureTests": { 2944 "items": { 2945 "type": "string" 2946 }, 2947 "type": "array", 2948 "description": "the [Container Structure Tests](https://github.com/GoogleContainerTools/container-structure-test) to run on that artifact.", 2949 "x-intellij-html-description": "the <a href=\"https://github.com/GoogleContainerTools/container-structure-test\">Container Structure Tests</a> to run on that artifact.", 2950 "default": "[]", 2951 "examples": [ 2952 "[\"./test/*\"]" 2953 ] 2954 } 2955 }, 2956 "preferredOrder": [ 2957 "image", 2958 "structureTests" 2959 ], 2960 "additionalProperties": false, 2961 "type": "object", 2962 "description": "a list of structure tests to run on images that Skaffold builds.", 2963 "x-intellij-html-description": "a list of structure tests to run on images that Skaffold builds." 2964 } 2965 } 2966 }