github.com/jenkins-x/jx-api@v0.0.24/docs/apidocs/openapi-spec/openapiv2.yaml (about) 1 definitions: 2 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.AccountReference: 3 description: AccountReference is a reference to a user account in another system 4 that is attached to this user 5 properties: 6 id: 7 type: string 8 provider: 9 type: string 10 type: object 11 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.App: 12 description: App is the metadata for an App 13 properties: 14 apiVersion: 15 description: 'APIVersion defines the versioned schema of this representation 16 of an object. Servers should convert recognized schemas to the latest internal 17 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 18 type: string 19 kind: 20 description: 'Kind is a string value representing the REST resource this object 21 represents. Servers may infer this from the endpoint the client submits 22 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 23 type: string 24 metadata: 25 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 26 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 27 spec: 28 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.AppSpec' 29 type: object 30 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.AppList: 31 description: AppList is a structure used by k8s to store lists of apps 32 properties: 33 apiVersion: 34 description: 'APIVersion defines the versioned schema of this representation 35 of an object. Servers should convert recognized schemas to the latest internal 36 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 37 type: string 38 items: 39 items: 40 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.App' 41 type: array 42 kind: 43 description: 'Kind is a string value representing the REST resource this object 44 represents. Servers may infer this from the endpoint the client submits 45 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 46 type: string 47 metadata: 48 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 49 required: 50 - metadata 51 - items 52 type: object 53 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.AppSpec: 54 description: AppSpec provides details of the metadata for an App 55 properties: 56 pipelineExtension: 57 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineExtension' 58 schemaPreprocessor: 59 $ref: '#/definitions/io.k8s.api.core.v1.Container' 60 schemaPreprocessorRole: 61 $ref: '#/definitions/io.k8s.api.rbac.v1.Role' 62 type: object 63 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Approve: 64 description: |- 65 Approve specifies a configuration for a single approve. 66 67 The configuration for the approve plugin is defined as a list of these structures. 68 properties: 69 ignoreReviewState: 70 description: 'IgnoreReviewState causes the approve plugin to ignore the GitHub 71 review state. Otherwise: * an APPROVE github review is equivalent to leaving 72 an "/approve" message. * A REQUEST_CHANGES github review is equivalent to 73 leaving an /approve cancel" message.' 74 type: boolean 75 issueRequired: 76 description: IssueRequired indicates if an associated issue is required for 77 approval in the specified repos. 78 type: boolean 79 lgtmActsAsApprove: 80 description: LgtmActsAsApprove indicates that the lgtm command should be used 81 to indicate approval 82 type: boolean 83 requireSelfApproval: 84 description: RequireSelfApproval requires PR authors to explicitly approve 85 their PRs. Otherwise the plugin assumes the author of the PR approves the 86 changes in the PR. 87 type: boolean 88 type: object 89 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Attachment: 90 properties: 91 name: 92 type: string 93 urls: 94 items: 95 type: string 96 type: array 97 type: object 98 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BatchPipelineActivity: 99 description: BatchPipelineActivity contains information about a batch build, used 100 by both the batch build and its comprising PRs for linking them together 101 properties: 102 batchBranchName: 103 type: string 104 batchBuildNumber: 105 type: string 106 pullRequestInfo: 107 items: 108 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PullRequestInfo' 109 type: array 110 type: object 111 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Binary: 112 description: Binary provies the details of a downloadable binary 113 properties: 114 goarch: 115 type: string 116 goos: 117 type: string 118 url: 119 type: string 120 type: object 121 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BranchProtectionContextPolicy: 122 description: BranchProtectionContextPolicy configures required git provider contexts. 123 Strict determines whether merging to the branch invalidates existing contexts. 124 properties: 125 contexts: 126 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 127 description: Contexts appends required contexts that must be green to merge 128 strict: 129 description: Strict overrides whether new commits in the base branch require 130 updating the PR if set 131 type: boolean 132 type: object 133 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Brancher: 134 description: Brancher is for shared code between jobs that only run against certain 135 branches. An empty brancher runs against all branches. 136 properties: 137 branches: 138 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 139 description: Only run against these branches. Default is all branches. 140 skipBranches: 141 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 142 description: Do not run against these branches. Default is no branches. 143 type: object 144 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BuildPack: 145 description: BuildPack represents a set of language specific build packs and associated 146 quickstarts 147 properties: 148 apiVersion: 149 description: 'APIVersion defines the versioned schema of this representation 150 of an object. Servers should convert recognized schemas to the latest internal 151 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 152 type: string 153 kind: 154 description: 'Kind is a string value representing the REST resource this object 155 represents. Servers may infer this from the endpoint the client submits 156 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 157 type: string 158 metadata: 159 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 160 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 161 spec: 162 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BuildPackSpec' 163 type: object 164 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BuildPackList: 165 description: BuildPackList is a list of TypeMeta resources 166 properties: 167 apiVersion: 168 description: 'APIVersion defines the versioned schema of this representation 169 of an object. Servers should convert recognized schemas to the latest internal 170 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 171 type: string 172 items: 173 items: 174 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BuildPack' 175 type: array 176 kind: 177 description: 'Kind is a string value representing the REST resource this object 178 represents. Servers may infer this from the endpoint the client submits 179 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 180 type: string 181 metadata: 182 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 183 required: 184 - metadata 185 - items 186 type: object 187 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BuildPackSpec: 188 description: BuildPackSpec is the specification of an BuildPack 189 properties: 190 gitRef: 191 type: string 192 gitUrl: 193 type: string 194 label: 195 type: string 196 quickstartLocations: 197 items: 198 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.QuickStartLocation' 199 type: array 200 type: object 201 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ChartRef: 202 properties: 203 name: 204 type: string 205 repo: 206 type: string 207 repoName: 208 type: string 209 type: object 210 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatus: 211 description: CommitStatus represents the commit statuses for a particular pull 212 request 213 properties: 214 apiVersion: 215 description: 'APIVersion defines the versioned schema of this representation 216 of an object. Servers should convert recognized schemas to the latest internal 217 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 218 type: string 219 kind: 220 description: 'Kind is a string value representing the REST resource this object 221 represents. Servers may infer this from the endpoint the client submits 222 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 223 type: string 224 metadata: 225 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 226 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 227 spec: 228 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusSpec' 229 type: object 230 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusCommitReference: 231 properties: 232 gitUrl: 233 type: string 234 pullRequest: 235 type: string 236 sha: 237 type: string 238 type: object 239 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusDetails: 240 properties: 241 Items: 242 items: 243 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusItem' 244 type: array 245 checked: 246 type: boolean 247 commit: 248 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusCommitReference' 249 context: 250 type: string 251 pipelineActivity: 252 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ResourceReference' 253 required: 254 - pipelineActivity 255 - checked 256 - commit 257 - context 258 type: object 259 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusItem: 260 properties: 261 description: 262 type: string 263 name: 264 type: string 265 pass: 266 type: boolean 267 required: 268 - pass 269 type: object 270 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusList: 271 description: CommitStatusList is a structure used by k8s to store lists of commit 272 statuses 273 properties: 274 Items: 275 items: 276 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatus' 277 type: array 278 apiVersion: 279 description: 'APIVersion defines the versioned schema of this representation 280 of an object. Servers should convert recognized schemas to the latest internal 281 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 282 type: string 283 kind: 284 description: 'Kind is a string value representing the REST resource this object 285 represents. Servers may infer this from the endpoint the client submits 286 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 287 type: string 288 metadata: 289 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 290 required: 291 - metadata 292 - Items 293 type: object 294 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusSpec: 295 description: CommitStatusSpec provides details of a particular commit status 296 properties: 297 items: 298 items: 299 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitStatusDetails' 300 type: array 301 required: 302 - items 303 type: object 304 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitSummary: 305 description: CommitSummary is the summary of a commit 306 properties: 307 author: 308 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails' 309 branch: 310 type: string 311 committer: 312 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails' 313 issueIds: 314 items: 315 type: string 316 type: array 317 message: 318 type: string 319 sha: 320 type: string 321 url: 322 type: string 323 type: object 324 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ConfigMapSpec: 325 description: ConfigMapSpec contains configuration options for the configMap being 326 updated by the config-updater plugin. 327 properties: 328 additional_namespaces: 329 description: Namespaces in which the configMap needs to be deployed, in addition 330 to the above namespace provided, or the default if it is not set. 331 items: 332 type: string 333 type: array 334 key: 335 description: Key is the key in the ConfigMap to update with the file contents. 336 If no explicit key is given, the basename of the file will be used. 337 type: string 338 name: 339 description: Name of ConfigMap 340 type: string 341 namespace: 342 description: Namespace in which the configMap needs to be deployed. If no 343 namespace is specified it will be deployed to the ProwJobNamespace. 344 type: string 345 required: 346 - name 347 type: object 348 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ConfigUpdater: 349 description: ConfigUpdater holds configuration for the config updater plugin 350 properties: 351 ConfigMap: 352 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ConfigMapSpec' 353 configFile: 354 type: string 355 map: 356 additionalProperties: 357 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ConfigMapSpec' 358 type: object 359 pluginFile: 360 type: string 361 type: object 362 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ContextPolicy: 363 description: ContextPolicy configures options about how to handle various contexts. 364 properties: 365 fromBranchProtection: 366 description: Infer required and optional jobs from Branch Protection configuration 367 type: boolean 368 optionalContexts: 369 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 370 requiredContexts: 371 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 372 requiredIfPresentContexts: 373 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 374 skipUnknownContexts: 375 description: whether to consider unknown contexts optional (skip) or required. 376 type: boolean 377 type: object 378 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CoreActivityStep: 379 description: CoreActivityStep is a base step included in Stages of a pipeline 380 or other kinds of step 381 properties: 382 completedTimestamp: 383 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 384 description: 385 type: string 386 name: 387 type: string 388 startedTimestamp: 389 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 390 status: 391 type: string 392 type: object 393 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DependencyUpdate: 394 description: DependencyUpdate describes an dependency update message from the 395 commit log 396 properties: 397 component: 398 type: string 399 fromReleaseHTMLURL: 400 type: string 401 fromReleaseName: 402 type: string 403 fromVersion: 404 type: string 405 host: 406 type: string 407 owner: 408 type: string 409 paths: 410 items: 411 items: 412 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DependencyUpdateDetails' 413 type: array 414 type: array 415 repo: 416 type: string 417 toReleaseHTMLURL: 418 type: string 419 toReleaseName: 420 type: string 421 toVersion: 422 type: string 423 url: 424 type: string 425 required: 426 - host 427 - owner 428 - repo 429 - component 430 - url 431 - fromVersion 432 - fromReleaseHTMLURL 433 - fromReleaseName 434 - toVersion 435 - toReleaseHTMLURL 436 - toReleaseName 437 type: object 438 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DependencyUpdateDetails: 439 description: DependencyUpdateDetails are the details of a dependency update 440 properties: 441 component: 442 type: string 443 fromReleaseHTMLURL: 444 type: string 445 fromReleaseName: 446 type: string 447 fromVersion: 448 type: string 449 host: 450 type: string 451 owner: 452 type: string 453 repo: 454 type: string 455 toReleaseHTMLURL: 456 type: string 457 toReleaseName: 458 type: string 459 toVersion: 460 type: string 461 url: 462 type: string 463 required: 464 - host 465 - owner 466 - repo 467 - component 468 - url 469 - fromVersion 470 - fromReleaseHTMLURL 471 - fromReleaseName 472 - toVersion 473 - toReleaseHTMLURL 474 - toReleaseName 475 type: object 476 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DeployOptions: 477 description: DeployOptions configures options for how to deploy applications by 478 default such as using progressive delivery or using horizontal pod autoscaler 479 properties: 480 canary: 481 description: Canary should we enable canary rollouts (progressive delivery) 482 for apps by default 483 type: boolean 484 hpa: 485 description: should we use the horizontal pod autoscaler on new apps by default? 486 type: boolean 487 type: object 488 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Environment: 489 description: Environment represents an environment like Dev, Test, Staging, Production 490 where code lives 491 properties: 492 apiVersion: 493 description: 'APIVersion defines the versioned schema of this representation 494 of an object. Servers should convert recognized schemas to the latest internal 495 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 496 type: string 497 kind: 498 description: 'Kind is a string value representing the REST resource this object 499 represents. Servers may infer this from the endpoint the client submits 500 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 501 type: string 502 metadata: 503 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 504 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 505 spec: 506 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentSpec' 507 status: 508 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentStatus' 509 type: object 510 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentFilter: 511 description: EnvironmentFilter specifies the environments to apply the role binding 512 to 513 properties: 514 excludes: 515 items: 516 type: string 517 type: array 518 includes: 519 items: 520 type: string 521 type: array 522 kind: 523 type: string 524 type: object 525 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentList: 526 description: EnvironmentList is a list of TypeMeta resources 527 properties: 528 apiVersion: 529 description: 'APIVersion defines the versioned schema of this representation 530 of an object. Servers should convert recognized schemas to the latest internal 531 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 532 type: string 533 items: 534 items: 535 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Environment' 536 type: array 537 kind: 538 description: 'Kind is a string value representing the REST resource this object 539 represents. Servers may infer this from the endpoint the client submits 540 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 541 type: string 542 metadata: 543 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 544 required: 545 - metadata 546 - items 547 type: object 548 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRepository: 549 description: EnvironmentRepository is the repository for an environment using 550 GitOps 551 properties: 552 kind: 553 type: string 554 ref: 555 type: string 556 url: 557 type: string 558 type: object 559 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBinding: 560 description: |- 561 EnvironmentRoleBinding is like a vanilla RoleBinding but applies to a set of Namespaces based on an Environment filter so that roles can be bound to multiple namespaces easily. 562 563 For example to specify the binding of roles on all Preview environments or on all permanent environments. 564 properties: 565 apiVersion: 566 description: 'APIVersion defines the versioned schema of this representation 567 of an object. Servers should convert recognized schemas to the latest internal 568 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 569 type: string 570 kind: 571 description: 'Kind is a string value representing the REST resource this object 572 represents. Servers may infer this from the endpoint the client submits 573 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 574 type: string 575 metadata: 576 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 577 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 578 spec: 579 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBindingSpec' 580 status: 581 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBindingStatus' 582 type: object 583 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBindingList: 584 description: EnvironmentRoleBindingList is a list of TypeMeta resources 585 properties: 586 apiVersion: 587 description: 'APIVersion defines the versioned schema of this representation 588 of an object. Servers should convert recognized schemas to the latest internal 589 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 590 type: string 591 items: 592 items: 593 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBinding' 594 type: array 595 kind: 596 description: 'Kind is a string value representing the REST resource this object 597 represents. Servers may infer this from the endpoint the client submits 598 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 599 type: string 600 metadata: 601 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 602 required: 603 - metadata 604 - items 605 type: object 606 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBindingSpec: 607 description: EnvironmentRoleBindingSpec is the specification of an EnvironmentRoleBinding 608 properties: 609 environments: 610 description: specifies which sets of environments this binding applies to 611 items: 612 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentFilter' 613 type: array 614 roleRef: 615 $ref: '#/definitions/io.k8s.api.rbac.v1.RoleRef' 616 description: RoleRef can reference a Role in the current namespace or a ClusterRole 617 in the global namespace. If the RoleRef cannot be resolved, the Authorizer 618 must return an error. 619 subjects: 620 description: Subjects holds references to the objects the role applies to. 621 items: 622 $ref: '#/definitions/io.k8s.api.rbac.v1.Subject' 623 type: array 624 required: 625 - subjects 626 - roleRef 627 type: object 628 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRoleBindingStatus: 629 description: EnvironmentRoleBindingStatus is the status for an EnvironmentRoleBinding 630 resource 631 properties: 632 version: 633 type: string 634 type: object 635 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentSpec: 636 description: EnvironmentSpec is the specification of an Environment 637 properties: 638 cluster: 639 type: string 640 kind: 641 type: string 642 label: 643 type: string 644 namespace: 645 type: string 646 order: 647 format: int32 648 type: integer 649 previewGitInfo: 650 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PreviewGitSpec' 651 promotionStrategy: 652 type: string 653 pullRequestURL: 654 type: string 655 remoteCluster: 656 description: RemoteCluster flag indicates if the Environment is deployed in 657 a separate cluster to the Development Environment 658 type: boolean 659 source: 660 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentRepository' 661 teamSettings: 662 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamSettings' 663 webHookEngine: 664 type: string 665 type: object 666 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentStatus: 667 description: EnvironmentStatus is the status for an Environment resource 668 properties: 669 version: 670 type: string 671 type: object 672 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentVariable: 673 properties: 674 name: 675 type: string 676 value: 677 type: string 678 type: object 679 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Extension: 680 description: Extension represents an extension available to this Jenkins X install 681 properties: 682 apiVersion: 683 description: 'APIVersion defines the versioned schema of this representation 684 of an object. Servers should convert recognized schemas to the latest internal 685 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 686 type: string 687 kind: 688 description: 'Kind is a string value representing the REST resource this object 689 represents. Servers may infer this from the endpoint the client submits 690 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 691 type: string 692 metadata: 693 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 694 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 695 spec: 696 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionSpec' 697 type: object 698 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionConfig: 699 description: ExtensionConfig is the configuration and enablement for an extension 700 inside an app 701 properties: 702 name: 703 type: string 704 namespace: 705 type: string 706 parameters: 707 items: 708 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionParameterValue' 709 type: array 710 required: 711 - name 712 - namespace 713 - parameters 714 type: object 715 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionConfigList: 716 description: ExtensionsConfigList contains a list of ExtensionConfig items 717 properties: 718 extensions: 719 items: 720 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionConfig' 721 type: array 722 required: 723 - extensions 724 type: object 725 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinition: 726 description: ExtensionDefinition defines an Extension 727 properties: 728 children: 729 items: 730 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionChildReference' 731 type: array 732 description: 733 type: string 734 given: 735 type: string 736 name: 737 type: string 738 namespace: 739 type: string 740 parameters: 741 items: 742 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionParameter' 743 type: array 744 scriptFile: 745 type: string 746 uuid: 747 type: string 748 when: 749 items: 750 type: string 751 type: array 752 required: 753 - name 754 - namespace 755 - uuid 756 type: object 757 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionChildReference: 758 description: ExtensionDefinitionChildReference provides a reference to a child 759 properties: 760 name: 761 type: string 762 namespace: 763 type: string 764 remote: 765 type: string 766 tag: 767 type: string 768 uuid: 769 type: string 770 type: object 771 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionList: 772 description: ExtensionDefinitionList contains a list of ExtensionDefinition items 773 properties: 774 extensions: 775 items: 776 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinition' 777 type: array 778 version: 779 type: string 780 required: 781 - extensions 782 type: object 783 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionReference: 784 description: ExtensionRepositoryReference references a GitHub repo that contains 785 extension definitions 786 properties: 787 remote: 788 type: string 789 tag: 790 type: string 791 required: 792 - remote 793 - tag 794 type: object 795 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionReferenceList: 796 description: ExtensionDefinitionReferenceList contains a list of ExtensionRepository 797 items 798 properties: 799 remotes: 800 items: 801 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionDefinitionReference' 802 type: array 803 required: 804 - remotes 805 type: object 806 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionExecution: 807 description: ExtensionExecution is an executable instance of an extension which 808 can be attached into a pipeline for later execution. It differs from an Extension 809 as it cannot have children and parameters have been resolved to environment 810 variables 811 properties: 812 description: 813 type: string 814 environmentVariables: 815 items: 816 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.EnvironmentVariable' 817 type: array 818 given: 819 type: string 820 name: 821 type: string 822 namespace: 823 type: string 824 script: 825 type: string 826 uuid: 827 type: string 828 type: object 829 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionList: 830 description: ExtensionList is a list of Extensions available for a team 831 properties: 832 apiVersion: 833 description: 'APIVersion defines the versioned schema of this representation 834 of an object. Servers should convert recognized schemas to the latest internal 835 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 836 type: string 837 items: 838 items: 839 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Extension' 840 type: array 841 kind: 842 description: 'Kind is a string value representing the REST resource this object 843 represents. Servers may infer this from the endpoint the client submits 844 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 845 type: string 846 metadata: 847 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 848 required: 849 - metadata 850 - items 851 type: object 852 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionParameter: 853 description: ExtensionParameter describes a parameter definition for an extension 854 properties: 855 defaultValue: 856 type: string 857 description: 858 type: string 859 environmentVariableName: 860 type: string 861 name: 862 type: string 863 type: object 864 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionParameterValue: 865 properties: 866 name: 867 type: string 868 value: 869 type: string 870 required: 871 - name 872 - value 873 type: object 874 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionRepositoryReference: 875 properties: 876 chart: 877 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ChartRef' 878 github: 879 type: string 880 url: 881 type: string 882 type: object 883 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionRepositoryReferenceList: 884 properties: 885 repositories: 886 items: 887 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionRepositoryReference' 888 type: array 889 type: object 890 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionSpec: 891 description: ExtensionSpec provides details of an extension available for a team 892 properties: 893 children: 894 items: 895 type: string 896 type: array 897 description: 898 type: string 899 given: 900 type: string 901 name: 902 type: string 903 namespace: 904 type: string 905 parameters: 906 items: 907 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionParameter' 908 type: array 909 script: 910 type: string 911 uuid: 912 type: string 913 version: 914 type: string 915 when: 916 items: 917 type: string 918 type: array 919 type: object 920 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExternalPlugin: 921 description: ExternalPlugin holds configuration for registering an external plugin. 922 properties: 923 endpoint: 924 description: Endpoint is the location of the external plugin. Defaults to 925 the name of the plugin, ie. "http://{{name}}". 926 type: string 927 events: 928 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 929 description: ReplaceableSliceOfStrings are the events that need to be demuxed 930 by the hook server to the external plugin. If no events are specified, everything 931 is sent. 932 name: 933 description: Name of the plugin. 934 type: string 935 required: 936 - name 937 type: object 938 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Fact: 939 description: |- 940 Fact represents observed facts. Apps will generate Facts about the system. A naming schema is required since each Fact has a name that's unique for the whole system. Apps should prefix their generated Facts with the name of the App, like <app-name>-<fact>. This makes that different Apps can't possibly have conflicting Fact names. 941 942 For an app generating facts on a pipeline, which will be have several different executions, we recommend <app>-<fact>-<pipeline>. 943 properties: 944 apiVersion: 945 description: 'APIVersion defines the versioned schema of this representation 946 of an object. Servers should convert recognized schemas to the latest internal 947 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 948 type: string 949 kind: 950 description: 'Kind is a string value representing the REST resource this object 951 represents. Servers may infer this from the endpoint the client submits 952 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 953 type: string 954 metadata: 955 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 956 description: |- 957 The Fact labels will be used to query the API for interesting Facts. The Apps responsible for creating Facts need to add the relevant labels. For example, creating Facts on a pipeline would create Facts with the following labels { 958 subjectkind: PipelineActivity 959 pipelineName: my-org-my-app-master-23 960 org: my-org 961 repo: my-app 962 branch: master 963 buildNumber: 23 964 } 965 spec: 966 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.FactSpec' 967 status: 968 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.FactStatus' 969 type: object 970 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.FactList: 971 description: FactList is a list of Fact resources 972 properties: 973 apiVersion: 974 description: 'APIVersion defines the versioned schema of this representation 975 of an object. Servers should convert recognized schemas to the latest internal 976 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 977 type: string 978 items: 979 items: 980 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Fact' 981 type: array 982 kind: 983 description: 'Kind is a string value representing the REST resource this object 984 represents. Servers may infer this from the endpoint the client submits 985 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 986 type: string 987 metadata: 988 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 989 required: 990 - metadata 991 - items 992 type: object 993 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.FactSpec: 994 description: FactSpec is the specification of a Fact 995 properties: 996 factType: 997 type: string 998 measurements: 999 items: 1000 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Measurement' 1001 type: array 1002 name: 1003 type: string 1004 original: 1005 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Original' 1006 statements: 1007 items: 1008 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Statement' 1009 type: array 1010 subject: 1011 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ResourceReference' 1012 tags: 1013 items: 1014 type: string 1015 type: array 1016 required: 1017 - name 1018 - factType 1019 - subject 1020 type: object 1021 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.FactStatus: 1022 description: FactStatus is the status for an Fact resource 1023 properties: 1024 version: 1025 type: string 1026 type: object 1027 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitService: 1028 description: GitService represents a git provider so we can map the host name 1029 to a kinda of git service 1030 properties: 1031 apiVersion: 1032 description: 'APIVersion defines the versioned schema of this representation 1033 of an object. Servers should convert recognized schemas to the latest internal 1034 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1035 type: string 1036 kind: 1037 description: 'Kind is a string value representing the REST resource this object 1038 represents. Servers may infer this from the endpoint the client submits 1039 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1040 type: string 1041 metadata: 1042 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 1043 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 1044 spec: 1045 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitServiceSpec' 1046 type: object 1047 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitServiceList: 1048 description: GitServiceList is a list of GitService resources 1049 properties: 1050 apiVersion: 1051 description: 'APIVersion defines the versioned schema of this representation 1052 of an object. Servers should convert recognized schemas to the latest internal 1053 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1054 type: string 1055 items: 1056 items: 1057 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitService' 1058 type: array 1059 kind: 1060 description: 'Kind is a string value representing the REST resource this object 1061 represents. Servers may infer this from the endpoint the client submits 1062 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1063 type: string 1064 metadata: 1065 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 1066 required: 1067 - metadata 1068 - items 1069 type: object 1070 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitServiceSpec: 1071 description: GitServiceSpec is the specification of an GitService 1072 properties: 1073 gitKind: 1074 type: string 1075 name: 1076 type: string 1077 url: 1078 type: string 1079 type: object 1080 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitStatus: 1081 description: GitStatus the status of a git commit in terms of CI/CD 1082 properties: 1083 status: 1084 type: string 1085 url: 1086 type: string 1087 type: object 1088 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GlobalProtectionPolicy: 1089 description: GlobalProtectionPolicy defines the default branch protection policy 1090 for the scheduler 1091 properties: 1092 ProtectionPolicy: 1093 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ProtectionPolicy' 1094 protectTested: 1095 type: boolean 1096 type: object 1097 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.IssueLabel: 1098 properties: 1099 color: 1100 type: string 1101 name: 1102 type: string 1103 url: 1104 type: string 1105 type: object 1106 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.IssueSummary: 1107 description: IssueSummary is the summary of an issue 1108 properties: 1109 assignees: 1110 items: 1111 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails' 1112 type: array 1113 body: 1114 type: string 1115 closedBy: 1116 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails' 1117 creationTimestamp: 1118 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1119 id: 1120 type: string 1121 labels: 1122 items: 1123 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.IssueLabel' 1124 type: array 1125 message: 1126 type: string 1127 state: 1128 type: string 1129 title: 1130 type: string 1131 url: 1132 type: string 1133 user: 1134 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails' 1135 type: object 1136 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.JobBase: 1137 description: JobBase contains attributes common to all job types 1138 properties: 1139 agent: 1140 description: Agent that will take care of running this job. 1141 type: string 1142 cluster: 1143 description: 'Cluster is the alias of the cluster to run this job in. (Default: 1144 kube.DefaultClusterAlias)' 1145 type: string 1146 labels: 1147 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableMapOfStringString' 1148 description: ReplaceableMapOfStringString are added to jobs and pods created 1149 for this job. 1150 maxConcurrency: 1151 description: MaximumConcurrency of this job, 0 implies no limit. 1152 format: int32 1153 type: integer 1154 name: 1155 description: The name of the job. Must match regex [A-Za-z0-9-._]+ e.g. pull-test-infra-bazel-build 1156 type: string 1157 namespace: 1158 description: |- 1159 Namespace is the namespace in which pods schedule. 1160 empty: results in scheduler.DefaultNamespace 1161 type: string 1162 spec: 1163 $ref: '#/definitions/io.k8s.api.core.v1.PodSpec' 1164 description: Spec is the Kubernetes pod spec used if Agent is kubernetes. 1165 required: 1166 - name 1167 - agent 1168 type: object 1169 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Lgtm: 1170 description: Lgtm specifies a configuration for a single lgtm. The configuration 1171 for the lgtm plugin is defined as a list of these structures. 1172 properties: 1173 reviewActsAsLgtm: 1174 description: ReviewActsAsLgtm indicates that a Github review of "approve" 1175 or "request changes" acts as adding or removing the lgtm label 1176 type: boolean 1177 storeTreeHash: 1178 description: StoreTreeHash indicates if tree_hash should be stored inside 1179 a comment to detect squashed commits before removing lgtm labels 1180 type: boolean 1181 trustedTeamForStickyLgtm: 1182 description: |- 1183 WARNING: This disables the security mechanism that prevents a malicious member (or compromised GitHub account) from merging arbitrary code. Use with caution. 1184 1185 StickyLgtmTeam specifies the Github team whose members are trusted with sticky LGTM, which eliminates the need to re-lgtm minor fixes/updates. 1186 type: string 1187 type: object 1188 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Measurement: 1189 description: Measurement is a percentage or a count, something measured that the 1190 system will capture within a fact 1191 properties: 1192 measurementType: 1193 type: string 1194 measurementValue: 1195 format: int32 1196 type: integer 1197 name: 1198 type: string 1199 tags: 1200 items: 1201 type: string 1202 type: array 1203 required: 1204 - name 1205 - measurementType 1206 - measurementValue 1207 type: object 1208 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Merger: 1209 description: Merger defines the options used to merge the PR 1210 properties: 1211 blockerLabel: 1212 description: BlockerLabel is an optional label that is used to identify merge 1213 blocking Git Provider issues. Leave this blank to disable this feature and 1214 save 1 API token per sync loop. 1215 type: string 1216 maxGoroutines: 1217 description: MaxGoroutines is the maximum number of goroutines spawned inside 1218 the controller to handle org/repo:branch pools. Defaults to 20. Needs to 1219 be a positive number. 1220 format: int32 1221 type: integer 1222 mergeMethod: 1223 description: Override the default method of merge. Valid options are squash, 1224 rebase, and merge. 1225 type: string 1226 policy: 1227 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ContextPolicy' 1228 description: ContextOptions defines the default merge options. If not set 1229 it will infer the required and optional contexts from the jobs configured 1230 and use the Git Provider combined status; otherwise it may apply the branch 1231 protection setting or let user define their own options in case branch protection 1232 is not used. 1233 prStatusBaseUrl: 1234 description: PRStatusBaseURL is the base URL for the PR status page. This 1235 is used to link to a merge requirements overview in the status context. 1236 type: string 1237 squashLabel: 1238 description: SquashLabel is an optional label that is used to identify PRs 1239 that should always be squash merged. Leave this blank to disable this feature. 1240 type: string 1241 targetUrl: 1242 description: URL for status contexts. 1243 type: string 1244 type: object 1245 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Original: 1246 description: Original contains the report 1247 properties: 1248 mimetype: 1249 type: string 1250 tags: 1251 items: 1252 type: string 1253 type: array 1254 url: 1255 type: string 1256 type: object 1257 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Periodic: 1258 description: Periodic defines a job to be run periodically 1259 properties: 1260 JobBase: 1261 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.JobBase' 1262 cron: 1263 description: Cron representation of job trigger time 1264 type: string 1265 interval: 1266 description: Interval to wait between two runs of the job. 1267 type: string 1268 tags: 1269 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 1270 description: Tags for config entries 1271 required: 1272 - interval 1273 - cron 1274 type: object 1275 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Periodics: 1276 description: Periodics is a list of jobs to be run periodically 1277 properties: 1278 entries: 1279 description: Items are the post submit configurations 1280 items: 1281 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Periodic' 1282 type: array 1283 replace: 1284 description: Replace the existing entries 1285 type: boolean 1286 type: object 1287 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivity: 1288 description: PipelineActivity represents pipeline activity for a particular run 1289 of a pipeline 1290 properties: 1291 apiVersion: 1292 description: 'APIVersion defines the versioned schema of this representation 1293 of an object. Servers should convert recognized schemas to the latest internal 1294 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1295 type: string 1296 kind: 1297 description: 'Kind is a string value representing the REST resource this object 1298 represents. Servers may infer this from the endpoint the client submits 1299 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1300 type: string 1301 metadata: 1302 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 1303 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 1304 spec: 1305 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivitySpec' 1306 status: 1307 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivityStatus' 1308 type: object 1309 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivityList: 1310 description: PipelineActivityList is a list of PipelineActivity resources 1311 properties: 1312 apiVersion: 1313 description: 'APIVersion defines the versioned schema of this representation 1314 of an object. Servers should convert recognized schemas to the latest internal 1315 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1316 type: string 1317 items: 1318 items: 1319 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivity' 1320 type: array 1321 kind: 1322 description: 'Kind is a string value representing the REST resource this object 1323 represents. Servers may infer this from the endpoint the client submits 1324 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1325 type: string 1326 metadata: 1327 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 1328 required: 1329 - metadata 1330 - items 1331 type: object 1332 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivitySpec: 1333 description: PipelineActivitySpec is the specification of the pipeline activity 1334 properties: 1335 attachments: 1336 items: 1337 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Attachment' 1338 type: array 1339 author: 1340 type: string 1341 authorAvatarURL: 1342 type: string 1343 authorURL: 1344 type: string 1345 baseSHA: 1346 type: string 1347 batchPipelineActivity: 1348 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BatchPipelineActivity' 1349 build: 1350 type: string 1351 buildLogsUrl: 1352 type: string 1353 buildUrl: 1354 type: string 1355 completedTimestamp: 1356 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1357 context: 1358 type: string 1359 gitBranch: 1360 type: string 1361 gitOwner: 1362 type: string 1363 gitRepository: 1364 type: string 1365 gitUrl: 1366 type: string 1367 lastCommitMessage: 1368 type: string 1369 lastCommitSHA: 1370 type: string 1371 lastCommitURL: 1372 type: string 1373 pipeline: 1374 type: string 1375 postExtensions: 1376 items: 1377 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExtensionExecution' 1378 type: array 1379 pullTitle: 1380 type: string 1381 releaseNotesURL: 1382 type: string 1383 startedTimestamp: 1384 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1385 status: 1386 type: string 1387 steps: 1388 items: 1389 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivityStep' 1390 type: array 1391 version: 1392 type: string 1393 workflow: 1394 description: Deprecated - Workflow functionality was removed and is obsolete 1395 Keeping these fields to ensure backwards compatibility Should be removed 1396 when we increment spec version 1397 type: string 1398 workflowMessage: 1399 type: string 1400 workflowStatus: 1401 type: string 1402 type: object 1403 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivityStatus: 1404 description: PipelineActivityStatus is the status for an Environment resource 1405 properties: 1406 version: 1407 type: string 1408 type: object 1409 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineActivityStep: 1410 description: PipelineActivityStep represents a step in a pipeline activity 1411 properties: 1412 kind: 1413 type: string 1414 preview: 1415 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PreviewActivityStep' 1416 promote: 1417 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteActivityStep' 1418 stage: 1419 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.StageActivityStep' 1420 type: object 1421 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineExtension: 1422 description: PipelineExtension defines the image and command of an app which wants 1423 to modify/extend the pipeline 1424 properties: 1425 args: 1426 description: Arguments to the entrypoint. 1427 items: 1428 type: string 1429 type: array 1430 command: 1431 description: Entrypoint array. Not executed within a shell. 1432 type: string 1433 image: 1434 description: Docker image name. 1435 type: string 1436 name: 1437 description: Name of the container specified as a DNS_LABEL. 1438 type: string 1439 required: 1440 - name 1441 type: object 1442 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineStructure: 1443 description: PipelineStructure contains references to the Pipeline and PipelineRun, 1444 and a list of PipelineStructureStages in the pipeline. This allows us to map 1445 between a running Pod to its TaskRun, to the TaskRun's Task and PipelineRun, 1446 and finally from there to the stage and potential parent stages that the Pod 1447 is actually executing, for use with populating PipelineActivity and providing 1448 logs. 1449 properties: 1450 apiVersion: 1451 description: 'APIVersion defines the versioned schema of this representation 1452 of an object. Servers should convert recognized schemas to the latest internal 1453 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1454 type: string 1455 kind: 1456 description: 'Kind is a string value representing the REST resource this object 1457 represents. Servers may infer this from the endpoint the client submits 1458 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1459 type: string 1460 metadata: 1461 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 1462 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 1463 pipelineRef: 1464 type: string 1465 pipelineRunRef: 1466 type: string 1467 stages: 1468 items: 1469 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineStructureStage' 1470 type: array 1471 required: 1472 - pipelineRef 1473 - pipelineRunRef 1474 type: object 1475 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineStructureList: 1476 description: PipelineStructureList is a list of PipelineStructureList resources 1477 properties: 1478 apiVersion: 1479 description: 'APIVersion defines the versioned schema of this representation 1480 of an object. Servers should convert recognized schemas to the latest internal 1481 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1482 type: string 1483 items: 1484 items: 1485 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineStructure' 1486 type: array 1487 kind: 1488 description: 'Kind is a string value representing the REST resource this object 1489 represents. Servers may infer this from the endpoint the client submits 1490 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1491 type: string 1492 metadata: 1493 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 1494 required: 1495 - metadata 1496 - items 1497 type: object 1498 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PipelineStructureStage: 1499 description: PipelineStructureStage contains the stage's name, one of either a 1500 reference to the Task corresponding to the stage if it has steps, a list of 1501 sequential stage names nested within this stage, or a list of parallel stage 1502 names nested within this stage, and information on this stage's depth within 1503 the PipelineStructure as a whole, the name of its parent stage, if any, the 1504 name of the stage before it in execution order, if any, and the name of the 1505 stage after it in execution order, if any. 1506 properties: 1507 depth: 1508 format: byte 1509 type: integer 1510 name: 1511 type: string 1512 next: 1513 type: string 1514 parallel: 1515 items: 1516 type: string 1517 type: array 1518 parent: 1519 type: string 1520 previous: 1521 type: string 1522 stages: 1523 items: 1524 type: string 1525 type: array 1526 taskRef: 1527 description: Must have one of TaskRef+TaskRunRef, Stages, or Parallel 1528 type: string 1529 taskRunRef: 1530 description: Populated during pod discovery, not at initial creation time. 1531 type: string 1532 required: 1533 - name 1534 - depth 1535 type: object 1536 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Plugin: 1537 description: Plugin represents a binary plugin installed into this Jenkins X team 1538 properties: 1539 apiVersion: 1540 description: 'APIVersion defines the versioned schema of this representation 1541 of an object. Servers should convert recognized schemas to the latest internal 1542 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1543 type: string 1544 kind: 1545 description: 'Kind is a string value representing the REST resource this object 1546 represents. Servers may infer this from the endpoint the client submits 1547 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1548 type: string 1549 metadata: 1550 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 1551 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 1552 spec: 1553 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PluginSpec' 1554 type: object 1555 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PluginList: 1556 description: PluginList is a list of Plugins available for a team 1557 properties: 1558 apiVersion: 1559 description: 'APIVersion defines the versioned schema of this representation 1560 of an object. Servers should convert recognized schemas to the latest internal 1561 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1562 type: string 1563 items: 1564 items: 1565 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Plugin' 1566 type: array 1567 kind: 1568 description: 'Kind is a string value representing the REST resource this object 1569 represents. Servers may infer this from the endpoint the client submits 1570 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1571 type: string 1572 metadata: 1573 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 1574 required: 1575 - metadata 1576 - items 1577 type: object 1578 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PluginSpec: 1579 description: PluginSpec provides details of a binary plugin available for a team 1580 properties: 1581 binaries: 1582 items: 1583 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Binary' 1584 type: array 1585 description: 1586 type: string 1587 group: 1588 type: string 1589 name: 1590 type: string 1591 subCommand: 1592 type: string 1593 version: 1594 type: string 1595 type: object 1596 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Postsubmit: 1597 description: Postsubmit runs on push events. 1598 properties: 1599 Brancher: 1600 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Brancher' 1601 JobBase: 1602 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.JobBase' 1603 RegexpChangeMatcher: 1604 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.RegexpChangeMatcher' 1605 context: 1606 description: Context is the name of the GitHub status context for the job. 1607 type: string 1608 report: 1609 description: Report will comment and set status on GitHub. 1610 type: boolean 1611 required: 1612 - context 1613 type: object 1614 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Postsubmits: 1615 description: Postsubmits is a list of Postsubmit job configurations that can optionally 1616 completely replace the Postsubmit job configurations in the parent scheduler 1617 properties: 1618 entries: 1619 description: Items are the post submit configurations 1620 items: 1621 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Postsubmit' 1622 type: array 1623 replace: 1624 description: Replace the existing entries 1625 type: boolean 1626 type: object 1627 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Presubmit: 1628 description: Presubmit defines a job configuration for pull requests 1629 properties: 1630 Brancher: 1631 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Brancher' 1632 JobBase: 1633 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.JobBase' 1634 RegexpChangeMatcher: 1635 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.RegexpChangeMatcher' 1636 alwaysRun: 1637 description: AlwaysRun automatically for every PR, or only when a comment 1638 triggers it. By default true. 1639 type: boolean 1640 context: 1641 description: Context is the name of the Git Provider status context for the 1642 job. 1643 type: string 1644 context_options: 1645 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.RepoContextPolicy' 1646 description: ContextOptions defines the merge options. If not set it will 1647 infer the required and optional contexts from the jobs configured and use 1648 the Git Provider combined status; otherwise it may apply the branch protection 1649 setting or let user define their own options in case branch protection is 1650 not used. 1651 mergeMethod: 1652 description: Override the default method of merge. Valid options are squash, 1653 rebase, and merge. 1654 type: string 1655 optional: 1656 description: Optional indicates that the job's status context should not be 1657 required for merge. By default false. 1658 type: boolean 1659 policy: 1660 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ProtectionPolicies' 1661 queries: 1662 items: 1663 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Query' 1664 type: array 1665 report: 1666 description: Report enables reporting the job status on the git provider 1667 type: boolean 1668 rerunCommand: 1669 description: 'The RerunCommand to give users. Must match Trigger. Trigger 1670 must also be specified if this field is specified. (Default: `/test <job 1671 name>`)' 1672 type: string 1673 trigger: 1674 description: 'Trigger is the regular expression to trigger the job. e.g. `@k8s-bot 1675 e2e test this` RerunCommand must also be specified if this field is specified. 1676 (Default: `(?m)^/test (?:.*? )?<job name>(?: .*?)?$`)' 1677 type: string 1678 required: 1679 - alwaysRun 1680 - context 1681 - trigger 1682 - rerunCommand 1683 type: object 1684 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Presubmits: 1685 description: Presubmits is a list of Presubmit job configurations that can optionally 1686 completely replace the Presubmit job configurations in the parent scheduler 1687 properties: 1688 entries: 1689 description: Items are the Presubmit configurtations 1690 items: 1691 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Presubmit' 1692 type: array 1693 replace: 1694 description: Replace the existing entries 1695 type: boolean 1696 type: object 1697 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PreviewActivityStep: 1698 description: PreviewActivityStep is the step of creating a preview environment 1699 as part of a Pull Request pipeline 1700 properties: 1701 applicationURL: 1702 type: string 1703 completedTimestamp: 1704 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1705 description: 1706 type: string 1707 environment: 1708 type: string 1709 name: 1710 type: string 1711 pullRequestURL: 1712 type: string 1713 startedTimestamp: 1714 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1715 status: 1716 type: string 1717 type: object 1718 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PreviewGitSpec: 1719 description: PreviewGitSpec is the preview git branch/pull request details 1720 properties: 1721 appName: 1722 type: string 1723 applicationURL: 1724 type: string 1725 buildStatus: 1726 type: string 1727 buildStatusUrl: 1728 type: string 1729 description: 1730 type: string 1731 name: 1732 type: string 1733 title: 1734 type: string 1735 url: 1736 type: string 1737 user: 1738 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserSpec' 1739 type: object 1740 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteActivityStep: 1741 description: PromoteActivityStep is the step of promoting a version of an application 1742 to an environment 1743 properties: 1744 applicationURL: 1745 type: string 1746 completedTimestamp: 1747 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1748 description: 1749 type: string 1750 environment: 1751 type: string 1752 name: 1753 type: string 1754 pullRequest: 1755 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromotePullRequestStep' 1756 startedTimestamp: 1757 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1758 status: 1759 type: string 1760 update: 1761 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteUpdateStep' 1762 type: object 1763 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromotePullRequestStep: 1764 description: PromotePullRequestStep is the step for promoting a version to an 1765 environment by raising a Pull Request on the git repository of the environment 1766 properties: 1767 completedTimestamp: 1768 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1769 description: 1770 type: string 1771 mergeCommitSHA: 1772 type: string 1773 name: 1774 type: string 1775 pullRequestURL: 1776 type: string 1777 startedTimestamp: 1778 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1779 status: 1780 type: string 1781 type: object 1782 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteUpdateStep: 1783 description: PromoteUpdateStep is the step for updating a promotion after the 1784 Pull Request merges to master 1785 properties: 1786 completedTimestamp: 1787 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1788 description: 1789 type: string 1790 name: 1791 type: string 1792 startedTimestamp: 1793 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 1794 status: 1795 type: string 1796 statuses: 1797 items: 1798 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GitStatus' 1799 type: array 1800 type: object 1801 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteWorkflowStep: 1802 description: PromoteWorkflowStep is the step of promoting a version of an application 1803 to an environment 1804 properties: 1805 environment: 1806 type: string 1807 type: object 1808 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ProtectionPolicies: 1809 description: ProtectionPolicies defines the branch protection policies 1810 properties: 1811 ProtectionPolicy: 1812 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ProtectionPolicy' 1813 Replace: 1814 type: boolean 1815 entries: 1816 additionalProperties: 1817 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ProtectionPolicy' 1818 type: object 1819 type: object 1820 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ProtectionPolicy: 1821 description: ProtectionPolicy for merging. 1822 properties: 1823 enforceAdmins: 1824 description: Admins overrides whether protections apply to admins if set. 1825 type: boolean 1826 protect: 1827 description: Protect overrides whether branch protection is enabled if set. 1828 type: boolean 1829 requiredPullRequestReviews: 1830 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReviewPolicy' 1831 description: RequiredPullRequestReviews specifies approval/review criteria. 1832 requiredStatusChecks: 1833 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.BranchProtectionContextPolicy' 1834 description: RequiredStatusChecks configures github contexts 1835 restrictions: 1836 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Restrictions' 1837 description: Restrictions limits who can merge 1838 type: object 1839 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PullRequestInfo: 1840 description: PullRequestInfo contains information about a PR included in a batch, 1841 like its PR number, the last build number, and SHA 1842 properties: 1843 lastBuildNumberForCommit: 1844 description: LastBuildNumberForCommit is the number of the last successful 1845 build of this PR outside of a batch 1846 type: string 1847 lastBuildSHA: 1848 description: LastBuildSHA is the commit SHA in the last successful build of 1849 this PR outside of a batch. 1850 type: string 1851 pullRequestNumber: 1852 type: string 1853 type: object 1854 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Query: 1855 description: 'Query is turned into a Git Provider search query. See the docs for 1856 details: https://help.github.com/articles/searching-issues-and-pull-requests/' 1857 properties: 1858 excludedBranches: 1859 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 1860 includedBranches: 1861 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 1862 labels: 1863 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 1864 milestone: 1865 type: string 1866 missingLabels: 1867 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 1868 reviewApprovedRequired: 1869 type: boolean 1870 type: object 1871 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.QuickStartLocation: 1872 description: QuickStartLocation 1873 properties: 1874 excludes: 1875 items: 1876 type: string 1877 type: array 1878 gitKind: 1879 type: string 1880 gitUrl: 1881 type: string 1882 includes: 1883 items: 1884 type: string 1885 type: array 1886 owner: 1887 type: string 1888 type: object 1889 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.RegexpChangeMatcher: 1890 description: RegexpChangeMatcher is for code shared between jobs that run only 1891 when certain files are changed. 1892 properties: 1893 runIfChanged: 1894 description: RunIfChanged defines a regex used to select which subset of file 1895 changes should trigger this job. If any file in the changeset matches this 1896 regex, the job will be triggered 1897 type: string 1898 type: object 1899 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Release: 1900 description: Release represents a single version of an app that has been released 1901 properties: 1902 apiVersion: 1903 description: 'APIVersion defines the versioned schema of this representation 1904 of an object. Servers should convert recognized schemas to the latest internal 1905 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1906 type: string 1907 kind: 1908 description: 'Kind is a string value representing the REST resource this object 1909 represents. Servers may infer this from the endpoint the client submits 1910 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1911 type: string 1912 metadata: 1913 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 1914 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 1915 spec: 1916 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReleaseSpec' 1917 status: 1918 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReleaseStatus' 1919 type: object 1920 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReleaseList: 1921 description: ReleaseList is a list of Release resources 1922 properties: 1923 apiVersion: 1924 description: 'APIVersion defines the versioned schema of this representation 1925 of an object. Servers should convert recognized schemas to the latest internal 1926 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 1927 type: string 1928 items: 1929 items: 1930 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Release' 1931 type: array 1932 kind: 1933 description: 'Kind is a string value representing the REST resource this object 1934 represents. Servers may infer this from the endpoint the client submits 1935 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 1936 type: string 1937 metadata: 1938 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 1939 required: 1940 - metadata 1941 - items 1942 type: object 1943 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReleaseSpec: 1944 description: ReleaseSpec is the specification of the Release 1945 properties: 1946 commits: 1947 items: 1948 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CommitSummary' 1949 type: array 1950 dependencyUpdates: 1951 items: 1952 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DependencyUpdate' 1953 type: array 1954 gitCloneUrl: 1955 type: string 1956 gitHttpUrl: 1957 type: string 1958 gitOwner: 1959 type: string 1960 gitRepository: 1961 type: string 1962 issues: 1963 items: 1964 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.IssueSummary' 1965 type: array 1966 name: 1967 type: string 1968 pullRequests: 1969 items: 1970 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.IssueSummary' 1971 type: array 1972 releaseNotesURL: 1973 type: string 1974 version: 1975 type: string 1976 type: object 1977 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReleaseStatus: 1978 description: ReleaseStatus is the status of a release 1979 properties: 1980 status: 1981 type: string 1982 type: object 1983 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableMapOfStringContextPolicy: 1984 description: ReplaceableMapOfStringContextPolicy is a map of context policies 1985 that can optionally completely replace any context policies defined in the parent 1986 scheduler 1987 properties: 1988 Items: 1989 additionalProperties: 1990 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ContextPolicy' 1991 type: object 1992 replace: 1993 type: boolean 1994 required: 1995 - Items 1996 type: object 1997 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableMapOfStringString: 1998 description: ReplaceableMapOfStringString is a map of strings that can optionally 1999 completely replace the map of strings in the parent scheduler 2000 properties: 2001 entries: 2002 additionalProperties: 2003 type: string 2004 type: object 2005 replace: 2006 description: Replace the existing entries 2007 type: boolean 2008 type: object 2009 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfExternalPlugins: 2010 description: ReplaceableSliceOfExternalPlugins is a list of external plugins that 2011 can optionally completely replace the plugins in any parent SchedulerSpec 2012 properties: 2013 Replace: 2014 type: boolean 2015 entries: 2016 items: 2017 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ExternalPlugin' 2018 type: array 2019 required: 2020 - Replace 2021 type: object 2022 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings: 2023 description: ReplaceableSliceOfStrings is a slice of strings that can optionally 2024 completely replace the slice of strings defined in the parent scheduler 2025 properties: 2026 entries: 2027 description: Items is the string values 2028 items: 2029 type: string 2030 type: array 2031 replace: 2032 description: Replace the existing entries 2033 type: boolean 2034 type: object 2035 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.RepoContextPolicy: 2036 description: RepoContextPolicy overrides the policy for repo, and any branch overrides. 2037 properties: 2038 ContextPolicy: 2039 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ContextPolicy' 2040 branches: 2041 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableMapOfStringContextPolicy' 2042 required: 2043 - ContextPolicy 2044 type: object 2045 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ResourceReference: 2046 properties: 2047 apiVersion: 2048 description: API version of the referent. 2049 type: string 2050 kind: 2051 description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds' 2052 type: string 2053 name: 2054 description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names' 2055 type: string 2056 uid: 2057 description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids' 2058 type: string 2059 required: 2060 - kind 2061 - name 2062 type: object 2063 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Restrictions: 2064 description: Restrictions limits who can merge Users and Teams entries are appended 2065 to parent lists. 2066 properties: 2067 teams: 2068 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 2069 users: 2070 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 2071 required: 2072 - users 2073 - teams 2074 type: object 2075 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReviewPolicy: 2076 description: ReviewPolicy specifies git provider approval/review criteria. Any 2077 nil values inherit the policy from the parent, otherwise bool/ints are overridden. 2078 Non-empty lists are appended to parent lists. 2079 properties: 2080 dismissStaleReviews: 2081 description: DismissStale overrides whether new commits automatically dismiss 2082 old reviews if set 2083 type: boolean 2084 dismissalRestrictions: 2085 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Restrictions' 2086 description: Restrictions appends users/teams that are allowed to merge 2087 requireCodeOwnerReviews: 2088 description: RequireOwners overrides whether CODEOWNERS must approve PRs if 2089 set 2090 type: boolean 2091 requiredApprovingReviewCount: 2092 description: Approvals overrides the number of approvals required if set (set 2093 to 0 to disable) 2094 format: int32 2095 type: integer 2096 type: object 2097 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Scheduler: 2098 description: Scheduler is configuration for a pipeline scheduler 2099 properties: 2100 apiVersion: 2101 description: 'APIVersion defines the versioned schema of this representation 2102 of an object. Servers should convert recognized schemas to the latest internal 2103 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2104 type: string 2105 kind: 2106 description: 'Kind is a string value representing the REST resource this object 2107 represents. Servers may infer this from the endpoint the client submits 2108 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2109 type: string 2110 metadata: 2111 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 2112 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 2113 spec: 2114 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SchedulerSpec' 2115 type: object 2116 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SchedulerAgent: 2117 description: SchedulerAgent defines the scheduler agent configuration 2118 properties: 2119 agent: 2120 description: Agent defines the agent used to schedule jobs, by default Prow 2121 type: string 2122 required: 2123 - agent 2124 type: object 2125 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SchedulerList: 2126 description: SchedulerList is a list of configurations for a pipeline scheduler 2127 properties: 2128 apiVersion: 2129 description: 'APIVersion defines the versioned schema of this representation 2130 of an object. Servers should convert recognized schemas to the latest internal 2131 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2132 type: string 2133 items: 2134 items: 2135 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Scheduler' 2136 type: array 2137 kind: 2138 description: 'Kind is a string value representing the REST resource this object 2139 represents. Servers may infer this from the endpoint the client submits 2140 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2141 type: string 2142 metadata: 2143 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 2144 required: 2145 - metadata 2146 - items 2147 type: object 2148 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SchedulerSpec: 2149 description: SchedulerSpec defines the pipeline scheduler (e.g. Prow) configuration 2150 properties: 2151 approve: 2152 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Approve' 2153 attachments: 2154 items: 2155 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Attachment' 2156 type: array 2157 configUpdater: 2158 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ConfigUpdater' 2159 externalPlugins: 2160 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfExternalPlugins' 2161 lgtm: 2162 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Lgtm' 2163 merger: 2164 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Merger' 2165 periodics: 2166 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Periodics' 2167 plugins: 2168 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ReplaceableSliceOfStrings' 2169 description: Plugins is a list of plugin names enabled for a repo 2170 policy: 2171 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.GlobalProtectionPolicy' 2172 postsubmits: 2173 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Postsubmits' 2174 presubmits: 2175 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Presubmits' 2176 schedulerAgent: 2177 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SchedulerAgent' 2178 trigger: 2179 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Trigger' 2180 welcome: 2181 items: 2182 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Welcome' 2183 type: array 2184 type: object 2185 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepository: 2186 description: SourceRepository is the metadata for an Application/Project/SourceRepository 2187 properties: 2188 apiVersion: 2189 description: 'APIVersion defines the versioned schema of this representation 2190 of an object. Servers should convert recognized schemas to the latest internal 2191 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2192 type: string 2193 kind: 2194 description: 'Kind is a string value representing the REST resource this object 2195 represents. Servers may infer this from the endpoint the client submits 2196 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2197 type: string 2198 metadata: 2199 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 2200 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 2201 spec: 2202 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositorySpec' 2203 type: object 2204 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryGroup: 2205 description: SourceRepositoryGroup is the metadata for an Application/Project/SourceRepository 2206 properties: 2207 apiVersion: 2208 description: 'APIVersion defines the versioned schema of this representation 2209 of an object. Servers should convert recognized schemas to the latest internal 2210 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2211 type: string 2212 kind: 2213 description: 'Kind is a string value representing the REST resource this object 2214 represents. Servers may infer this from the endpoint the client submits 2215 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2216 type: string 2217 metadata: 2218 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 2219 spec: 2220 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryGroupSpec' 2221 type: object 2222 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryGroupList: 2223 description: SourceRepositoryGroupList is a structure used by k8s to store lists 2224 of apps 2225 properties: 2226 apiVersion: 2227 description: 'APIVersion defines the versioned schema of this representation 2228 of an object. Servers should convert recognized schemas to the latest internal 2229 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2230 type: string 2231 items: 2232 items: 2233 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryGroup' 2234 type: array 2235 kind: 2236 description: 'Kind is a string value representing the REST resource this object 2237 represents. Servers may infer this from the endpoint the client submits 2238 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2239 type: string 2240 metadata: 2241 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 2242 required: 2243 - metadata 2244 - items 2245 type: object 2246 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryGroupSpec: 2247 description: SourceRepositoryGroupSpec is the metadata for an Application/Project/SourceRepository 2248 properties: 2249 apiVersion: 2250 description: 'APIVersion defines the versioned schema of this representation 2251 of an object. Servers should convert recognized schemas to the latest internal 2252 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2253 type: string 2254 kind: 2255 description: 'Kind is a string value representing the REST resource this object 2256 represents. Servers may infer this from the endpoint the client submits 2257 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2258 type: string 2259 metadata: 2260 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 2261 repositories: 2262 items: 2263 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ResourceReference' 2264 type: array 2265 scheduler: 2266 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ResourceReference' 2267 required: 2268 - repositories 2269 - scheduler 2270 type: object 2271 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositoryList: 2272 description: SourceRepositoryList is a structure used by k8s to store lists of 2273 apps 2274 properties: 2275 apiVersion: 2276 description: 'APIVersion defines the versioned schema of this representation 2277 of an object. Servers should convert recognized schemas to the latest internal 2278 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2279 type: string 2280 items: 2281 items: 2282 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepository' 2283 type: array 2284 kind: 2285 description: 'Kind is a string value representing the REST resource this object 2286 represents. Servers may infer this from the endpoint the client submits 2287 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2288 type: string 2289 metadata: 2290 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 2291 required: 2292 - metadata 2293 - items 2294 type: object 2295 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.SourceRepositorySpec: 2296 description: SourceRepositorySpec provides details of the metadata for an App 2297 properties: 2298 description: 2299 type: string 2300 httpCloneURL: 2301 description: HTTPCloneURL is the git URL to clone this repository using HTTP/HTTPS 2302 type: string 2303 org: 2304 type: string 2305 provider: 2306 description: Provider stores the URL of the git provider such as https://github.com 2307 type: string 2308 providerKind: 2309 description: ProviderKind is the kind of provider (github / bitbucketcloud 2310 / bitbucketserver etc) 2311 type: string 2312 providerName: 2313 description: ProviderName is a logical name for the provider without any URL 2314 scheme which can be used in a label selector 2315 type: string 2316 repo: 2317 type: string 2318 scheduler: 2319 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ResourceReference' 2320 description: Scheduler a reference to a custom scheduler otherwise we default 2321 to the Team's Scededuler 2322 sshCloneURL: 2323 description: SSHCloneURL is the git URL to clone this repository using SSH 2324 type: string 2325 url: 2326 description: URL is the web URL of the project page 2327 type: string 2328 type: object 2329 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.StageActivityStep: 2330 description: StageActivityStep represents a stage of zero to more sub steps in 2331 a jenkins pipeline 2332 properties: 2333 completedTimestamp: 2334 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 2335 description: 2336 type: string 2337 name: 2338 type: string 2339 startedTimestamp: 2340 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 2341 status: 2342 type: string 2343 steps: 2344 items: 2345 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.CoreActivityStep' 2346 type: array 2347 type: object 2348 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Statement: 2349 description: Statement represents a decision that was made, for example that a 2350 promotion was approved or denied 2351 properties: 2352 measurementValue: 2353 type: boolean 2354 name: 2355 type: string 2356 statementType: 2357 type: string 2358 tags: 2359 items: 2360 type: string 2361 type: array 2362 required: 2363 - name 2364 - statementType 2365 - measurementValue 2366 type: object 2367 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.StorageLocation: 2368 description: StorageLocation 2369 properties: 2370 bucketUrl: 2371 type: string 2372 classifier: 2373 type: string 2374 gitBranch: 2375 type: string 2376 gitUrl: 2377 type: string 2378 type: object 2379 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Team: 2380 description: Team represents a request to create an actual Team which is a group 2381 of users, a development environment and optional other environments 2382 properties: 2383 apiVersion: 2384 description: 'APIVersion defines the versioned schema of this representation 2385 of an object. Servers should convert recognized schemas to the latest internal 2386 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2387 type: string 2388 kind: 2389 description: 'Kind is a string value representing the REST resource this object 2390 represents. Servers may infer this from the endpoint the client submits 2391 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2392 type: string 2393 metadata: 2394 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 2395 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 2396 spec: 2397 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamSpec' 2398 status: 2399 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamStatus' 2400 type: object 2401 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamList: 2402 description: TeamList is a list of TypeMeta resources 2403 properties: 2404 apiVersion: 2405 description: 'APIVersion defines the versioned schema of this representation 2406 of an object. Servers should convert recognized schemas to the latest internal 2407 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2408 type: string 2409 items: 2410 items: 2411 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Team' 2412 type: array 2413 kind: 2414 description: 'Kind is a string value representing the REST resource this object 2415 represents. Servers may infer this from the endpoint the client submits 2416 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2417 type: string 2418 metadata: 2419 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 2420 required: 2421 - metadata 2422 - items 2423 type: object 2424 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamSettings: 2425 description: TeamSettings the default settings for a team 2426 properties: 2427 appPrefixes: 2428 description: AppsPrefixes is the list of prefixes for appNames 2429 items: 2430 type: string 2431 type: array 2432 appsRepository: 2433 type: string 2434 askOnCreate: 2435 type: boolean 2436 bootRequirements: 2437 description: BootRequirements is a marshaled string of the jx-requirements.yml 2438 used in the most recent run for this cluster 2439 type: string 2440 branchPatterns: 2441 type: string 2442 buildPackName: 2443 type: string 2444 buildPackRef: 2445 type: string 2446 buildPackUrl: 2447 type: string 2448 defaultScheduler: 2449 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.ResourceReference' 2450 deployKind: 2451 description: DeployKind what kind of deployment ("default" uses regular Kubernetes 2452 Services and Deployments, "knative" uses the Knative Service resource instead) 2453 type: string 2454 deployOptions: 2455 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.DeployOptions' 2456 description: DeployOptions configures options for how to deploy applications 2457 by default such as using canary rollouts (progressive delivery) or using 2458 horizontal pod autoscaler 2459 dockerRegistryOrg: 2460 type: string 2461 envOrganisation: 2462 type: string 2463 forkBranchPatterns: 2464 type: string 2465 gitPublic: 2466 type: boolean 2467 gitServer: 2468 type: string 2469 helmBinary: 2470 type: string 2471 helmTemplate: 2472 type: boolean 2473 importMode: 2474 description: ImportMode indicates what kind of 2475 type: string 2476 kubeProvider: 2477 type: string 2478 noTiller: 2479 type: boolean 2480 organisation: 2481 type: string 2482 pipelineUserEmail: 2483 type: string 2484 pipelineUsername: 2485 type: string 2486 postPreviewJobs: 2487 items: 2488 $ref: '#/definitions/io.k8s.api.batch.v1.Job' 2489 type: array 2490 profile: 2491 description: Profile is the profile in use (see jx profile) 2492 type: string 2493 promotionEngine: 2494 type: string 2495 prowConfig: 2496 description: ProwConfig is the way we manage prow configurations 2497 type: string 2498 prowEngine: 2499 description: ProwEngine is the kind of prow engine used such as knative build 2500 or build pipeline 2501 type: string 2502 quickstartLocations: 2503 items: 2504 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.QuickStartLocation' 2505 type: array 2506 storageLocations: 2507 items: 2508 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.StorageLocation' 2509 type: array 2510 useGitOps: 2511 type: boolean 2512 versionStreamRef: 2513 description: VersionStreamRef contains the git ref (tag or branch) in the 2514 VersionStreamURL repository to use as the version stream 2515 type: string 2516 versionStreamUrl: 2517 description: VersionStreamURL contains the git clone URL for the Version Stream 2518 which is the set of versions to use for charts, images, packages etc 2519 type: string 2520 type: object 2521 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamSpec: 2522 description: TeamSpec is the specification of an Team 2523 properties: 2524 kind: 2525 type: string 2526 label: 2527 type: string 2528 members: 2529 items: 2530 type: string 2531 type: array 2532 type: object 2533 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.TeamStatus: 2534 description: TeamStatus is the status for an Team resource 2535 properties: 2536 message: 2537 type: string 2538 provisionStatus: 2539 type: string 2540 type: object 2541 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Trigger: 2542 description: |- 2543 Trigger specifies a configuration for a single trigger. 2544 2545 The configuration for the trigger plugin is defined as a list of these structures. 2546 properties: 2547 ignoreOkToTest: 2548 description: IgnoreOkToTest makes trigger ignore /ok-to-test comments. This 2549 is a security mitigation to only allow testing from trusted users. 2550 type: boolean 2551 joinOrgUrl: 2552 description: JoinOrgURL is a link that redirects users to a location where 2553 they should be able to read more about joining the organization in order 2554 to become trusted members. Defaults to the Github link of TrustedOrg. 2555 type: string 2556 onlyOrgMembers: 2557 description: OnlyOrgMembers requires PRs and/or /ok-to-test comments to come 2558 from org members. By default, trigger also include repo collaborators. 2559 type: boolean 2560 trustedOrg: 2561 description: TrustedOrg is the org whose members' PRs will be automatically 2562 built for PRs to the above repos. The default is the PR's org. 2563 type: string 2564 type: object 2565 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.User: 2566 description: User represents a git user so we have a cache to find by email address 2567 properties: 2568 apiVersion: 2569 description: 'APIVersion defines the versioned schema of this representation 2570 of an object. Servers should convert recognized schemas to the latest internal 2571 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2572 type: string 2573 kind: 2574 description: 'Kind is a string value representing the REST resource this object 2575 represents. Servers may infer this from the endpoint the client submits 2576 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2577 type: string 2578 metadata: 2579 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 2580 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 2581 spec: 2582 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails' 2583 user: 2584 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails' 2585 description: Deprecated, use Spec 2586 type: object 2587 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserDetails: 2588 description: UserDetails containers details of a user 2589 properties: 2590 accountReference: 2591 items: 2592 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.AccountReference' 2593 type: array 2594 avatarUrl: 2595 type: string 2596 creationTimestamp: 2597 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 2598 email: 2599 type: string 2600 externalUser: 2601 type: boolean 2602 login: 2603 type: string 2604 name: 2605 type: string 2606 serviceAccount: 2607 type: string 2608 url: 2609 type: string 2610 type: object 2611 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserList: 2612 description: UserList is a list of User resources 2613 properties: 2614 apiVersion: 2615 description: 'APIVersion defines the versioned schema of this representation 2616 of an object. Servers should convert recognized schemas to the latest internal 2617 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2618 type: string 2619 items: 2620 items: 2621 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.User' 2622 type: array 2623 kind: 2624 description: 'Kind is a string value representing the REST resource this object 2625 represents. Servers may infer this from the endpoint the client submits 2626 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2627 type: string 2628 metadata: 2629 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 2630 required: 2631 - metadata 2632 - items 2633 type: object 2634 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.UserSpec: 2635 description: UserSpec is the user details 2636 properties: 2637 imageUrl: 2638 type: string 2639 linkUrl: 2640 type: string 2641 name: 2642 type: string 2643 username: 2644 type: string 2645 type: object 2646 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Welcome: 2647 description: Welcome welcome plugin config 2648 properties: 2649 message_template: 2650 type: string 2651 type: object 2652 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Workflow: 2653 description: Workflow represents pipeline activity for a particular run of a pipeline 2654 properties: 2655 apiVersion: 2656 description: 'APIVersion defines the versioned schema of this representation 2657 of an object. Servers should convert recognized schemas to the latest internal 2658 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2659 type: string 2660 kind: 2661 description: 'Kind is a string value representing the REST resource this object 2662 represents. Servers may infer this from the endpoint the client submits 2663 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2664 type: string 2665 metadata: 2666 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 2667 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata' 2668 spec: 2669 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowSpec' 2670 status: 2671 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowStatus' 2672 type: object 2673 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowList: 2674 description: WorkflowList is a list of Workflow resources 2675 properties: 2676 apiVersion: 2677 description: 'APIVersion defines the versioned schema of this representation 2678 of an object. Servers should convert recognized schemas to the latest internal 2679 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2680 type: string 2681 items: 2682 items: 2683 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.Workflow' 2684 type: array 2685 kind: 2686 description: 'Kind is a string value representing the REST resource this object 2687 represents. Servers may infer this from the endpoint the client submits 2688 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2689 type: string 2690 metadata: 2691 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta' 2692 required: 2693 - metadata 2694 - items 2695 type: object 2696 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowPreconditions: 2697 description: WorkflowPreconditions is the trigger to start a step 2698 properties: 2699 environments: 2700 description: the names of the environments which need to have promoted before 2701 this step can be triggered 2702 items: 2703 type: string 2704 type: array 2705 type: object 2706 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowSpec: 2707 description: WorkflowSpec is the specification of the pipeline activity 2708 properties: 2709 pipeline: 2710 type: string 2711 steps: 2712 items: 2713 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowStep' 2714 type: array 2715 type: object 2716 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowStatus: 2717 description: WorkflowStatus is the status for an Environment resource 2718 properties: 2719 version: 2720 type: string 2721 type: object 2722 com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowStep: 2723 description: WorkflowStep represents a step in a pipeline activity 2724 properties: 2725 description: 2726 type: string 2727 kind: 2728 type: string 2729 name: 2730 type: string 2731 promote: 2732 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.PromoteWorkflowStep' 2733 trigger: 2734 $ref: '#/definitions/com.github.jenkins-x.jx-api.pkg.apis.jenkins_io.v1.WorkflowPreconditions' 2735 type: object 2736 io.k8s.api.batch.v1.Job: 2737 description: Job represents the configuration of a single job. 2738 properties: 2739 apiVersion: 2740 description: 'APIVersion defines the versioned schema of this representation 2741 of an object. Servers should convert recognized schemas to the latest internal 2742 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 2743 type: string 2744 kind: 2745 description: 'Kind is a string value representing the REST resource this object 2746 represents. Servers may infer this from the endpoint the client submits 2747 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 2748 type: string 2749 metadata: 2750 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 2751 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata' 2752 spec: 2753 $ref: '#/definitions/io.k8s.api.batch.v1.JobSpec' 2754 description: 'Specification of the desired behavior of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status' 2755 status: 2756 $ref: '#/definitions/io.k8s.api.batch.v1.JobStatus' 2757 description: 'Current status of a job. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status' 2758 type: object 2759 io.k8s.api.batch.v1.JobCondition: 2760 description: JobCondition describes current state of a job. 2761 properties: 2762 lastProbeTime: 2763 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 2764 description: Last time the condition was checked. 2765 lastTransitionTime: 2766 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 2767 description: Last time the condition transit from one status to another. 2768 message: 2769 description: Human readable message indicating details about last transition. 2770 type: string 2771 reason: 2772 description: (brief) reason for the condition's last transition. 2773 type: string 2774 status: 2775 description: Status of the condition, one of True, False, Unknown. 2776 type: string 2777 type: 2778 description: Type of job condition, Complete or Failed. 2779 type: string 2780 required: 2781 - type 2782 - status 2783 type: object 2784 io.k8s.api.batch.v1.JobSpec: 2785 description: JobSpec describes how the job execution will look like. 2786 properties: 2787 activeDeadlineSeconds: 2788 description: Specifies the duration in seconds relative to the startTime that 2789 the job may be active before the system tries to terminate it; value must 2790 be positive integer 2791 format: int64 2792 type: integer 2793 backoffLimit: 2794 description: Specifies the number of retries before marking this job failed. 2795 Defaults to 6 2796 format: int32 2797 type: integer 2798 completions: 2799 description: 'Specifies the desired number of successfully finished pods the 2800 job should be run with. Setting to nil means that the success of any pod 2801 signals the success of all pods, and allows parallelism to have any positive 2802 value. Setting to 1 means that parallelism is limited to 1 and the success 2803 of that pod signals the success of the job. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/' 2804 format: int32 2805 type: integer 2806 manualSelector: 2807 description: 'manualSelector controls generation of pod labels and pod selectors. 2808 Leave `manualSelector` unset unless you are certain what you are doing. 2809 When false or unset, the system pick labels unique to this job and appends 2810 those labels to the pod template. When true, the user is responsible for 2811 picking unique labels and specifying the selector. Failure to pick a unique 2812 label may cause this and other jobs to not function correctly. However, 2813 You may see `manualSelector=true` in jobs that were created with the old 2814 `extensions/v1beta1` API. More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/#specifying-your-own-pod-selector' 2815 type: boolean 2816 parallelism: 2817 description: 'Specifies the maximum desired number of pods the job should 2818 run at any given time. The actual number of pods running in steady state 2819 will be less than this number when ((.spec.completions - .status.successful) 2820 < .spec.parallelism), i.e. when the work left to do is less than max parallelism. 2821 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/' 2822 format: int32 2823 type: integer 2824 selector: 2825 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector' 2826 description: 'A label query over pods that should match the pod count. Normally, 2827 the system sets this field for you. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors' 2828 template: 2829 $ref: '#/definitions/io.k8s.api.core.v1.PodTemplateSpec' 2830 description: 'Describes the pod that will be created when executing a job. 2831 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/' 2832 ttlSecondsAfterFinished: 2833 description: ttlSecondsAfterFinished limits the lifetime of a Job that has 2834 finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished 2835 after the Job finishes, it is eligible to be automatically deleted. When 2836 the Job is being deleted, its lifecycle guarantees (e.g. finalizers) will 2837 be honored. If this field is unset, the Job won't be automatically deleted. 2838 If this field is set to zero, the Job becomes eligible to be deleted immediately 2839 after it finishes. This field is alpha-level and is only honored by servers 2840 that enable the TTLAfterFinished feature. 2841 format: int32 2842 type: integer 2843 required: 2844 - template 2845 type: object 2846 io.k8s.api.batch.v1.JobStatus: 2847 description: JobStatus represents the current state of a Job. 2848 properties: 2849 active: 2850 description: The number of actively running pods. 2851 format: int32 2852 type: integer 2853 completionTime: 2854 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 2855 description: Represents time when the job was completed. It is not guaranteed 2856 to be set in happens-before order across separate operations. It is represented 2857 in RFC3339 form and is in UTC. 2858 conditions: 2859 description: 'The latest available observations of an object''s current state. 2860 More info: https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/' 2861 items: 2862 $ref: '#/definitions/io.k8s.api.batch.v1.JobCondition' 2863 type: array 2864 x-kubernetes-patch-merge-key: type 2865 x-kubernetes-patch-strategy: merge 2866 failed: 2867 description: The number of pods which reached phase Failed. 2868 format: int32 2869 type: integer 2870 startTime: 2871 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 2872 description: Represents time when the job was acknowledged by the job controller. 2873 It is not guaranteed to be set in happens-before order across separate operations. 2874 It is represented in RFC3339 form and is in UTC. 2875 succeeded: 2876 description: The number of pods which reached phase Succeeded. 2877 format: int32 2878 type: integer 2879 type: object 2880 io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource: 2881 description: |- 2882 Represents a Persistent Disk resource in AWS. 2883 2884 An AWS EBS disk must exist before mounting to a container. The disk must also be in the same AWS zone as the kubelet. An AWS EBS disk can only be mounted as read/write once. AWS EBS volumes support ownership management and SELinux relabeling. 2885 properties: 2886 fsType: 2887 description: 'Filesystem type of the volume that you want to mount. Tip: Ensure 2888 that the filesystem type is supported by the host operating system. Examples: 2889 "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. 2890 More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore' 2891 type: string 2892 partition: 2893 description: 'The partition in the volume that you want to mount. If omitted, 2894 the default is to mount by volume name. Examples: For volume /dev/sda1, 2895 you specify the partition as "1". Similarly, the volume partition for /dev/sda 2896 is "0" (or you can leave the property empty).' 2897 format: int32 2898 type: integer 2899 readOnly: 2900 description: 'Specify "true" to force and set the ReadOnly property in VolumeMounts 2901 to "true". If omitted, the default is "false". More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore' 2902 type: boolean 2903 volumeID: 2904 description: 'Unique ID of the persistent disk resource in AWS (Amazon EBS 2905 volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore' 2906 type: string 2907 required: 2908 - volumeID 2909 type: object 2910 io.k8s.api.core.v1.Affinity: 2911 description: Affinity is a group of affinity scheduling rules. 2912 properties: 2913 nodeAffinity: 2914 $ref: '#/definitions/io.k8s.api.core.v1.NodeAffinity' 2915 description: Describes node affinity scheduling rules for the pod. 2916 podAffinity: 2917 $ref: '#/definitions/io.k8s.api.core.v1.PodAffinity' 2918 description: Describes pod affinity scheduling rules (e.g. co-locate this 2919 pod in the same node, zone, etc. as some other pod(s)). 2920 podAntiAffinity: 2921 $ref: '#/definitions/io.k8s.api.core.v1.PodAntiAffinity' 2922 description: Describes pod anti-affinity scheduling rules (e.g. avoid putting 2923 this pod in the same node, zone, etc. as some other pod(s)). 2924 type: object 2925 io.k8s.api.core.v1.AzureDiskVolumeSource: 2926 description: AzureDisk represents an Azure Data Disk mount on the host and bind 2927 mount to the pod. 2928 properties: 2929 cachingMode: 2930 description: 'Host Caching mode: None, Read Only, Read Write.' 2931 type: string 2932 diskName: 2933 description: The Name of the data disk in the blob storage 2934 type: string 2935 diskURI: 2936 description: The URI the data disk in the blob storage 2937 type: string 2938 fsType: 2939 description: Filesystem type to mount. Must be a filesystem type supported 2940 by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred 2941 to be "ext4" if unspecified. 2942 type: string 2943 kind: 2944 description: 'Expected values Shared: multiple blob disks per storage account Dedicated: 2945 single blob disk per storage account Managed: azure managed data disk (only 2946 in managed availability set). defaults to shared' 2947 type: string 2948 readOnly: 2949 description: Defaults to false (read/write). ReadOnly here will force the 2950 ReadOnly setting in VolumeMounts. 2951 type: boolean 2952 required: 2953 - diskName 2954 - diskURI 2955 type: object 2956 io.k8s.api.core.v1.AzureFileVolumeSource: 2957 description: AzureFile represents an Azure File Service mount on the host and 2958 bind mount to the pod. 2959 properties: 2960 readOnly: 2961 description: Defaults to false (read/write). ReadOnly here will force the 2962 ReadOnly setting in VolumeMounts. 2963 type: boolean 2964 secretName: 2965 description: the name of secret that contains Azure Storage Account Name and 2966 Key 2967 type: string 2968 shareName: 2969 description: Share Name 2970 type: string 2971 required: 2972 - secretName 2973 - shareName 2974 type: object 2975 io.k8s.api.core.v1.CSIVolumeSource: 2976 description: Represents a source location of a volume to mount, managed by an 2977 external CSI driver 2978 properties: 2979 driver: 2980 description: Driver is the name of the CSI driver that handles this volume. 2981 Consult with your admin for the correct name as registered in the cluster. 2982 type: string 2983 fsType: 2984 description: Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". If not provided, 2985 the empty value is passed to the associated CSI driver which will determine 2986 the default filesystem to apply. 2987 type: string 2988 nodePublishSecretRef: 2989 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 2990 description: NodePublishSecretRef is a reference to the secret object containing 2991 sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume 2992 and NodeUnpublishVolume calls. This field is optional, and may be empty 2993 if no secret is required. If the secret object contains more than one secret, 2994 all secret references are passed. 2995 readOnly: 2996 description: Specifies a read-only configuration for the volume. Defaults 2997 to false (read/write). 2998 type: boolean 2999 volumeAttributes: 3000 additionalProperties: 3001 type: string 3002 description: VolumeAttributes stores driver-specific properties that are passed 3003 to the CSI driver. Consult your driver's documentation for supported values. 3004 type: object 3005 required: 3006 - driver 3007 type: object 3008 io.k8s.api.core.v1.Capabilities: 3009 description: Adds and removes POSIX capabilities from running containers. 3010 properties: 3011 add: 3012 description: Added capabilities 3013 items: 3014 type: string 3015 type: array 3016 drop: 3017 description: Removed capabilities 3018 items: 3019 type: string 3020 type: array 3021 type: object 3022 io.k8s.api.core.v1.CephFSVolumeSource: 3023 description: Represents a Ceph Filesystem mount that lasts the lifetime of a pod 3024 Cephfs volumes do not support ownership management or SELinux relabeling. 3025 properties: 3026 monitors: 3027 description: 'Required: Monitors is a collection of Ceph monitors More info: 3028 https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' 3029 items: 3030 type: string 3031 type: array 3032 path: 3033 description: 'Optional: Used as the mounted root, rather than the full Ceph 3034 tree, default is /' 3035 type: string 3036 readOnly: 3037 description: 'Optional: Defaults to false (read/write). ReadOnly here will 3038 force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' 3039 type: boolean 3040 secretFile: 3041 description: 'Optional: SecretFile is the path to key ring for User, default 3042 is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' 3043 type: string 3044 secretRef: 3045 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 3046 description: 'Optional: SecretRef is reference to the authentication secret 3047 for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' 3048 user: 3049 description: 'Optional: User is the rados user name, default is admin More 3050 info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it' 3051 type: string 3052 required: 3053 - monitors 3054 type: object 3055 io.k8s.api.core.v1.CinderVolumeSource: 3056 description: Represents a cinder volume resource in Openstack. A Cinder volume 3057 must exist before mounting to a container. The volume must also be in the same 3058 region as the kubelet. Cinder volumes support ownership management and SELinux 3059 relabeling. 3060 properties: 3061 fsType: 3062 description: 'Filesystem type to mount. Must be a filesystem type supported 3063 by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly 3064 inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md' 3065 type: string 3066 readOnly: 3067 description: 'Optional: Defaults to false (read/write). ReadOnly here will 3068 force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md' 3069 type: boolean 3070 secretRef: 3071 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 3072 description: 'Optional: points to a secret object containing parameters used 3073 to connect to OpenStack.' 3074 volumeID: 3075 description: 'volume id used to identify the volume in cinder. More info: 3076 https://examples.k8s.io/mysql-cinder-pd/README.md' 3077 type: string 3078 required: 3079 - volumeID 3080 type: object 3081 io.k8s.api.core.v1.ConfigMapEnvSource: 3082 description: |- 3083 ConfigMapEnvSource selects a ConfigMap to populate the environment variables with. 3084 3085 The contents of the target ConfigMap's Data field will represent the key-value pairs as environment variables. 3086 properties: 3087 name: 3088 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 3089 type: string 3090 optional: 3091 description: Specify whether the ConfigMap must be defined 3092 type: boolean 3093 type: object 3094 io.k8s.api.core.v1.ConfigMapKeySelector: 3095 description: Selects a key from a ConfigMap. 3096 properties: 3097 key: 3098 description: The key to select. 3099 type: string 3100 name: 3101 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 3102 type: string 3103 optional: 3104 description: Specify whether the ConfigMap or its key must be defined 3105 type: boolean 3106 required: 3107 - key 3108 type: object 3109 io.k8s.api.core.v1.ConfigMapProjection: 3110 description: |- 3111 Adapts a ConfigMap into a projected volume. 3112 3113 The contents of the target ConfigMap's Data field will be presented in a projected volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. Note that this is identical to a configmap volume source without the default mode. 3114 properties: 3115 items: 3116 description: If unspecified, each key-value pair in the Data field of the 3117 referenced ConfigMap will be projected into the volume as a file whose name 3118 is the key and content is the value. If specified, the listed keys will 3119 be projected into the specified paths, and unlisted keys will not be present. 3120 If a key is specified which is not present in the ConfigMap, the volume 3121 setup will error unless it is marked optional. Paths must be relative and 3122 may not contain the '..' path or start with '..'. 3123 items: 3124 $ref: '#/definitions/io.k8s.api.core.v1.KeyToPath' 3125 type: array 3126 name: 3127 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 3128 type: string 3129 optional: 3130 description: Specify whether the ConfigMap or its keys must be defined 3131 type: boolean 3132 type: object 3133 io.k8s.api.core.v1.ConfigMapVolumeSource: 3134 description: |- 3135 Adapts a ConfigMap into a volume. 3136 3137 The contents of the target ConfigMap's Data field will be presented in a volume as files using the keys in the Data field as the file names, unless the items element is populated with specific mappings of keys to paths. ConfigMap volumes support ownership management and SELinux relabeling. 3138 properties: 3139 defaultMode: 3140 description: 'Optional: mode bits to use on created files by default. Must 3141 be a value between 0 and 0777. Defaults to 0644. Directories within the 3142 path are not affected by this setting. This might be in conflict with other 3143 options that affect the file mode, like fsGroup, and the result can be other 3144 mode bits set.' 3145 format: int32 3146 type: integer 3147 items: 3148 description: If unspecified, each key-value pair in the Data field of the 3149 referenced ConfigMap will be projected into the volume as a file whose name 3150 is the key and content is the value. If specified, the listed keys will 3151 be projected into the specified paths, and unlisted keys will not be present. 3152 If a key is specified which is not present in the ConfigMap, the volume 3153 setup will error unless it is marked optional. Paths must be relative and 3154 may not contain the '..' path or start with '..'. 3155 items: 3156 $ref: '#/definitions/io.k8s.api.core.v1.KeyToPath' 3157 type: array 3158 name: 3159 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 3160 type: string 3161 optional: 3162 description: Specify whether the ConfigMap or its keys must be defined 3163 type: boolean 3164 type: object 3165 io.k8s.api.core.v1.Container: 3166 description: A single application container that you want to run within a pod. 3167 properties: 3168 args: 3169 description: 'Arguments to the entrypoint. The docker image''s CMD is used 3170 if this is not provided. Variable references $(VAR_NAME) are expanded using 3171 the container''s environment. If a variable cannot be resolved, the reference 3172 in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped 3173 with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, 3174 regardless of whether the variable exists or not. Cannot be updated. More 3175 info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' 3176 items: 3177 type: string 3178 type: array 3179 command: 3180 description: 'Entrypoint array. Not executed within a shell. The docker image''s 3181 ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) 3182 are expanded using the container''s environment. If a variable cannot be 3183 resolved, the reference in the input string will be unchanged. The $(VAR_NAME) 3184 syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references 3185 will never be expanded, regardless of whether the variable exists or not. 3186 Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' 3187 items: 3188 type: string 3189 type: array 3190 env: 3191 description: List of environment variables to set in the container. Cannot 3192 be updated. 3193 items: 3194 $ref: '#/definitions/io.k8s.api.core.v1.EnvVar' 3195 type: array 3196 x-kubernetes-patch-merge-key: name 3197 x-kubernetes-patch-strategy: merge 3198 envFrom: 3199 description: List of sources to populate environment variables in the container. 3200 The keys defined within a source must be a C_IDENTIFIER. All invalid keys 3201 will be reported as an event when the container is starting. When a key 3202 exists in multiple sources, the value associated with the last source will 3203 take precedence. Values defined by an Env with a duplicate key will take 3204 precedence. Cannot be updated. 3205 items: 3206 $ref: '#/definitions/io.k8s.api.core.v1.EnvFromSource' 3207 type: array 3208 image: 3209 description: 'Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images 3210 This field is optional to allow higher level config management to default 3211 or override container images in workload controllers like Deployments and 3212 StatefulSets.' 3213 type: string 3214 imagePullPolicy: 3215 description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults 3216 to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot 3217 be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images' 3218 type: string 3219 lifecycle: 3220 $ref: '#/definitions/io.k8s.api.core.v1.Lifecycle' 3221 description: Actions that the management system should take in response to 3222 container lifecycle events. Cannot be updated. 3223 livenessProbe: 3224 $ref: '#/definitions/io.k8s.api.core.v1.Probe' 3225 description: 'Periodic probe of container liveness. Container will be restarted 3226 if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' 3227 name: 3228 description: Name of the container specified as a DNS_LABEL. Each container 3229 in a pod must have a unique name (DNS_LABEL). Cannot be updated. 3230 type: string 3231 ports: 3232 description: List of ports to expose from the container. Exposing a port here 3233 gives the system additional information about the network connections a 3234 container uses, but is primarily informational. Not specifying a port here 3235 DOES NOT prevent that port from being exposed. Any port which is listening 3236 on the default "0.0.0.0" address inside a container will be accessible from 3237 the network. Cannot be updated. 3238 items: 3239 $ref: '#/definitions/io.k8s.api.core.v1.ContainerPort' 3240 type: array 3241 x-kubernetes-list-map-keys: 3242 - containerPort 3243 - protocol 3244 x-kubernetes-list-type: map 3245 x-kubernetes-patch-merge-key: containerPort 3246 x-kubernetes-patch-strategy: merge 3247 readinessProbe: 3248 $ref: '#/definitions/io.k8s.api.core.v1.Probe' 3249 description: 'Periodic probe of container service readiness. Container will 3250 be removed from service endpoints if the probe fails. Cannot be updated. 3251 More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' 3252 resources: 3253 $ref: '#/definitions/io.k8s.api.core.v1.ResourceRequirements' 3254 description: 'Compute Resources required by this container. Cannot be updated. 3255 More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' 3256 securityContext: 3257 $ref: '#/definitions/io.k8s.api.core.v1.SecurityContext' 3258 description: 'Security options the pod should run with. More info: https://kubernetes.io/docs/concepts/policy/security-context/ 3259 More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/' 3260 startupProbe: 3261 $ref: '#/definitions/io.k8s.api.core.v1.Probe' 3262 description: 'StartupProbe indicates that the Pod has successfully initialized. 3263 If specified, no other probes are executed until this completes successfully. 3264 If this probe fails, the Pod will be restarted, just as if the livenessProbe 3265 failed. This can be used to provide different probe parameters at the beginning 3266 of a Pod''s lifecycle, when it might take a long time to load data or warm 3267 a cache, than during steady-state operation. This cannot be updated. This 3268 is an alpha feature enabled by the StartupProbe feature flag. More info: 3269 https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' 3270 stdin: 3271 description: Whether this container should allocate a buffer for stdin in 3272 the container runtime. If this is not set, reads from stdin in the container 3273 will always result in EOF. Default is false. 3274 type: boolean 3275 stdinOnce: 3276 description: Whether the container runtime should close the stdin channel 3277 after it has been opened by a single attach. When stdin is true the stdin 3278 stream will remain open across multiple attach sessions. If stdinOnce is 3279 set to true, stdin is opened on container start, is empty until the first 3280 client attaches to stdin, and then remains open and accepts data until the 3281 client disconnects, at which time stdin is closed and remains closed until 3282 the container is restarted. If this flag is false, a container processes 3283 that reads from stdin will never receive an EOF. Default is false 3284 type: boolean 3285 terminationMessagePath: 3286 description: 'Optional: Path at which the file to which the container''s termination 3287 message will be written is mounted into the container''s filesystem. Message 3288 written is intended to be brief final status, such as an assertion failure 3289 message. Will be truncated by the node if greater than 4096 bytes. The total 3290 message length across all containers will be limited to 12kb. Defaults to 3291 /dev/termination-log. Cannot be updated.' 3292 type: string 3293 terminationMessagePolicy: 3294 description: Indicate how the termination message should be populated. File 3295 will use the contents of terminationMessagePath to populate the container 3296 status message on both success and failure. FallbackToLogsOnError will use 3297 the last chunk of container log output if the termination message file is 3298 empty and the container exited with an error. The log output is limited 3299 to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot 3300 be updated. 3301 type: string 3302 tty: 3303 description: Whether this container should allocate a TTY for itself, also 3304 requires 'stdin' to be true. Default is false. 3305 type: boolean 3306 volumeDevices: 3307 description: volumeDevices is the list of block devices to be used by the 3308 container. This is a beta feature. 3309 items: 3310 $ref: '#/definitions/io.k8s.api.core.v1.VolumeDevice' 3311 type: array 3312 x-kubernetes-patch-merge-key: devicePath 3313 x-kubernetes-patch-strategy: merge 3314 volumeMounts: 3315 description: Pod volumes to mount into the container's filesystem. Cannot 3316 be updated. 3317 items: 3318 $ref: '#/definitions/io.k8s.api.core.v1.VolumeMount' 3319 type: array 3320 x-kubernetes-patch-merge-key: mountPath 3321 x-kubernetes-patch-strategy: merge 3322 workingDir: 3323 description: Container's working directory. If not specified, the container 3324 runtime's default will be used, which might be configured in the container 3325 image. Cannot be updated. 3326 type: string 3327 required: 3328 - name 3329 type: object 3330 io.k8s.api.core.v1.ContainerPort: 3331 description: ContainerPort represents a network port in a single container. 3332 properties: 3333 containerPort: 3334 description: Number of port to expose on the pod's IP address. This must be 3335 a valid port number, 0 < x < 65536. 3336 format: int32 3337 type: integer 3338 hostIP: 3339 description: What host IP to bind the external port to. 3340 type: string 3341 hostPort: 3342 description: Number of port to expose on the host. If specified, this must 3343 be a valid port number, 0 < x < 65536. If HostNetwork is specified, this 3344 must match ContainerPort. Most containers do not need this. 3345 format: int32 3346 type: integer 3347 name: 3348 description: If specified, this must be an IANA_SVC_NAME and unique within 3349 the pod. Each named port in a pod must have a unique name. Name for the 3350 port that can be referred to by services. 3351 type: string 3352 protocol: 3353 description: Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP". 3354 type: string 3355 required: 3356 - containerPort 3357 type: object 3358 io.k8s.api.core.v1.DownwardAPIProjection: 3359 description: Represents downward API info for projecting into a projected volume. 3360 Note that this is identical to a downwardAPI volume source without the default 3361 mode. 3362 properties: 3363 items: 3364 description: Items is a list of DownwardAPIVolume file 3365 items: 3366 $ref: '#/definitions/io.k8s.api.core.v1.DownwardAPIVolumeFile' 3367 type: array 3368 type: object 3369 io.k8s.api.core.v1.DownwardAPIVolumeFile: 3370 description: DownwardAPIVolumeFile represents information to create the file containing 3371 the pod field 3372 properties: 3373 fieldRef: 3374 $ref: '#/definitions/io.k8s.api.core.v1.ObjectFieldSelector' 3375 description: 'Required: Selects a field of the pod: only annotations, labels, 3376 name and namespace are supported.' 3377 mode: 3378 description: 'Optional: mode bits to use on this file, must be a value between 3379 0 and 0777. If not specified, the volume defaultMode will be used. This 3380 might be in conflict with other options that affect the file mode, like 3381 fsGroup, and the result can be other mode bits set.' 3382 format: int32 3383 type: integer 3384 path: 3385 description: 'Required: Path is the relative path name of the file to be 3386 created. Must not be absolute or contain the ''..'' path. Must be utf-8 3387 encoded. The first item of the relative path must not start with ''..''' 3388 type: string 3389 resourceFieldRef: 3390 $ref: '#/definitions/io.k8s.api.core.v1.ResourceFieldSelector' 3391 description: 'Selects a resource of the container: only resources limits and 3392 requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are 3393 currently supported.' 3394 required: 3395 - path 3396 type: object 3397 io.k8s.api.core.v1.DownwardAPIVolumeSource: 3398 description: DownwardAPIVolumeSource represents a volume containing downward API 3399 info. Downward API volumes support ownership management and SELinux relabeling. 3400 properties: 3401 defaultMode: 3402 description: 'Optional: mode bits to use on created files by default. Must 3403 be a value between 0 and 0777. Defaults to 0644. Directories within the 3404 path are not affected by this setting. This might be in conflict with other 3405 options that affect the file mode, like fsGroup, and the result can be other 3406 mode bits set.' 3407 format: int32 3408 type: integer 3409 items: 3410 description: Items is a list of downward API volume file 3411 items: 3412 $ref: '#/definitions/io.k8s.api.core.v1.DownwardAPIVolumeFile' 3413 type: array 3414 type: object 3415 io.k8s.api.core.v1.EmptyDirVolumeSource: 3416 description: Represents an empty directory for a pod. Empty directory volumes 3417 support ownership management and SELinux relabeling. 3418 properties: 3419 medium: 3420 description: 'What type of storage medium should back this directory. The 3421 default is "" which means to use the node''s default medium. Must be an 3422 empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir' 3423 type: string 3424 sizeLimit: 3425 $ref: '#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity' 3426 description: 'Total amount of local storage required for this EmptyDir volume. 3427 The size limit is also applicable for memory medium. The maximum usage on 3428 memory medium EmptyDir would be the minimum value between the SizeLimit 3429 specified here and the sum of memory limits of all containers in a pod. 3430 The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir' 3431 type: object 3432 io.k8s.api.core.v1.EnvFromSource: 3433 description: EnvFromSource represents the source of a set of ConfigMaps 3434 properties: 3435 configMapRef: 3436 $ref: '#/definitions/io.k8s.api.core.v1.ConfigMapEnvSource' 3437 description: The ConfigMap to select from 3438 prefix: 3439 description: An optional identifier to prepend to each key in the ConfigMap. 3440 Must be a C_IDENTIFIER. 3441 type: string 3442 secretRef: 3443 $ref: '#/definitions/io.k8s.api.core.v1.SecretEnvSource' 3444 description: The Secret to select from 3445 type: object 3446 io.k8s.api.core.v1.EnvVar: 3447 description: EnvVar represents an environment variable present in a Container. 3448 properties: 3449 name: 3450 description: Name of the environment variable. Must be a C_IDENTIFIER. 3451 type: string 3452 value: 3453 description: 'Variable references $(VAR_NAME) are expanded using the previous 3454 defined environment variables in the container and any service environment 3455 variables. If a variable cannot be resolved, the reference in the input 3456 string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double 3457 $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless 3458 of whether the variable exists or not. Defaults to "".' 3459 type: string 3460 valueFrom: 3461 $ref: '#/definitions/io.k8s.api.core.v1.EnvVarSource' 3462 description: Source for the environment variable's value. Cannot be used if 3463 value is not empty. 3464 required: 3465 - name 3466 type: object 3467 io.k8s.api.core.v1.EnvVarSource: 3468 description: EnvVarSource represents a source for the value of an EnvVar. 3469 properties: 3470 configMapKeyRef: 3471 $ref: '#/definitions/io.k8s.api.core.v1.ConfigMapKeySelector' 3472 description: Selects a key of a ConfigMap. 3473 fieldRef: 3474 $ref: '#/definitions/io.k8s.api.core.v1.ObjectFieldSelector' 3475 description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, 3476 metadata.labels, metadata.annotations, spec.nodeName, spec.serviceAccountName, 3477 status.hostIP, status.podIP.' 3478 resourceFieldRef: 3479 $ref: '#/definitions/io.k8s.api.core.v1.ResourceFieldSelector' 3480 description: 'Selects a resource of the container: only resources limits and 3481 requests (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, 3482 requests.memory and requests.ephemeral-storage) are currently supported.' 3483 secretKeyRef: 3484 $ref: '#/definitions/io.k8s.api.core.v1.SecretKeySelector' 3485 description: Selects a key of a secret in the pod's namespace 3486 type: object 3487 io.k8s.api.core.v1.EphemeralContainer: 3488 description: An EphemeralContainer is a container that may be added temporarily 3489 to an existing pod for user-initiated activities such as debugging. Ephemeral 3490 containers have no resource or scheduling guarantees, and they will not be restarted 3491 when they exit or when a pod is removed or restarted. If an ephemeral container 3492 causes a pod to exceed its resource allocation, the pod may be evicted. Ephemeral 3493 containers may not be added by directly updating the pod spec. They must be 3494 added via the pod's ephemeralcontainers subresource, and they will appear in 3495 the pod spec once added. This is an alpha feature enabled by the EphemeralContainers 3496 feature flag. 3497 properties: 3498 args: 3499 description: 'Arguments to the entrypoint. The docker image''s CMD is used 3500 if this is not provided. Variable references $(VAR_NAME) are expanded using 3501 the container''s environment. If a variable cannot be resolved, the reference 3502 in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped 3503 with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, 3504 regardless of whether the variable exists or not. Cannot be updated. More 3505 info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' 3506 items: 3507 type: string 3508 type: array 3509 command: 3510 description: 'Entrypoint array. Not executed within a shell. The docker image''s 3511 ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) 3512 are expanded using the container''s environment. If a variable cannot be 3513 resolved, the reference in the input string will be unchanged. The $(VAR_NAME) 3514 syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references 3515 will never be expanded, regardless of whether the variable exists or not. 3516 Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell' 3517 items: 3518 type: string 3519 type: array 3520 env: 3521 description: List of environment variables to set in the container. Cannot 3522 be updated. 3523 items: 3524 $ref: '#/definitions/io.k8s.api.core.v1.EnvVar' 3525 type: array 3526 x-kubernetes-patch-merge-key: name 3527 x-kubernetes-patch-strategy: merge 3528 envFrom: 3529 description: List of sources to populate environment variables in the container. 3530 The keys defined within a source must be a C_IDENTIFIER. All invalid keys 3531 will be reported as an event when the container is starting. When a key 3532 exists in multiple sources, the value associated with the last source will 3533 take precedence. Values defined by an Env with a duplicate key will take 3534 precedence. Cannot be updated. 3535 items: 3536 $ref: '#/definitions/io.k8s.api.core.v1.EnvFromSource' 3537 type: array 3538 image: 3539 description: 'Docker image name. More info: https://kubernetes.io/docs/concepts/containers/images' 3540 type: string 3541 imagePullPolicy: 3542 description: 'Image pull policy. One of Always, Never, IfNotPresent. Defaults 3543 to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot 3544 be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images' 3545 type: string 3546 lifecycle: 3547 $ref: '#/definitions/io.k8s.api.core.v1.Lifecycle' 3548 description: Lifecycle is not allowed for ephemeral containers. 3549 livenessProbe: 3550 $ref: '#/definitions/io.k8s.api.core.v1.Probe' 3551 description: Probes are not allowed for ephemeral containers. 3552 name: 3553 description: Name of the ephemeral container specified as a DNS_LABEL. This 3554 name must be unique among all containers, init containers and ephemeral 3555 containers. 3556 type: string 3557 ports: 3558 description: Ports are not allowed for ephemeral containers. 3559 items: 3560 $ref: '#/definitions/io.k8s.api.core.v1.ContainerPort' 3561 type: array 3562 readinessProbe: 3563 $ref: '#/definitions/io.k8s.api.core.v1.Probe' 3564 description: Probes are not allowed for ephemeral containers. 3565 resources: 3566 $ref: '#/definitions/io.k8s.api.core.v1.ResourceRequirements' 3567 description: Resources are not allowed for ephemeral containers. Ephemeral 3568 containers use spare resources already allocated to the pod. 3569 securityContext: 3570 $ref: '#/definitions/io.k8s.api.core.v1.SecurityContext' 3571 description: SecurityContext is not allowed for ephemeral containers. 3572 startupProbe: 3573 $ref: '#/definitions/io.k8s.api.core.v1.Probe' 3574 description: Probes are not allowed for ephemeral containers. 3575 stdin: 3576 description: Whether this container should allocate a buffer for stdin in 3577 the container runtime. If this is not set, reads from stdin in the container 3578 will always result in EOF. Default is false. 3579 type: boolean 3580 stdinOnce: 3581 description: Whether the container runtime should close the stdin channel 3582 after it has been opened by a single attach. When stdin is true the stdin 3583 stream will remain open across multiple attach sessions. If stdinOnce is 3584 set to true, stdin is opened on container start, is empty until the first 3585 client attaches to stdin, and then remains open and accepts data until the 3586 client disconnects, at which time stdin is closed and remains closed until 3587 the container is restarted. If this flag is false, a container processes 3588 that reads from stdin will never receive an EOF. Default is false 3589 type: boolean 3590 targetContainerName: 3591 description: If set, the name of the container from PodSpec that this ephemeral 3592 container targets. The ephemeral container will be run in the namespaces 3593 (IPC, PID, etc) of this container. If not set then the ephemeral container 3594 is run in whatever namespaces are shared for the pod. Note that the container 3595 runtime must support this feature. 3596 type: string 3597 terminationMessagePath: 3598 description: 'Optional: Path at which the file to which the container''s termination 3599 message will be written is mounted into the container''s filesystem. Message 3600 written is intended to be brief final status, such as an assertion failure 3601 message. Will be truncated by the node if greater than 4096 bytes. The total 3602 message length across all containers will be limited to 12kb. Defaults to 3603 /dev/termination-log. Cannot be updated.' 3604 type: string 3605 terminationMessagePolicy: 3606 description: Indicate how the termination message should be populated. File 3607 will use the contents of terminationMessagePath to populate the container 3608 status message on both success and failure. FallbackToLogsOnError will use 3609 the last chunk of container log output if the termination message file is 3610 empty and the container exited with an error. The log output is limited 3611 to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot 3612 be updated. 3613 type: string 3614 tty: 3615 description: Whether this container should allocate a TTY for itself, also 3616 requires 'stdin' to be true. Default is false. 3617 type: boolean 3618 volumeDevices: 3619 description: volumeDevices is the list of block devices to be used by the 3620 container. This is a beta feature. 3621 items: 3622 $ref: '#/definitions/io.k8s.api.core.v1.VolumeDevice' 3623 type: array 3624 x-kubernetes-patch-merge-key: devicePath 3625 x-kubernetes-patch-strategy: merge 3626 volumeMounts: 3627 description: Pod volumes to mount into the container's filesystem. Cannot 3628 be updated. 3629 items: 3630 $ref: '#/definitions/io.k8s.api.core.v1.VolumeMount' 3631 type: array 3632 x-kubernetes-patch-merge-key: mountPath 3633 x-kubernetes-patch-strategy: merge 3634 workingDir: 3635 description: Container's working directory. If not specified, the container 3636 runtime's default will be used, which might be configured in the container 3637 image. Cannot be updated. 3638 type: string 3639 required: 3640 - name 3641 type: object 3642 io.k8s.api.core.v1.ExecAction: 3643 description: ExecAction describes a "run in container" action. 3644 properties: 3645 command: 3646 description: Command is the command line to execute inside the container, 3647 the working directory for the command is root ('/') in the container's 3648 filesystem. The command is simply exec'd, it is not run inside a shell, 3649 so traditional shell instructions ('|', etc) won't work. To use a shell, 3650 you need to explicitly call out to that shell. Exit status of 0 is treated 3651 as live/healthy and non-zero is unhealthy. 3652 items: 3653 type: string 3654 type: array 3655 type: object 3656 io.k8s.api.core.v1.FCVolumeSource: 3657 description: Represents a Fibre Channel volume. Fibre Channel volumes can only 3658 be mounted as read/write once. Fibre Channel volumes support ownership management 3659 and SELinux relabeling. 3660 properties: 3661 fsType: 3662 description: Filesystem type to mount. Must be a filesystem type supported 3663 by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred 3664 to be "ext4" if unspecified. 3665 type: string 3666 lun: 3667 description: 'Optional: FC target lun number' 3668 format: int32 3669 type: integer 3670 readOnly: 3671 description: 'Optional: Defaults to false (read/write). ReadOnly here will 3672 force the ReadOnly setting in VolumeMounts.' 3673 type: boolean 3674 targetWWNs: 3675 description: 'Optional: FC target worldwide names (WWNs)' 3676 items: 3677 type: string 3678 type: array 3679 wwids: 3680 description: 'Optional: FC volume world wide identifiers (wwids) Either wwids 3681 or combination of targetWWNs and lun must be set, but not both simultaneously.' 3682 items: 3683 type: string 3684 type: array 3685 type: object 3686 io.k8s.api.core.v1.FlexVolumeSource: 3687 description: FlexVolume represents a generic volume resource that is provisioned/attached 3688 using an exec based plugin. 3689 properties: 3690 driver: 3691 description: Driver is the name of the driver to use for this volume. 3692 type: string 3693 fsType: 3694 description: Filesystem type to mount. Must be a filesystem type supported 3695 by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem 3696 depends on FlexVolume script. 3697 type: string 3698 options: 3699 additionalProperties: 3700 type: string 3701 description: 'Optional: Extra command options if any.' 3702 type: object 3703 readOnly: 3704 description: 'Optional: Defaults to false (read/write). ReadOnly here will 3705 force the ReadOnly setting in VolumeMounts.' 3706 type: boolean 3707 secretRef: 3708 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 3709 description: 'Optional: SecretRef is reference to the secret object containing 3710 sensitive information to pass to the plugin scripts. This may be empty if 3711 no secret object is specified. If the secret object contains more than one 3712 secret, all secrets are passed to the plugin scripts.' 3713 required: 3714 - driver 3715 type: object 3716 io.k8s.api.core.v1.FlockerVolumeSource: 3717 description: Represents a Flocker volume mounted by the Flocker agent. One and 3718 only one of datasetName and datasetUUID should be set. Flocker volumes do not 3719 support ownership management or SELinux relabeling. 3720 properties: 3721 datasetName: 3722 description: Name of the dataset stored as metadata -> name on the dataset 3723 for Flocker should be considered as deprecated 3724 type: string 3725 datasetUUID: 3726 description: UUID of the dataset. This is unique identifier of a Flocker dataset 3727 type: string 3728 type: object 3729 io.k8s.api.core.v1.GCEPersistentDiskVolumeSource: 3730 description: |- 3731 Represents a Persistent Disk resource in Google Compute Engine. 3732 3733 A GCE PD must exist before mounting to a container. The disk must also be in the same GCE project and zone as the kubelet. A GCE PD can only be mounted as read/write once or read-only many times. GCE PDs support ownership management and SELinux relabeling. 3734 properties: 3735 fsType: 3736 description: 'Filesystem type of the volume that you want to mount. Tip: Ensure 3737 that the filesystem type is supported by the host operating system. Examples: 3738 "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. 3739 More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' 3740 type: string 3741 partition: 3742 description: 'The partition in the volume that you want to mount. If omitted, 3743 the default is to mount by volume name. Examples: For volume /dev/sda1, 3744 you specify the partition as "1". Similarly, the volume partition for /dev/sda 3745 is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' 3746 format: int32 3747 type: integer 3748 pdName: 3749 description: 'Unique name of the PD resource in GCE. Used to identify the 3750 disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' 3751 type: string 3752 readOnly: 3753 description: 'ReadOnly here will force the ReadOnly setting in VolumeMounts. 3754 Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' 3755 type: boolean 3756 required: 3757 - pdName 3758 type: object 3759 io.k8s.api.core.v1.GitRepoVolumeSource: 3760 description: |- 3761 Represents a volume that is populated with the contents of a git repository. Git repo volumes do not support ownership management. Git repo volumes support SELinux relabeling. 3762 3763 DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container. 3764 properties: 3765 directory: 3766 description: Target directory name. Must not contain or start with '..'. If 3767 '.' is supplied, the volume directory will be the git repository. Otherwise, 3768 if specified, the volume will contain the git repository in the subdirectory 3769 with the given name. 3770 type: string 3771 repository: 3772 description: Repository URL 3773 type: string 3774 revision: 3775 description: Commit hash for the specified revision. 3776 type: string 3777 required: 3778 - repository 3779 type: object 3780 io.k8s.api.core.v1.GlusterfsVolumeSource: 3781 description: Represents a Glusterfs mount that lasts the lifetime of a pod. Glusterfs 3782 volumes do not support ownership management or SELinux relabeling. 3783 properties: 3784 endpoints: 3785 description: 'EndpointsName is the endpoint name that details Glusterfs topology. 3786 More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod' 3787 type: string 3788 path: 3789 description: 'Path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod' 3790 type: string 3791 readOnly: 3792 description: 'ReadOnly here will force the Glusterfs volume to be mounted 3793 with read-only permissions. Defaults to false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod' 3794 type: boolean 3795 required: 3796 - endpoints 3797 - path 3798 type: object 3799 io.k8s.api.core.v1.HTTPGetAction: 3800 description: HTTPGetAction describes an action based on HTTP Get requests. 3801 properties: 3802 host: 3803 description: Host name to connect to, defaults to the pod IP. You probably 3804 want to set "Host" in httpHeaders instead. 3805 type: string 3806 httpHeaders: 3807 description: Custom headers to set in the request. HTTP allows repeated headers. 3808 items: 3809 $ref: '#/definitions/io.k8s.api.core.v1.HTTPHeader' 3810 type: array 3811 path: 3812 description: Path to access on the HTTP server. 3813 type: string 3814 port: 3815 $ref: '#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString' 3816 description: Name or number of the port to access on the container. Number 3817 must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. 3818 scheme: 3819 description: Scheme to use for connecting to the host. Defaults to HTTP. 3820 type: string 3821 required: 3822 - port 3823 type: object 3824 io.k8s.api.core.v1.HTTPHeader: 3825 description: HTTPHeader describes a custom header to be used in HTTP probes 3826 properties: 3827 name: 3828 description: The header field name 3829 type: string 3830 value: 3831 description: The header field value 3832 type: string 3833 required: 3834 - name 3835 - value 3836 type: object 3837 io.k8s.api.core.v1.Handler: 3838 description: Handler defines a specific action that should be taken 3839 properties: 3840 exec: 3841 $ref: '#/definitions/io.k8s.api.core.v1.ExecAction' 3842 description: One and only one of the following should be specified. Exec specifies 3843 the action to take. 3844 httpGet: 3845 $ref: '#/definitions/io.k8s.api.core.v1.HTTPGetAction' 3846 description: HTTPGet specifies the http request to perform. 3847 tcpSocket: 3848 $ref: '#/definitions/io.k8s.api.core.v1.TCPSocketAction' 3849 description: TCPSocket specifies an action involving a TCP port. TCP hooks 3850 not yet supported 3851 type: object 3852 io.k8s.api.core.v1.HostAlias: 3853 description: HostAlias holds the mapping between IP and hostnames that will be 3854 injected as an entry in the pod's hosts file. 3855 properties: 3856 hostnames: 3857 description: Hostnames for the above IP address. 3858 items: 3859 type: string 3860 type: array 3861 ip: 3862 description: IP address of the host file entry. 3863 type: string 3864 type: object 3865 io.k8s.api.core.v1.HostPathVolumeSource: 3866 description: Represents a host path mapped into a pod. Host path volumes do not 3867 support ownership management or SELinux relabeling. 3868 properties: 3869 path: 3870 description: 'Path of the directory on the host. If the path is a symlink, 3871 it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath' 3872 type: string 3873 type: 3874 description: 'Type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath' 3875 type: string 3876 required: 3877 - path 3878 type: object 3879 io.k8s.api.core.v1.ISCSIVolumeSource: 3880 description: Represents an ISCSI disk. ISCSI volumes can only be mounted as read/write 3881 once. ISCSI volumes support ownership management and SELinux relabeling. 3882 properties: 3883 chapAuthDiscovery: 3884 description: whether support iSCSI Discovery CHAP authentication 3885 type: boolean 3886 chapAuthSession: 3887 description: whether support iSCSI Session CHAP authentication 3888 type: boolean 3889 fsType: 3890 description: 'Filesystem type of the volume that you want to mount. Tip: Ensure 3891 that the filesystem type is supported by the host operating system. Examples: 3892 "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. 3893 More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi' 3894 type: string 3895 initiatorName: 3896 description: Custom iSCSI Initiator Name. If initiatorName is specified with 3897 iscsiInterface simultaneously, new iSCSI interface <target portal>:<volume 3898 name> will be created for the connection. 3899 type: string 3900 iqn: 3901 description: Target iSCSI Qualified Name. 3902 type: string 3903 iscsiInterface: 3904 description: iSCSI Interface Name that uses an iSCSI transport. Defaults to 3905 'default' (tcp). 3906 type: string 3907 lun: 3908 description: iSCSI Target Lun number. 3909 format: int32 3910 type: integer 3911 portals: 3912 description: iSCSI Target Portal List. The portal is either an IP or ip_addr:port 3913 if the port is other than default (typically TCP ports 860 and 3260). 3914 items: 3915 type: string 3916 type: array 3917 readOnly: 3918 description: ReadOnly here will force the ReadOnly setting in VolumeMounts. 3919 Defaults to false. 3920 type: boolean 3921 secretRef: 3922 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 3923 description: CHAP Secret for iSCSI target and initiator authentication 3924 targetPortal: 3925 description: iSCSI Target Portal. The Portal is either an IP or ip_addr:port 3926 if the port is other than default (typically TCP ports 860 and 3260). 3927 type: string 3928 required: 3929 - targetPortal 3930 - iqn 3931 - lun 3932 type: object 3933 io.k8s.api.core.v1.KeyToPath: 3934 description: Maps a string key to a path within a volume. 3935 properties: 3936 key: 3937 description: The key to project. 3938 type: string 3939 mode: 3940 description: 'Optional: mode bits to use on this file, must be a value between 3941 0 and 0777. If not specified, the volume defaultMode will be used. This 3942 might be in conflict with other options that affect the file mode, like 3943 fsGroup, and the result can be other mode bits set.' 3944 format: int32 3945 type: integer 3946 path: 3947 description: The relative path of the file to map the key to. May not be an 3948 absolute path. May not contain the path element '..'. May not start with 3949 the string '..'. 3950 type: string 3951 required: 3952 - key 3953 - path 3954 type: object 3955 io.k8s.api.core.v1.Lifecycle: 3956 description: Lifecycle describes actions that the management system should take 3957 in response to container lifecycle events. For the PostStart and PreStop lifecycle 3958 handlers, management of the container blocks until the action is complete, unless 3959 the container process fails, in which case the handler is aborted. 3960 properties: 3961 postStart: 3962 $ref: '#/definitions/io.k8s.api.core.v1.Handler' 3963 description: 'PostStart is called immediately after a container is created. 3964 If the handler fails, the container is terminated and restarted according 3965 to its restart policy. Other management of the container blocks until the 3966 hook completes. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' 3967 preStop: 3968 $ref: '#/definitions/io.k8s.api.core.v1.Handler' 3969 description: 'PreStop is called immediately before a container is terminated 3970 due to an API request or management event such as liveness/startup probe 3971 failure, preemption, resource contention, etc. The handler is not called 3972 if the container crashes or exits. The reason for termination is passed 3973 to the handler. The Pod''s termination grace period countdown begins before 3974 the PreStop hooked is executed. Regardless of the outcome of the handler, 3975 the container will eventually terminate within the Pod''s termination grace 3976 period. Other management of the container blocks until the hook completes 3977 or until the termination grace period is reached. More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks' 3978 type: object 3979 io.k8s.api.core.v1.LocalObjectReference: 3980 description: LocalObjectReference contains enough information to let you locate 3981 the referenced object inside the same namespace. 3982 properties: 3983 name: 3984 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 3985 type: string 3986 type: object 3987 io.k8s.api.core.v1.NFSVolumeSource: 3988 description: Represents an NFS mount that lasts the lifetime of a pod. NFS volumes 3989 do not support ownership management or SELinux relabeling. 3990 properties: 3991 path: 3992 description: 'Path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs' 3993 type: string 3994 readOnly: 3995 description: 'ReadOnly here will force the NFS export to be mounted with read-only 3996 permissions. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs' 3997 type: boolean 3998 server: 3999 description: 'Server is the hostname or IP address of the NFS server. More 4000 info: https://kubernetes.io/docs/concepts/storage/volumes#nfs' 4001 type: string 4002 required: 4003 - server 4004 - path 4005 type: object 4006 io.k8s.api.core.v1.NodeAffinity: 4007 description: Node affinity is a group of node affinity scheduling rules. 4008 properties: 4009 preferredDuringSchedulingIgnoredDuringExecution: 4010 description: The scheduler will prefer to schedule pods to nodes that satisfy 4011 the affinity expressions specified by this field, but it may choose a node 4012 that violates one or more of the expressions. The node that is most preferred 4013 is the one with the greatest sum of weights, i.e. for each node that meets 4014 all of the scheduling requirements (resource request, requiredDuringScheduling 4015 affinity expressions, etc.), compute a sum by iterating through the elements 4016 of this field and adding "weight" to the sum if the node matches the corresponding 4017 matchExpressions; the node(s) with the highest sum are the most preferred. 4018 items: 4019 $ref: '#/definitions/io.k8s.api.core.v1.PreferredSchedulingTerm' 4020 type: array 4021 requiredDuringSchedulingIgnoredDuringExecution: 4022 $ref: '#/definitions/io.k8s.api.core.v1.NodeSelector' 4023 description: If the affinity requirements specified by this field are not 4024 met at scheduling time, the pod will not be scheduled onto the node. If 4025 the affinity requirements specified by this field cease to be met at some 4026 point during pod execution (e.g. due to an update), the system may or may 4027 not try to eventually evict the pod from its node. 4028 type: object 4029 io.k8s.api.core.v1.NodeSelector: 4030 description: A node selector represents the union of the results of one or more 4031 label queries over a set of nodes; that is, it represents the OR of the selectors 4032 represented by the node selector terms. 4033 properties: 4034 nodeSelectorTerms: 4035 description: Required. A list of node selector terms. The terms are ORed. 4036 items: 4037 $ref: '#/definitions/io.k8s.api.core.v1.NodeSelectorTerm' 4038 type: array 4039 required: 4040 - nodeSelectorTerms 4041 type: object 4042 io.k8s.api.core.v1.NodeSelectorRequirement: 4043 description: A node selector requirement is a selector that contains values, a 4044 key, and an operator that relates the key and values. 4045 properties: 4046 key: 4047 description: The label key that the selector applies to. 4048 type: string 4049 operator: 4050 description: Represents a key's relationship to a set of values. Valid operators 4051 are In, NotIn, Exists, DoesNotExist. Gt, and Lt. 4052 type: string 4053 values: 4054 description: An array of string values. If the operator is In or NotIn, the 4055 values array must be non-empty. If the operator is Exists or DoesNotExist, 4056 the values array must be empty. If the operator is Gt or Lt, the values 4057 array must have a single element, which will be interpreted as an integer. 4058 This array is replaced during a strategic merge patch. 4059 items: 4060 type: string 4061 type: array 4062 required: 4063 - key 4064 - operator 4065 type: object 4066 io.k8s.api.core.v1.NodeSelectorTerm: 4067 description: A null or empty node selector term matches no objects. The requirements 4068 of them are ANDed. The TopologySelectorTerm type implements a subset of the 4069 NodeSelectorTerm. 4070 properties: 4071 matchExpressions: 4072 description: A list of node selector requirements by node's labels. 4073 items: 4074 $ref: '#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement' 4075 type: array 4076 matchFields: 4077 description: A list of node selector requirements by node's fields. 4078 items: 4079 $ref: '#/definitions/io.k8s.api.core.v1.NodeSelectorRequirement' 4080 type: array 4081 type: object 4082 io.k8s.api.core.v1.ObjectFieldSelector: 4083 description: ObjectFieldSelector selects an APIVersioned field of an object. 4084 properties: 4085 apiVersion: 4086 description: Version of the schema the FieldPath is written in terms of, defaults 4087 to "v1". 4088 type: string 4089 fieldPath: 4090 description: Path of the field to select in the specified API version. 4091 type: string 4092 required: 4093 - fieldPath 4094 type: object 4095 io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource: 4096 description: PersistentVolumeClaimVolumeSource references the user's PVC in the 4097 same namespace. This volume finds the bound PV and mounts that volume for the 4098 pod. A PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another 4099 type of volume that is owned by someone else (the system). 4100 properties: 4101 claimName: 4102 description: 'ClaimName is the name of a PersistentVolumeClaim in the same 4103 namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims' 4104 type: string 4105 readOnly: 4106 description: Will force the ReadOnly setting in VolumeMounts. Default false. 4107 type: boolean 4108 required: 4109 - claimName 4110 type: object 4111 io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource: 4112 description: Represents a Photon Controller persistent disk resource. 4113 properties: 4114 fsType: 4115 description: Filesystem type to mount. Must be a filesystem type supported 4116 by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred 4117 to be "ext4" if unspecified. 4118 type: string 4119 pdID: 4120 description: ID that identifies Photon Controller persistent disk 4121 type: string 4122 required: 4123 - pdID 4124 type: object 4125 io.k8s.api.core.v1.PodAffinity: 4126 description: Pod affinity is a group of inter pod affinity scheduling rules. 4127 properties: 4128 preferredDuringSchedulingIgnoredDuringExecution: 4129 description: The scheduler will prefer to schedule pods to nodes that satisfy 4130 the affinity expressions specified by this field, but it may choose a node 4131 that violates one or more of the expressions. The node that is most preferred 4132 is the one with the greatest sum of weights, i.e. for each node that meets 4133 all of the scheduling requirements (resource request, requiredDuringScheduling 4134 affinity expressions, etc.), compute a sum by iterating through the elements 4135 of this field and adding "weight" to the sum if the node has pods which 4136 matches the corresponding podAffinityTerm; the node(s) with the highest 4137 sum are the most preferred. 4138 items: 4139 $ref: '#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm' 4140 type: array 4141 requiredDuringSchedulingIgnoredDuringExecution: 4142 description: If the affinity requirements specified by this field are not 4143 met at scheduling time, the pod will not be scheduled onto the node. If 4144 the affinity requirements specified by this field cease to be met at some 4145 point during pod execution (e.g. due to a pod label update), the system 4146 may or may not try to eventually evict the pod from its node. When there 4147 are multiple elements, the lists of nodes corresponding to each podAffinityTerm 4148 are intersected, i.e. all terms must be satisfied. 4149 items: 4150 $ref: '#/definitions/io.k8s.api.core.v1.PodAffinityTerm' 4151 type: array 4152 type: object 4153 io.k8s.api.core.v1.PodAffinityTerm: 4154 description: Defines a set of pods (namely those matching the labelSelector relative 4155 to the given namespace(s)) that this pod should be co-located (affinity) or 4156 not co-located (anti-affinity) with, where co-located is defined as running 4157 on a node whose value of the label with key <topologyKey> matches that of any 4158 node on which a pod of the set of pods is running 4159 properties: 4160 labelSelector: 4161 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector' 4162 description: A label query over a set of resources, in this case pods. 4163 namespaces: 4164 description: namespaces specifies which namespaces the labelSelector applies 4165 to (matches against); null or empty list means "this pod's namespace" 4166 items: 4167 type: string 4168 type: array 4169 topologyKey: 4170 description: This pod should be co-located (affinity) or not co-located (anti-affinity) 4171 with the pods matching the labelSelector in the specified namespaces, where 4172 co-located is defined as running on a node whose value of the label with 4173 key topologyKey matches that of any node on which any of the selected pods 4174 is running. Empty topologyKey is not allowed. 4175 type: string 4176 required: 4177 - topologyKey 4178 type: object 4179 io.k8s.api.core.v1.PodAntiAffinity: 4180 description: Pod anti affinity is a group of inter pod anti affinity scheduling 4181 rules. 4182 properties: 4183 preferredDuringSchedulingIgnoredDuringExecution: 4184 description: The scheduler will prefer to schedule pods to nodes that satisfy 4185 the anti-affinity expressions specified by this field, but it may choose 4186 a node that violates one or more of the expressions. The node that is most 4187 preferred is the one with the greatest sum of weights, i.e. for each node 4188 that meets all of the scheduling requirements (resource request, requiredDuringScheduling 4189 anti-affinity expressions, etc.), compute a sum by iterating through the 4190 elements of this field and adding "weight" to the sum if the node has pods 4191 which matches the corresponding podAffinityTerm; the node(s) with the highest 4192 sum are the most preferred. 4193 items: 4194 $ref: '#/definitions/io.k8s.api.core.v1.WeightedPodAffinityTerm' 4195 type: array 4196 requiredDuringSchedulingIgnoredDuringExecution: 4197 description: If the anti-affinity requirements specified by this field are 4198 not met at scheduling time, the pod will not be scheduled onto the node. 4199 If the anti-affinity requirements specified by this field cease to be met 4200 at some point during pod execution (e.g. due to a pod label update), the 4201 system may or may not try to eventually evict the pod from its node. When 4202 there are multiple elements, the lists of nodes corresponding to each podAffinityTerm 4203 are intersected, i.e. all terms must be satisfied. 4204 items: 4205 $ref: '#/definitions/io.k8s.api.core.v1.PodAffinityTerm' 4206 type: array 4207 type: object 4208 io.k8s.api.core.v1.PodDNSConfig: 4209 description: PodDNSConfig defines the DNS parameters of a pod in addition to those 4210 generated from DNSPolicy. 4211 properties: 4212 nameservers: 4213 description: A list of DNS name server IP addresses. This will be appended 4214 to the base nameservers generated from DNSPolicy. Duplicated nameservers 4215 will be removed. 4216 items: 4217 type: string 4218 type: array 4219 options: 4220 description: A list of DNS resolver options. This will be merged with the 4221 base options generated from DNSPolicy. Duplicated entries will be removed. 4222 Resolution options given in Options will override those that appear in the 4223 base DNSPolicy. 4224 items: 4225 $ref: '#/definitions/io.k8s.api.core.v1.PodDNSConfigOption' 4226 type: array 4227 searches: 4228 description: A list of DNS search domains for host-name lookup. This will 4229 be appended to the base search paths generated from DNSPolicy. Duplicated 4230 search paths will be removed. 4231 items: 4232 type: string 4233 type: array 4234 type: object 4235 io.k8s.api.core.v1.PodDNSConfigOption: 4236 description: PodDNSConfigOption defines DNS resolver options of a pod. 4237 properties: 4238 name: 4239 description: Required. 4240 type: string 4241 value: 4242 type: string 4243 type: object 4244 io.k8s.api.core.v1.PodReadinessGate: 4245 description: PodReadinessGate contains the reference to a pod condition 4246 properties: 4247 conditionType: 4248 description: ConditionType refers to a condition in the pod's condition list 4249 with matching type. 4250 type: string 4251 required: 4252 - conditionType 4253 type: object 4254 io.k8s.api.core.v1.PodSecurityContext: 4255 description: PodSecurityContext holds pod-level security attributes and common 4256 container settings. Some fields are also present in container.securityContext. Field 4257 values of container.securityContext take precedence over field values of PodSecurityContext. 4258 properties: 4259 fsGroup: 4260 description: |- 4261 A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod: 4262 4263 1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw---- 4264 4265 If unset, the Kubelet will not modify the ownership and permissions of any volume. 4266 format: int64 4267 type: integer 4268 runAsGroup: 4269 description: The GID to run the entrypoint of the container process. Uses 4270 runtime default if unset. May also be set in SecurityContext. If set in 4271 both SecurityContext and PodSecurityContext, the value specified in SecurityContext 4272 takes precedence for that container. 4273 format: int64 4274 type: integer 4275 runAsNonRoot: 4276 description: Indicates that the container must run as a non-root user. If 4277 true, the Kubelet will validate the image at runtime to ensure that it does 4278 not run as UID 0 (root) and fail to start the container if it does. If unset 4279 or false, no such validation will be performed. May also be set in SecurityContext. If 4280 set in both SecurityContext and PodSecurityContext, the value specified 4281 in SecurityContext takes precedence. 4282 type: boolean 4283 runAsUser: 4284 description: The UID to run the entrypoint of the container process. Defaults 4285 to user specified in image metadata if unspecified. May also be set in SecurityContext. If 4286 set in both SecurityContext and PodSecurityContext, the value specified 4287 in SecurityContext takes precedence for that container. 4288 format: int64 4289 type: integer 4290 seLinuxOptions: 4291 $ref: '#/definitions/io.k8s.api.core.v1.SELinuxOptions' 4292 description: The SELinux context to be applied to all containers. If unspecified, 4293 the container runtime will allocate a random SELinux context for each container. May 4294 also be set in SecurityContext. If set in both SecurityContext and PodSecurityContext, 4295 the value specified in SecurityContext takes precedence for that container. 4296 supplementalGroups: 4297 description: A list of groups applied to the first process run in each container, 4298 in addition to the container's primary GID. If unspecified, no groups will 4299 be added to any container. 4300 items: 4301 format: int64 4302 type: integer 4303 type: array 4304 sysctls: 4305 description: Sysctls hold a list of namespaced sysctls used for the pod. Pods 4306 with unsupported sysctls (by the container runtime) might fail to launch. 4307 items: 4308 $ref: '#/definitions/io.k8s.api.core.v1.Sysctl' 4309 type: array 4310 windowsOptions: 4311 $ref: '#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions' 4312 description: The Windows specific settings applied to all containers. If unspecified, 4313 the options within a container's SecurityContext will be used. If set in 4314 both SecurityContext and PodSecurityContext, the value specified in SecurityContext 4315 takes precedence. 4316 type: object 4317 io.k8s.api.core.v1.PodSpec: 4318 description: PodSpec is a description of a pod. 4319 properties: 4320 activeDeadlineSeconds: 4321 description: Optional duration in seconds the pod may be active on the node 4322 relative to StartTime before the system will actively try to mark it failed 4323 and kill associated containers. Value must be a positive integer. 4324 format: int64 4325 type: integer 4326 affinity: 4327 $ref: '#/definitions/io.k8s.api.core.v1.Affinity' 4328 description: If specified, the pod's scheduling constraints 4329 automountServiceAccountToken: 4330 description: AutomountServiceAccountToken indicates whether a service account 4331 token should be automatically mounted. 4332 type: boolean 4333 containers: 4334 description: List of containers belonging to the pod. Containers cannot currently 4335 be added or removed. There must be at least one container in a Pod. Cannot 4336 be updated. 4337 items: 4338 $ref: '#/definitions/io.k8s.api.core.v1.Container' 4339 type: array 4340 x-kubernetes-patch-merge-key: name 4341 x-kubernetes-patch-strategy: merge 4342 dnsConfig: 4343 $ref: '#/definitions/io.k8s.api.core.v1.PodDNSConfig' 4344 description: Specifies the DNS parameters of a pod. Parameters specified here 4345 will be merged to the generated DNS configuration based on DNSPolicy. 4346 dnsPolicy: 4347 description: Set DNS policy for the pod. Defaults to "ClusterFirst". Valid 4348 values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. 4349 DNS parameters given in DNSConfig will be merged with the policy selected 4350 with DNSPolicy. To have DNS options set along with hostNetwork, you have 4351 to specify DNS policy explicitly to 'ClusterFirstWithHostNet'. 4352 type: string 4353 enableServiceLinks: 4354 description: 'EnableServiceLinks indicates whether information about services 4355 should be injected into pod''s environment variables, matching the syntax 4356 of Docker links. Optional: Defaults to true.' 4357 type: boolean 4358 ephemeralContainers: 4359 description: List of ephemeral containers run in this pod. Ephemeral containers 4360 may be run in an existing pod to perform user-initiated actions such as 4361 debugging. This list cannot be specified when creating a pod, and it cannot 4362 be modified by updating the pod spec. In order to add an ephemeral container 4363 to an existing pod, use the pod's ephemeralcontainers subresource. This 4364 field is alpha-level and is only honored by servers that enable the EphemeralContainers 4365 feature. 4366 items: 4367 $ref: '#/definitions/io.k8s.api.core.v1.EphemeralContainer' 4368 type: array 4369 x-kubernetes-patch-merge-key: name 4370 x-kubernetes-patch-strategy: merge 4371 hostAliases: 4372 description: HostAliases is an optional list of hosts and IPs that will be 4373 injected into the pod's hosts file if specified. This is only valid for 4374 non-hostNetwork pods. 4375 items: 4376 $ref: '#/definitions/io.k8s.api.core.v1.HostAlias' 4377 type: array 4378 x-kubernetes-patch-merge-key: ip 4379 x-kubernetes-patch-strategy: merge 4380 hostIPC: 4381 description: 'Use the host''s ipc namespace. Optional: Default to false.' 4382 type: boolean 4383 hostNetwork: 4384 description: Host networking requested for this pod. Use the host's network 4385 namespace. If this option is set, the ports that will be used must be specified. 4386 Default to false. 4387 type: boolean 4388 hostPID: 4389 description: 'Use the host''s pid namespace. Optional: Default to false.' 4390 type: boolean 4391 hostname: 4392 description: Specifies the hostname of the Pod If not specified, the pod's 4393 hostname will be set to a system-defined value. 4394 type: string 4395 imagePullSecrets: 4396 description: 'ImagePullSecrets is an optional list of references to secrets 4397 in the same namespace to use for pulling any of the images used by this 4398 PodSpec. If specified, these secrets will be passed to individual puller 4399 implementations for them to use. For example, in the case of docker, only 4400 DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod' 4401 items: 4402 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 4403 type: array 4404 x-kubernetes-patch-merge-key: name 4405 x-kubernetes-patch-strategy: merge 4406 initContainers: 4407 description: 'List of initialization containers belonging to the pod. Init 4408 containers are executed in order prior to containers being started. If any 4409 init container fails, the pod is considered to have failed and is handled 4410 according to its restartPolicy. The name for an init container or normal 4411 container must be unique among all containers. Init containers may not have 4412 Lifecycle actions, Readiness probes, Liveness probes, or Startup probes. 4413 The resourceRequirements of an init container are taken into account during 4414 scheduling by finding the highest request/limit for each resource type, 4415 and then using the max of of that value or the sum of the normal containers. 4416 Limits are applied to init containers in a similar fashion. Init containers 4417 cannot currently be added or removed. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/' 4418 items: 4419 $ref: '#/definitions/io.k8s.api.core.v1.Container' 4420 type: array 4421 x-kubernetes-patch-merge-key: name 4422 x-kubernetes-patch-strategy: merge 4423 nodeName: 4424 description: NodeName is a request to schedule this pod onto a specific node. 4425 If it is non-empty, the scheduler simply schedules this pod onto that node, 4426 assuming that it fits resource requirements. 4427 type: string 4428 nodeSelector: 4429 additionalProperties: 4430 type: string 4431 description: 'NodeSelector is a selector which must be true for the pod to 4432 fit on a node. Selector which must match a node''s labels for the pod to 4433 be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/' 4434 type: object 4435 overhead: 4436 additionalProperties: 4437 $ref: '#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity' 4438 description: 'Overhead represents the resource overhead associated with running 4439 a pod for a given RuntimeClass. This field will be autopopulated at admission 4440 time by the RuntimeClass admission controller. If the RuntimeClass admission 4441 controller is enabled, overhead must not be set in Pod create requests. 4442 The RuntimeClass admission controller will reject Pod create requests which 4443 have the overhead already set. If RuntimeClass is configured and selected 4444 in the PodSpec, Overhead will be set to the value defined in the corresponding 4445 RuntimeClass, otherwise it will remain unset and treated as zero. More info: 4446 https://git.k8s.io/enhancements/keps/sig-node/20190226-pod-overhead.md This 4447 field is alpha-level as of Kubernetes v1.16, and is only honored by servers 4448 that enable the PodOverhead feature.' 4449 type: object 4450 preemptionPolicy: 4451 description: PreemptionPolicy is the Policy for preempting pods with lower 4452 priority. One of Never, PreemptLowerPriority. Defaults to PreemptLowerPriority 4453 if unset. This field is alpha-level and is only honored by servers that 4454 enable the NonPreemptingPriority feature. 4455 type: string 4456 priority: 4457 description: The priority value. Various system components use this field 4458 to find the priority of the pod. When Priority Admission Controller is enabled, 4459 it prevents users from setting this field. The admission controller populates 4460 this field from PriorityClassName. The higher the value, the higher the 4461 priority. 4462 format: int32 4463 type: integer 4464 priorityClassName: 4465 description: If specified, indicates the pod's priority. "system-node-critical" 4466 and "system-cluster-critical" are two special keywords which indicate the 4467 highest priorities with the former being the highest priority. Any other 4468 name must be defined by creating a PriorityClass object with that name. 4469 If not specified, the pod priority will be default or zero if there is no 4470 default. 4471 type: string 4472 readinessGates: 4473 description: 'If specified, all readiness gates will be evaluated for pod 4474 readiness. A pod is ready when all its containers are ready AND all conditions 4475 specified in the readiness gates have status equal to "True" More info: 4476 https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md' 4477 items: 4478 $ref: '#/definitions/io.k8s.api.core.v1.PodReadinessGate' 4479 type: array 4480 restartPolicy: 4481 description: 'Restart policy for all containers within the pod. One of Always, 4482 OnFailure, Never. Default to Always. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy' 4483 type: string 4484 runtimeClassName: 4485 description: 'RuntimeClassName refers to a RuntimeClass object in the node.k8s.io 4486 group, which should be used to run this pod. If no RuntimeClass resource 4487 matches the named class, the pod will not be run. If unset or empty, the 4488 "legacy" RuntimeClass will be used, which is an implicit class with an empty 4489 definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md 4490 This is a beta feature as of Kubernetes v1.14.' 4491 type: string 4492 schedulerName: 4493 description: If specified, the pod will be dispatched by specified scheduler. 4494 If not specified, the pod will be dispatched by default scheduler. 4495 type: string 4496 securityContext: 4497 $ref: '#/definitions/io.k8s.api.core.v1.PodSecurityContext' 4498 description: 'SecurityContext holds pod-level security attributes and common 4499 container settings. Optional: Defaults to empty. See type description for 4500 default values of each field.' 4501 serviceAccount: 4502 description: 'DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. 4503 Deprecated: Use serviceAccountName instead.' 4504 type: string 4505 serviceAccountName: 4506 description: 'ServiceAccountName is the name of the ServiceAccount to use 4507 to run this pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/' 4508 type: string 4509 shareProcessNamespace: 4510 description: 'Share a single process namespace between all of the containers 4511 in a pod. When this is set containers will be able to view and signal processes 4512 from other containers in the same pod, and the first process in each container 4513 will not be assigned PID 1. HostPID and ShareProcessNamespace cannot both 4514 be set. Optional: Default to false. This field is beta-level and may be 4515 disabled with the PodShareProcessNamespace feature.' 4516 type: boolean 4517 subdomain: 4518 description: If specified, the fully qualified Pod hostname will be "<hostname>.<subdomain>.<pod 4519 namespace>.svc.<cluster domain>". If not specified, the pod will not have 4520 a domainname at all. 4521 type: string 4522 terminationGracePeriodSeconds: 4523 description: Optional duration in seconds the pod needs to terminate gracefully. 4524 May be decreased in delete request. Value must be non-negative integer. 4525 The value zero indicates delete immediately. If this value is nil, the default 4526 grace period will be used instead. The grace period is the duration in seconds 4527 after the processes running in the pod are sent a termination signal and 4528 the time when the processes are forcibly halted with a kill signal. Set 4529 this value longer than the expected cleanup time for your process. Defaults 4530 to 30 seconds. 4531 format: int64 4532 type: integer 4533 tolerations: 4534 description: If specified, the pod's tolerations. 4535 items: 4536 $ref: '#/definitions/io.k8s.api.core.v1.Toleration' 4537 type: array 4538 topologySpreadConstraints: 4539 description: TopologySpreadConstraints describes how a group of pods ought 4540 to spread across topology domains. Scheduler will schedule pods in a way 4541 which abides by the constraints. This field is alpha-level and is only honored 4542 by clusters that enables the EvenPodsSpread feature. All topologySpreadConstraints 4543 are ANDed. 4544 items: 4545 $ref: '#/definitions/io.k8s.api.core.v1.TopologySpreadConstraint' 4546 type: array 4547 x-kubernetes-list-map-keys: 4548 - topologyKey 4549 - whenUnsatisfiable 4550 x-kubernetes-list-type: map 4551 x-kubernetes-patch-merge-key: topologyKey 4552 x-kubernetes-patch-strategy: merge 4553 volumes: 4554 description: 'List of volumes that can be mounted by containers belonging 4555 to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes' 4556 items: 4557 $ref: '#/definitions/io.k8s.api.core.v1.Volume' 4558 type: array 4559 x-kubernetes-patch-merge-key: name 4560 x-kubernetes-patch-strategy: merge,retainKeys 4561 required: 4562 - containers 4563 type: object 4564 io.k8s.api.core.v1.PodTemplateSpec: 4565 description: PodTemplateSpec describes the data a pod should have when created 4566 from a template 4567 properties: 4568 metadata: 4569 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 4570 description: 'Standard object''s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata' 4571 spec: 4572 $ref: '#/definitions/io.k8s.api.core.v1.PodSpec' 4573 description: 'Specification of the desired behavior of the pod. More info: 4574 https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status' 4575 type: object 4576 io.k8s.api.core.v1.PortworxVolumeSource: 4577 description: PortworxVolumeSource represents a Portworx volume resource. 4578 properties: 4579 fsType: 4580 description: FSType represents the filesystem type to mount Must be a filesystem 4581 type supported by the host operating system. Ex. "ext4", "xfs". Implicitly 4582 inferred to be "ext4" if unspecified. 4583 type: string 4584 readOnly: 4585 description: Defaults to false (read/write). ReadOnly here will force the 4586 ReadOnly setting in VolumeMounts. 4587 type: boolean 4588 volumeID: 4589 description: VolumeID uniquely identifies a Portworx volume 4590 type: string 4591 required: 4592 - volumeID 4593 type: object 4594 io.k8s.api.core.v1.PreferredSchedulingTerm: 4595 description: An empty preferred scheduling term matches all objects with implicit 4596 weight 0 (i.e. it's a no-op). A null preferred scheduling term matches no objects 4597 (i.e. is also a no-op). 4598 properties: 4599 preference: 4600 $ref: '#/definitions/io.k8s.api.core.v1.NodeSelectorTerm' 4601 description: A node selector term, associated with the corresponding weight. 4602 weight: 4603 description: Weight associated with matching the corresponding nodeSelectorTerm, 4604 in the range 1-100. 4605 format: int32 4606 type: integer 4607 required: 4608 - weight 4609 - preference 4610 type: object 4611 io.k8s.api.core.v1.Probe: 4612 description: Probe describes a health check to be performed against a container 4613 to determine whether it is alive or ready to receive traffic. 4614 properties: 4615 exec: 4616 $ref: '#/definitions/io.k8s.api.core.v1.ExecAction' 4617 description: One and only one of the following should be specified. Exec specifies 4618 the action to take. 4619 failureThreshold: 4620 description: Minimum consecutive failures for the probe to be considered failed 4621 after having succeeded. Defaults to 3. Minimum value is 1. 4622 format: int32 4623 type: integer 4624 httpGet: 4625 $ref: '#/definitions/io.k8s.api.core.v1.HTTPGetAction' 4626 description: HTTPGet specifies the http request to perform. 4627 initialDelaySeconds: 4628 description: 'Number of seconds after the container has started before liveness 4629 probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' 4630 format: int32 4631 type: integer 4632 periodSeconds: 4633 description: How often (in seconds) to perform the probe. Default to 10 seconds. 4634 Minimum value is 1. 4635 format: int32 4636 type: integer 4637 successThreshold: 4638 description: Minimum consecutive successes for the probe to be considered 4639 successful after having failed. Defaults to 1. Must be 1 for liveness and 4640 startup. Minimum value is 1. 4641 format: int32 4642 type: integer 4643 tcpSocket: 4644 $ref: '#/definitions/io.k8s.api.core.v1.TCPSocketAction' 4645 description: TCPSocket specifies an action involving a TCP port. TCP hooks 4646 not yet supported 4647 timeoutSeconds: 4648 description: 'Number of seconds after which the probe times out. Defaults 4649 to 1 second. Minimum value is 1. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes' 4650 format: int32 4651 type: integer 4652 type: object 4653 io.k8s.api.core.v1.ProjectedVolumeSource: 4654 description: Represents a projected volume source 4655 properties: 4656 defaultMode: 4657 description: Mode bits to use on created files by default. Must be a value 4658 between 0 and 0777. Directories within the path are not affected by this 4659 setting. This might be in conflict with other options that affect the file 4660 mode, like fsGroup, and the result can be other mode bits set. 4661 format: int32 4662 type: integer 4663 sources: 4664 description: list of volume projections 4665 items: 4666 $ref: '#/definitions/io.k8s.api.core.v1.VolumeProjection' 4667 type: array 4668 required: 4669 - sources 4670 type: object 4671 io.k8s.api.core.v1.QuobyteVolumeSource: 4672 description: Represents a Quobyte mount that lasts the lifetime of a pod. Quobyte 4673 volumes do not support ownership management or SELinux relabeling. 4674 properties: 4675 group: 4676 description: Group to map volume access to Default is no group 4677 type: string 4678 readOnly: 4679 description: ReadOnly here will force the Quobyte volume to be mounted with 4680 read-only permissions. Defaults to false. 4681 type: boolean 4682 registry: 4683 description: Registry represents a single or multiple Quobyte Registry services 4684 specified as a string as host:port pair (multiple entries are separated 4685 with commas) which acts as the central registry for volumes 4686 type: string 4687 tenant: 4688 description: Tenant owning the given Quobyte volume in the Backend Used with 4689 dynamically provisioned Quobyte volumes, value is set by the plugin 4690 type: string 4691 user: 4692 description: User to map volume access to Defaults to serivceaccount user 4693 type: string 4694 volume: 4695 description: Volume is a string that references an already created Quobyte 4696 volume by name. 4697 type: string 4698 required: 4699 - registry 4700 - volume 4701 type: object 4702 io.k8s.api.core.v1.RBDVolumeSource: 4703 description: Represents a Rados Block Device mount that lasts the lifetime of 4704 a pod. RBD volumes support ownership management and SELinux relabeling. 4705 properties: 4706 fsType: 4707 description: 'Filesystem type of the volume that you want to mount. Tip: Ensure 4708 that the filesystem type is supported by the host operating system. Examples: 4709 "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. 4710 More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd' 4711 type: string 4712 image: 4713 description: 'The rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' 4714 type: string 4715 keyring: 4716 description: 'Keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. 4717 More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' 4718 type: string 4719 monitors: 4720 description: 'A collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' 4721 items: 4722 type: string 4723 type: array 4724 pool: 4725 description: 'The rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' 4726 type: string 4727 readOnly: 4728 description: 'ReadOnly here will force the ReadOnly setting in VolumeMounts. 4729 Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' 4730 type: boolean 4731 secretRef: 4732 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 4733 description: 'SecretRef is name of the authentication secret for RBDUser. 4734 If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' 4735 user: 4736 description: 'The rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it' 4737 type: string 4738 required: 4739 - monitors 4740 - image 4741 type: object 4742 io.k8s.api.core.v1.ResourceFieldSelector: 4743 description: ResourceFieldSelector represents container resources (cpu, memory) 4744 and their output format 4745 properties: 4746 containerName: 4747 description: 'Container name: required for volumes, optional for env vars' 4748 type: string 4749 divisor: 4750 $ref: '#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity' 4751 description: Specifies the output format of the exposed resources, defaults 4752 to "1" 4753 resource: 4754 description: 'Required: resource to select' 4755 type: string 4756 required: 4757 - resource 4758 type: object 4759 io.k8s.api.core.v1.ResourceRequirements: 4760 description: ResourceRequirements describes the compute resource requirements. 4761 properties: 4762 limits: 4763 additionalProperties: 4764 $ref: '#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity' 4765 description: 'Limits describes the maximum amount of compute resources allowed. 4766 More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' 4767 type: object 4768 requests: 4769 additionalProperties: 4770 $ref: '#/definitions/io.k8s.apimachinery.pkg.api.resource.Quantity' 4771 description: 'Requests describes the minimum amount of compute resources required. 4772 If Requests is omitted for a container, it defaults to Limits if that is 4773 explicitly specified, otherwise to an implementation-defined value. More 4774 info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/' 4775 type: object 4776 type: object 4777 io.k8s.api.core.v1.SELinuxOptions: 4778 description: SELinuxOptions are the labels to be applied to the container 4779 properties: 4780 level: 4781 description: Level is SELinux level label that applies to the container. 4782 type: string 4783 role: 4784 description: Role is a SELinux role label that applies to the container. 4785 type: string 4786 type: 4787 description: Type is a SELinux type label that applies to the container. 4788 type: string 4789 user: 4790 description: User is a SELinux user label that applies to the container. 4791 type: string 4792 type: object 4793 io.k8s.api.core.v1.ScaleIOVolumeSource: 4794 description: ScaleIOVolumeSource represents a persistent ScaleIO volume 4795 properties: 4796 fsType: 4797 description: Filesystem type to mount. Must be a filesystem type supported 4798 by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs". 4799 type: string 4800 gateway: 4801 description: The host address of the ScaleIO API Gateway. 4802 type: string 4803 protectionDomain: 4804 description: The name of the ScaleIO Protection Domain for the configured 4805 storage. 4806 type: string 4807 readOnly: 4808 description: Defaults to false (read/write). ReadOnly here will force the 4809 ReadOnly setting in VolumeMounts. 4810 type: boolean 4811 secretRef: 4812 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 4813 description: SecretRef references to the secret for ScaleIO user and other 4814 sensitive information. If this is not provided, Login operation will fail. 4815 sslEnabled: 4816 description: Flag to enable/disable SSL communication with Gateway, default 4817 false 4818 type: boolean 4819 storageMode: 4820 description: Indicates whether the storage for a volume should be ThickProvisioned 4821 or ThinProvisioned. Default is ThinProvisioned. 4822 type: string 4823 storagePool: 4824 description: The ScaleIO Storage Pool associated with the protection domain. 4825 type: string 4826 system: 4827 description: The name of the storage system as configured in ScaleIO. 4828 type: string 4829 volumeName: 4830 description: The name of a volume already created in the ScaleIO system that 4831 is associated with this volume source. 4832 type: string 4833 required: 4834 - gateway 4835 - system 4836 - secretRef 4837 type: object 4838 io.k8s.api.core.v1.SecretEnvSource: 4839 description: |- 4840 SecretEnvSource selects a Secret to populate the environment variables with. 4841 4842 The contents of the target Secret's Data field will represent the key-value pairs as environment variables. 4843 properties: 4844 name: 4845 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 4846 type: string 4847 optional: 4848 description: Specify whether the Secret must be defined 4849 type: boolean 4850 type: object 4851 io.k8s.api.core.v1.SecretKeySelector: 4852 description: SecretKeySelector selects a key of a Secret. 4853 properties: 4854 key: 4855 description: The key of the secret to select from. Must be a valid secret 4856 key. 4857 type: string 4858 name: 4859 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 4860 type: string 4861 optional: 4862 description: Specify whether the Secret or its key must be defined 4863 type: boolean 4864 required: 4865 - key 4866 type: object 4867 io.k8s.api.core.v1.SecretProjection: 4868 description: |- 4869 Adapts a secret into a projected volume. 4870 4871 The contents of the target Secret's Data field will be presented in a projected volume as files using the keys in the Data field as the file names. Note that this is identical to a secret volume source without the default mode. 4872 properties: 4873 items: 4874 description: If unspecified, each key-value pair in the Data field of the 4875 referenced Secret will be projected into the volume as a file whose name 4876 is the key and content is the value. If specified, the listed keys will 4877 be projected into the specified paths, and unlisted keys will not be present. 4878 If a key is specified which is not present in the Secret, the volume setup 4879 will error unless it is marked optional. Paths must be relative and may 4880 not contain the '..' path or start with '..'. 4881 items: 4882 $ref: '#/definitions/io.k8s.api.core.v1.KeyToPath' 4883 type: array 4884 name: 4885 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 4886 type: string 4887 optional: 4888 description: Specify whether the Secret or its key must be defined 4889 type: boolean 4890 type: object 4891 io.k8s.api.core.v1.SecretVolumeSource: 4892 description: |- 4893 Adapts a Secret into a volume. 4894 4895 The contents of the target Secret's Data field will be presented in a volume as files using the keys in the Data field as the file names. Secret volumes support ownership management and SELinux relabeling. 4896 properties: 4897 defaultMode: 4898 description: 'Optional: mode bits to use on created files by default. Must 4899 be a value between 0 and 0777. Defaults to 0644. Directories within the 4900 path are not affected by this setting. This might be in conflict with other 4901 options that affect the file mode, like fsGroup, and the result can be other 4902 mode bits set.' 4903 format: int32 4904 type: integer 4905 items: 4906 description: If unspecified, each key-value pair in the Data field of the 4907 referenced Secret will be projected into the volume as a file whose name 4908 is the key and content is the value. If specified, the listed keys will 4909 be projected into the specified paths, and unlisted keys will not be present. 4910 If a key is specified which is not present in the Secret, the volume setup 4911 will error unless it is marked optional. Paths must be relative and may 4912 not contain the '..' path or start with '..'. 4913 items: 4914 $ref: '#/definitions/io.k8s.api.core.v1.KeyToPath' 4915 type: array 4916 optional: 4917 description: Specify whether the Secret or its keys must be defined 4918 type: boolean 4919 secretName: 4920 description: 'Name of the secret in the pod''s namespace to use. More info: 4921 https://kubernetes.io/docs/concepts/storage/volumes#secret' 4922 type: string 4923 type: object 4924 io.k8s.api.core.v1.SecurityContext: 4925 description: SecurityContext holds security configuration that will be applied 4926 to a container. Some fields are present in both SecurityContext and PodSecurityContext. When 4927 both are set, the values in SecurityContext take precedence. 4928 properties: 4929 allowPrivilegeEscalation: 4930 description: 'AllowPrivilegeEscalation controls whether a process can gain 4931 more privileges than its parent process. This bool directly controls if 4932 the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation 4933 is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN' 4934 type: boolean 4935 capabilities: 4936 $ref: '#/definitions/io.k8s.api.core.v1.Capabilities' 4937 description: The capabilities to add/drop when running containers. Defaults 4938 to the default set of capabilities granted by the container runtime. 4939 privileged: 4940 description: Run container in privileged mode. Processes in privileged containers 4941 are essentially equivalent to root on the host. Defaults to false. 4942 type: boolean 4943 procMount: 4944 description: procMount denotes the type of proc mount to use for the containers. 4945 The default is DefaultProcMount which uses the container runtime defaults 4946 for readonly paths and masked paths. This requires the ProcMountType feature 4947 flag to be enabled. 4948 type: string 4949 readOnlyRootFilesystem: 4950 description: Whether this container has a read-only root filesystem. Default 4951 is false. 4952 type: boolean 4953 runAsGroup: 4954 description: The GID to run the entrypoint of the container process. Uses 4955 runtime default if unset. May also be set in PodSecurityContext. If set 4956 in both SecurityContext and PodSecurityContext, the value specified in SecurityContext 4957 takes precedence. 4958 format: int64 4959 type: integer 4960 runAsNonRoot: 4961 description: Indicates that the container must run as a non-root user. If 4962 true, the Kubelet will validate the image at runtime to ensure that it does 4963 not run as UID 0 (root) and fail to start the container if it does. If unset 4964 or false, no such validation will be performed. May also be set in PodSecurityContext. If 4965 set in both SecurityContext and PodSecurityContext, the value specified 4966 in SecurityContext takes precedence. 4967 type: boolean 4968 runAsUser: 4969 description: The UID to run the entrypoint of the container process. Defaults 4970 to user specified in image metadata if unspecified. May also be set in PodSecurityContext. If 4971 set in both SecurityContext and PodSecurityContext, the value specified 4972 in SecurityContext takes precedence. 4973 format: int64 4974 type: integer 4975 seLinuxOptions: 4976 $ref: '#/definitions/io.k8s.api.core.v1.SELinuxOptions' 4977 description: The SELinux context to be applied to the container. If unspecified, 4978 the container runtime will allocate a random SELinux context for each container. May 4979 also be set in PodSecurityContext. If set in both SecurityContext and PodSecurityContext, 4980 the value specified in SecurityContext takes precedence. 4981 windowsOptions: 4982 $ref: '#/definitions/io.k8s.api.core.v1.WindowsSecurityContextOptions' 4983 description: The Windows specific settings applied to all containers. If unspecified, 4984 the options from the PodSecurityContext will be used. If set in both SecurityContext 4985 and PodSecurityContext, the value specified in SecurityContext takes precedence. 4986 type: object 4987 io.k8s.api.core.v1.ServiceAccountTokenProjection: 4988 description: ServiceAccountTokenProjection represents a projected service account 4989 token volume. This projection can be used to insert a service account token 4990 into the pods runtime filesystem for use against APIs (Kubernetes API Server 4991 or otherwise). 4992 properties: 4993 audience: 4994 description: Audience is the intended audience of the token. A recipient of 4995 a token must identify itself with an identifier specified in the audience 4996 of the token, and otherwise should reject the token. The audience defaults 4997 to the identifier of the apiserver. 4998 type: string 4999 expirationSeconds: 5000 description: ExpirationSeconds is the requested duration of validity of the 5001 service account token. As the token approaches expiration, the kubelet volume 5002 plugin will proactively rotate the service account token. The kubelet will 5003 start trying to rotate the token if the token is older than 80 percent of 5004 its time to live or if the token is older than 24 hours.Defaults to 1 hour 5005 and must be at least 10 minutes. 5006 format: int64 5007 type: integer 5008 path: 5009 description: Path is the path relative to the mount point of the file to project 5010 the token into. 5011 type: string 5012 required: 5013 - path 5014 type: object 5015 io.k8s.api.core.v1.StorageOSVolumeSource: 5016 description: Represents a StorageOS persistent volume resource. 5017 properties: 5018 fsType: 5019 description: Filesystem type to mount. Must be a filesystem type supported 5020 by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred 5021 to be "ext4" if unspecified. 5022 type: string 5023 readOnly: 5024 description: Defaults to false (read/write). ReadOnly here will force the 5025 ReadOnly setting in VolumeMounts. 5026 type: boolean 5027 secretRef: 5028 $ref: '#/definitions/io.k8s.api.core.v1.LocalObjectReference' 5029 description: SecretRef specifies the secret to use for obtaining the StorageOS 5030 API credentials. If not specified, default values will be attempted. 5031 volumeName: 5032 description: VolumeName is the human-readable name of the StorageOS volume. Volume 5033 names are only unique within a namespace. 5034 type: string 5035 volumeNamespace: 5036 description: VolumeNamespace specifies the scope of the volume within StorageOS. If 5037 no namespace is specified then the Pod's namespace will be used. This allows 5038 the Kubernetes name scoping to be mirrored within StorageOS for tighter 5039 integration. Set VolumeName to any name to override the default behaviour. 5040 Set to "default" if you are not using namespaces within StorageOS. Namespaces 5041 that do not pre-exist within StorageOS will be created. 5042 type: string 5043 type: object 5044 io.k8s.api.core.v1.Sysctl: 5045 description: Sysctl defines a kernel parameter to be set 5046 properties: 5047 name: 5048 description: Name of a property to set 5049 type: string 5050 value: 5051 description: Value of a property to set 5052 type: string 5053 required: 5054 - name 5055 - value 5056 type: object 5057 io.k8s.api.core.v1.TCPSocketAction: 5058 description: TCPSocketAction describes an action based on opening a socket 5059 properties: 5060 host: 5061 description: 'Optional: Host name to connect to, defaults to the pod IP.' 5062 type: string 5063 port: 5064 $ref: '#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString' 5065 description: Number or name of the port to access on the container. Number 5066 must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. 5067 required: 5068 - port 5069 type: object 5070 io.k8s.api.core.v1.Toleration: 5071 description: The pod this Toleration is attached to tolerates any taint that matches 5072 the triple <key,value,effect> using the matching operator <operator>. 5073 properties: 5074 effect: 5075 description: Effect indicates the taint effect to match. Empty means match 5076 all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule 5077 and NoExecute. 5078 type: string 5079 key: 5080 description: Key is the taint key that the toleration applies to. Empty means 5081 match all taint keys. If the key is empty, operator must be Exists; this 5082 combination means to match all values and all keys. 5083 type: string 5084 operator: 5085 description: Operator represents a key's relationship to the value. Valid 5086 operators are Exists and Equal. Defaults to Equal. Exists is equivalent 5087 to wildcard for value, so that a pod can tolerate all taints of a particular 5088 category. 5089 type: string 5090 tolerationSeconds: 5091 description: TolerationSeconds represents the period of time the toleration 5092 (which must be of effect NoExecute, otherwise this field is ignored) tolerates 5093 the taint. By default, it is not set, which means tolerate the taint forever 5094 (do not evict). Zero and negative values will be treated as 0 (evict immediately) 5095 by the system. 5096 format: int64 5097 type: integer 5098 value: 5099 description: Value is the taint value the toleration matches to. If the operator 5100 is Exists, the value should be empty, otherwise just a regular string. 5101 type: string 5102 type: object 5103 io.k8s.api.core.v1.TopologySpreadConstraint: 5104 description: TopologySpreadConstraint specifies how to spread matching pods among 5105 the given topology. 5106 properties: 5107 labelSelector: 5108 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector' 5109 description: LabelSelector is used to find matching pods. Pods that match 5110 this label selector are counted to determine the number of pods in their 5111 corresponding topology domain. 5112 maxSkew: 5113 description: 'MaxSkew describes the degree to which pods may be unevenly distributed. 5114 It''s the maximum permitted difference between the number of matching pods 5115 in any two topology domains of a given topology type. For example, in a 5116 3-zone cluster, MaxSkew is set to 1, and pods with the same labelSelector 5117 spread as 1/1/0: | zone1 | zone2 | zone3 | | P | P | | - if 5118 MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 1/1/1; 5119 scheduling it onto zone1(zone2) would make the ActualSkew(2-0) on zone1(zone2) 5120 violate MaxSkew(1). - if MaxSkew is 2, incoming pod can be scheduled onto 5121 any zone. It''s a required field. Default value is 1 and 0 is not allowed.' 5122 format: int32 5123 type: integer 5124 topologyKey: 5125 description: TopologyKey is the key of node labels. Nodes that have a label 5126 with this key and identical values are considered to be in the same topology. 5127 We consider each <key, value> as a "bucket", and try to put balanced number 5128 of pods into each bucket. It's a required field. 5129 type: string 5130 whenUnsatisfiable: 5131 description: 'WhenUnsatisfiable indicates how to deal with a pod if it doesn''t 5132 satisfy the spread constraint. - DoNotSchedule (default) tells the scheduler 5133 not to schedule it - ScheduleAnyway tells the scheduler to still schedule 5134 it It''s considered as "Unsatisfiable" if and only if placing incoming pod 5135 on any topology violates "MaxSkew". For example, in a 3-zone cluster, MaxSkew 5136 is set to 1, and pods with the same labelSelector spread as 3/1/1: | zone1 5137 | zone2 | zone3 | | P P P | P | P | If WhenUnsatisfiable is set 5138 to DoNotSchedule, incoming pod can only be scheduled to zone2(zone3) to 5139 become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies MaxSkew(1). 5140 In other words, the cluster can still be imbalanced, but scheduler won''t 5141 make it *more* imbalanced. It''s a required field.' 5142 type: string 5143 required: 5144 - maxSkew 5145 - topologyKey 5146 - whenUnsatisfiable 5147 type: object 5148 io.k8s.api.core.v1.Volume: 5149 description: Volume represents a named volume in a pod that may be accessed by 5150 any container in the pod. 5151 properties: 5152 awsElasticBlockStore: 5153 $ref: '#/definitions/io.k8s.api.core.v1.AWSElasticBlockStoreVolumeSource' 5154 description: 'AWSElasticBlockStore represents an AWS Disk resource that is 5155 attached to a kubelet''s host machine and then exposed to the pod. More 5156 info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore' 5157 azureDisk: 5158 $ref: '#/definitions/io.k8s.api.core.v1.AzureDiskVolumeSource' 5159 description: AzureDisk represents an Azure Data Disk mount on the host and 5160 bind mount to the pod. 5161 azureFile: 5162 $ref: '#/definitions/io.k8s.api.core.v1.AzureFileVolumeSource' 5163 description: AzureFile represents an Azure File Service mount on the host 5164 and bind mount to the pod. 5165 cephfs: 5166 $ref: '#/definitions/io.k8s.api.core.v1.CephFSVolumeSource' 5167 description: CephFS represents a Ceph FS mount on the host that shares a pod's 5168 lifetime 5169 cinder: 5170 $ref: '#/definitions/io.k8s.api.core.v1.CinderVolumeSource' 5171 description: 'Cinder represents a cinder volume attached and mounted on kubelets 5172 host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md' 5173 configMap: 5174 $ref: '#/definitions/io.k8s.api.core.v1.ConfigMapVolumeSource' 5175 description: ConfigMap represents a configMap that should populate this volume 5176 csi: 5177 $ref: '#/definitions/io.k8s.api.core.v1.CSIVolumeSource' 5178 description: CSI (Container Storage Interface) represents storage that is 5179 handled by an external CSI driver (Alpha feature). 5180 downwardAPI: 5181 $ref: '#/definitions/io.k8s.api.core.v1.DownwardAPIVolumeSource' 5182 description: DownwardAPI represents downward API about the pod that should 5183 populate this volume 5184 emptyDir: 5185 $ref: '#/definitions/io.k8s.api.core.v1.EmptyDirVolumeSource' 5186 description: 'EmptyDir represents a temporary directory that shares a pod''s 5187 lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir' 5188 fc: 5189 $ref: '#/definitions/io.k8s.api.core.v1.FCVolumeSource' 5190 description: FC represents a Fibre Channel resource that is attached to a 5191 kubelet's host machine and then exposed to the pod. 5192 flexVolume: 5193 $ref: '#/definitions/io.k8s.api.core.v1.FlexVolumeSource' 5194 description: FlexVolume represents a generic volume resource that is provisioned/attached 5195 using an exec based plugin. 5196 flocker: 5197 $ref: '#/definitions/io.k8s.api.core.v1.FlockerVolumeSource' 5198 description: Flocker represents a Flocker volume attached to a kubelet's host 5199 machine. This depends on the Flocker control service being running 5200 gcePersistentDisk: 5201 $ref: '#/definitions/io.k8s.api.core.v1.GCEPersistentDiskVolumeSource' 5202 description: 'GCEPersistentDisk represents a GCE Disk resource that is attached 5203 to a kubelet''s host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk' 5204 gitRepo: 5205 $ref: '#/definitions/io.k8s.api.core.v1.GitRepoVolumeSource' 5206 description: 'GitRepo represents a git repository at a particular revision. 5207 DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, 5208 mount an EmptyDir into an InitContainer that clones the repo using git, 5209 then mount the EmptyDir into the Pod''s container.' 5210 glusterfs: 5211 $ref: '#/definitions/io.k8s.api.core.v1.GlusterfsVolumeSource' 5212 description: 'Glusterfs represents a Glusterfs mount on the host that shares 5213 a pod''s lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md' 5214 hostPath: 5215 $ref: '#/definitions/io.k8s.api.core.v1.HostPathVolumeSource' 5216 description: 'HostPath represents a pre-existing file or directory on the 5217 host machine that is directly exposed to the container. This is generally 5218 used for system agents or other privileged things that are allowed to see 5219 the host machine. Most containers will NOT need this. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath' 5220 iscsi: 5221 $ref: '#/definitions/io.k8s.api.core.v1.ISCSIVolumeSource' 5222 description: 'ISCSI represents an ISCSI Disk resource that is attached to 5223 a kubelet''s host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md' 5224 name: 5225 description: 'Volume''s name. Must be a DNS_LABEL and unique within the pod. 5226 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' 5227 type: string 5228 nfs: 5229 $ref: '#/definitions/io.k8s.api.core.v1.NFSVolumeSource' 5230 description: 'NFS represents an NFS mount on the host that shares a pod''s 5231 lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs' 5232 persistentVolumeClaim: 5233 $ref: '#/definitions/io.k8s.api.core.v1.PersistentVolumeClaimVolumeSource' 5234 description: 'PersistentVolumeClaimVolumeSource represents a reference to 5235 a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims' 5236 photonPersistentDisk: 5237 $ref: '#/definitions/io.k8s.api.core.v1.PhotonPersistentDiskVolumeSource' 5238 description: PhotonPersistentDisk represents a PhotonController persistent 5239 disk attached and mounted on kubelets host machine 5240 portworxVolume: 5241 $ref: '#/definitions/io.k8s.api.core.v1.PortworxVolumeSource' 5242 description: PortworxVolume represents a portworx volume attached and mounted 5243 on kubelets host machine 5244 projected: 5245 $ref: '#/definitions/io.k8s.api.core.v1.ProjectedVolumeSource' 5246 description: Items for all in one resources secrets, configmaps, and downward 5247 API 5248 quobyte: 5249 $ref: '#/definitions/io.k8s.api.core.v1.QuobyteVolumeSource' 5250 description: Quobyte represents a Quobyte mount on the host that shares a 5251 pod's lifetime 5252 rbd: 5253 $ref: '#/definitions/io.k8s.api.core.v1.RBDVolumeSource' 5254 description: 'RBD represents a Rados Block Device mount on the host that shares 5255 a pod''s lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md' 5256 scaleIO: 5257 $ref: '#/definitions/io.k8s.api.core.v1.ScaleIOVolumeSource' 5258 description: ScaleIO represents a ScaleIO persistent volume attached and mounted 5259 on Kubernetes nodes. 5260 secret: 5261 $ref: '#/definitions/io.k8s.api.core.v1.SecretVolumeSource' 5262 description: 'Secret represents a secret that should populate this volume. 5263 More info: https://kubernetes.io/docs/concepts/storage/volumes#secret' 5264 storageos: 5265 $ref: '#/definitions/io.k8s.api.core.v1.StorageOSVolumeSource' 5266 description: StorageOS represents a StorageOS volume attached and mounted 5267 on Kubernetes nodes. 5268 vsphereVolume: 5269 $ref: '#/definitions/io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource' 5270 description: VsphereVolume represents a vSphere volume attached and mounted 5271 on kubelets host machine 5272 required: 5273 - name 5274 type: object 5275 io.k8s.api.core.v1.VolumeDevice: 5276 description: volumeDevice describes a mapping of a raw block device within a container. 5277 properties: 5278 devicePath: 5279 description: devicePath is the path inside of the container that the device 5280 will be mapped to. 5281 type: string 5282 name: 5283 description: name must match the name of a persistentVolumeClaim in the pod 5284 type: string 5285 required: 5286 - name 5287 - devicePath 5288 type: object 5289 io.k8s.api.core.v1.VolumeMount: 5290 description: VolumeMount describes a mounting of a Volume within a container. 5291 properties: 5292 mountPath: 5293 description: Path within the container at which the volume should be mounted. Must 5294 not contain ':'. 5295 type: string 5296 mountPropagation: 5297 description: mountPropagation determines how mounts are propagated from the 5298 host to container and the other way around. When not set, MountPropagationNone 5299 is used. This field is beta in 1.10. 5300 type: string 5301 name: 5302 description: This must match the Name of a Volume. 5303 type: string 5304 readOnly: 5305 description: Mounted read-only if true, read-write otherwise (false or unspecified). 5306 Defaults to false. 5307 type: boolean 5308 subPath: 5309 description: Path within the volume from which the container's volume should 5310 be mounted. Defaults to "" (volume's root). 5311 type: string 5312 subPathExpr: 5313 description: Expanded path within the volume from which the container's volume 5314 should be mounted. Behaves similarly to SubPath but environment variable 5315 references $(VAR_NAME) are expanded using the container's environment. Defaults 5316 to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. This 5317 field is beta in 1.15. 5318 type: string 5319 required: 5320 - name 5321 - mountPath 5322 type: object 5323 io.k8s.api.core.v1.VolumeProjection: 5324 description: Projection that may be projected along with other supported volume 5325 types 5326 properties: 5327 configMap: 5328 $ref: '#/definitions/io.k8s.api.core.v1.ConfigMapProjection' 5329 description: information about the configMap data to project 5330 downwardAPI: 5331 $ref: '#/definitions/io.k8s.api.core.v1.DownwardAPIProjection' 5332 description: information about the downwardAPI data to project 5333 secret: 5334 $ref: '#/definitions/io.k8s.api.core.v1.SecretProjection' 5335 description: information about the secret data to project 5336 serviceAccountToken: 5337 $ref: '#/definitions/io.k8s.api.core.v1.ServiceAccountTokenProjection' 5338 description: information about the serviceAccountToken data to project 5339 type: object 5340 io.k8s.api.core.v1.VsphereVirtualDiskVolumeSource: 5341 description: Represents a vSphere volume resource. 5342 properties: 5343 fsType: 5344 description: Filesystem type to mount. Must be a filesystem type supported 5345 by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred 5346 to be "ext4" if unspecified. 5347 type: string 5348 storagePolicyID: 5349 description: Storage Policy Based Management (SPBM) profile ID associated 5350 with the StoragePolicyName. 5351 type: string 5352 storagePolicyName: 5353 description: Storage Policy Based Management (SPBM) profile name. 5354 type: string 5355 volumePath: 5356 description: Path that identifies vSphere volume vmdk 5357 type: string 5358 required: 5359 - volumePath 5360 type: object 5361 io.k8s.api.core.v1.WeightedPodAffinityTerm: 5362 description: The weights of all of the matched WeightedPodAffinityTerm fields 5363 are added per-node to find the most preferred node(s) 5364 properties: 5365 podAffinityTerm: 5366 $ref: '#/definitions/io.k8s.api.core.v1.PodAffinityTerm' 5367 description: Required. A pod affinity term, associated with the corresponding 5368 weight. 5369 weight: 5370 description: weight associated with matching the corresponding podAffinityTerm, 5371 in the range 1-100. 5372 format: int32 5373 type: integer 5374 required: 5375 - weight 5376 - podAffinityTerm 5377 type: object 5378 io.k8s.api.core.v1.WindowsSecurityContextOptions: 5379 description: WindowsSecurityContextOptions contain Windows-specific options and 5380 credentials. 5381 properties: 5382 gmsaCredentialSpec: 5383 description: GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) 5384 inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName 5385 field. This field is alpha-level and is only honored by servers that enable 5386 the WindowsGMSA feature flag. 5387 type: string 5388 gmsaCredentialSpecName: 5389 description: GMSACredentialSpecName is the name of the GMSA credential spec 5390 to use. This field is alpha-level and is only honored by servers that enable 5391 the WindowsGMSA feature flag. 5392 type: string 5393 runAsUserName: 5394 description: The UserName in Windows to run the entrypoint of the container 5395 process. Defaults to the user specified in image metadata if unspecified. 5396 May also be set in PodSecurityContext. If set in both SecurityContext and 5397 PodSecurityContext, the value specified in SecurityContext takes precedence. 5398 This field is alpha-level and it is only honored by servers that enable 5399 the WindowsRunAsUserName feature flag. 5400 type: string 5401 type: object 5402 io.k8s.api.rbac.v1.PolicyRule: 5403 description: PolicyRule holds information that describes a policy rule, but does 5404 not contain information about who the rule applies to or which namespace the 5405 rule applies to. 5406 properties: 5407 apiGroups: 5408 description: APIGroups is the name of the APIGroup that contains the resources. If 5409 multiple API groups are specified, any action requested against one of the 5410 enumerated resources in any API group will be allowed. 5411 items: 5412 type: string 5413 type: array 5414 nonResourceURLs: 5415 description: NonResourceURLs is a set of partial urls that a user should have 5416 access to. *s are allowed, but only as the full, final step in the path 5417 Since non-resource URLs are not namespaced, this field is only applicable 5418 for ClusterRoles referenced from a ClusterRoleBinding. Rules can either 5419 apply to API resources (such as "pods" or "secrets") or non-resource URL 5420 paths (such as "/api"), but not both. 5421 items: 5422 type: string 5423 type: array 5424 resourceNames: 5425 description: ResourceNames is an optional white list of names that the rule 5426 applies to. An empty set means that everything is allowed. 5427 items: 5428 type: string 5429 type: array 5430 resources: 5431 description: Resources is a list of resources this rule applies to. ResourceAll 5432 represents all resources. 5433 items: 5434 type: string 5435 type: array 5436 verbs: 5437 description: Verbs is a list of Verbs that apply to ALL the ResourceKinds 5438 and AttributeRestrictions contained in this rule. VerbAll represents all 5439 kinds. 5440 items: 5441 type: string 5442 type: array 5443 required: 5444 - verbs 5445 type: object 5446 io.k8s.api.rbac.v1.Role: 5447 description: Role is a namespaced, logical grouping of PolicyRules that can be 5448 referenced as a unit by a RoleBinding. 5449 properties: 5450 apiVersion: 5451 description: 'APIVersion defines the versioned schema of this representation 5452 of an object. Servers should convert recognized schemas to the latest internal 5453 value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' 5454 type: string 5455 kind: 5456 description: 'Kind is a string value representing the REST resource this object 5457 represents. Servers may infer this from the endpoint the client submits 5458 requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 5459 type: string 5460 metadata: 5461 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta' 5462 description: Standard object's metadata. 5463 rules: 5464 description: Rules holds all the PolicyRules for this Role 5465 items: 5466 $ref: '#/definitions/io.k8s.api.rbac.v1.PolicyRule' 5467 type: array 5468 type: object 5469 io.k8s.api.rbac.v1.RoleRef: 5470 description: RoleRef contains information that points to the role being used 5471 properties: 5472 apiGroup: 5473 description: APIGroup is the group for the resource being referenced 5474 type: string 5475 kind: 5476 description: Kind is the type of resource being referenced 5477 type: string 5478 name: 5479 description: Name is the name of resource being referenced 5480 type: string 5481 required: 5482 - apiGroup 5483 - kind 5484 - name 5485 type: object 5486 io.k8s.api.rbac.v1.Subject: 5487 description: Subject contains a reference to the object or user identities a role 5488 binding applies to. This can either hold a direct API object reference, or 5489 a value for non-objects such as user and group names. 5490 properties: 5491 apiGroup: 5492 description: APIGroup holds the API group of the referenced subject. Defaults 5493 to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" 5494 for User and Group subjects. 5495 type: string 5496 kind: 5497 description: Kind of object being referenced. Values defined by this API group 5498 are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized 5499 the kind value, the Authorizer should report an error. 5500 type: string 5501 name: 5502 description: Name of the object being referenced. 5503 type: string 5504 namespace: 5505 description: Namespace of the referenced object. If the object kind is non-namespace, 5506 such as "User" or "Group", and this value is not empty the Authorizer should 5507 report an error. 5508 type: string 5509 required: 5510 - kind 5511 - name 5512 type: object 5513 io.k8s.apimachinery.pkg.api.resource.Quantity: 5514 description: |- 5515 Quantity is a fixed-point representation of a number. It provides convenient marshaling/unmarshaling in JSON and YAML, in addition to String() and AsInt64() accessors. 5516 5517 The serialization format is: 5518 5519 <quantity> ::= <signedNumber><suffix> 5520 (Note that <suffix> may be empty, from the "" case in <decimalSI>.) 5521 <digit> ::= 0 | 1 | ... | 9 <digits> ::= <digit> | <digit><digits> <number> ::= <digits> | <digits>.<digits> | <digits>. | .<digits> <sign> ::= "+" | "-" <signedNumber> ::= <number> | <sign><number> <suffix> ::= <binarySI> | <decimalExponent> | <decimalSI> <binarySI> ::= Ki | Mi | Gi | Ti | Pi | Ei 5522 (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) 5523 <decimalSI> ::= m | "" | k | M | G | T | P | E 5524 (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) 5525 <decimalExponent> ::= "e" <signedNumber> | "E" <signedNumber> 5526 5527 No matter which of the three exponent forms is used, no quantity may represent a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal places. Numbers larger or more precise will be capped or rounded up. (E.g.: 0.1m will rounded up to 1m.) This may be extended in the future if we require larger or smaller quantities. 5528 5529 When a Quantity is parsed from a string, it will remember the type of suffix it had, and will use the same type again when it is serialized. 5530 5531 Before serializing, Quantity will be put in "canonical form". This means that Exponent/suffix will be adjusted up or down (with a corresponding increase or decrease in Mantissa) such that: 5532 a. No precision is lost 5533 b. No fractional digits will be emitted 5534 c. The exponent (or suffix) is as large as possible. 5535 The sign will be omitted unless the number is negative. 5536 5537 Examples: 5538 1.5 will be serialized as "1500m" 5539 1.5Gi will be serialized as "1536Mi" 5540 5541 Note that the quantity will NEVER be internally represented by a floating point number. That is the whole point of this exercise. 5542 5543 Non-canonical values will still parse as long as they are well formed, but will be re-emitted in their canonical form. (So always use canonical form, or don't diff.) 5544 5545 This format is intended to make it difficult to use these numbers without writing some sort of special handling code in the hopes that that will cause implementors to also use a fixed point implementation. 5546 type: string 5547 io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1: 5548 description: |- 5549 FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format. 5550 5551 Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:<name>', where <name> is the name of a field in a struct, or key in a map 'v:<value>', where <value> is the exact json formatted value of a list item 'i:<index>', where <index> is position of a item in a list 'k:<keys>', where <keys> is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set. 5552 5553 The exact format is defined in sigs.k8s.io/structured-merge-diff 5554 type: object 5555 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector: 5556 description: A label selector is a label query over a set of resources. The result 5557 of matchLabels and matchExpressions are ANDed. An empty label selector matches 5558 all objects. A null label selector matches no objects. 5559 properties: 5560 matchExpressions: 5561 description: matchExpressions is a list of label selector requirements. The 5562 requirements are ANDed. 5563 items: 5564 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement' 5565 type: array 5566 matchLabels: 5567 additionalProperties: 5568 type: string 5569 description: matchLabels is a map of {key,value} pairs. A single {key,value} 5570 in the matchLabels map is equivalent to an element of matchExpressions, 5571 whose key field is "key", the operator is "In", and the values array contains 5572 only "value". The requirements are ANDed. 5573 type: object 5574 type: object 5575 io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement: 5576 description: A label selector requirement is a selector that contains values, 5577 a key, and an operator that relates the key and values. 5578 properties: 5579 key: 5580 description: key is the label key that the selector applies to. 5581 type: string 5582 x-kubernetes-patch-merge-key: key 5583 x-kubernetes-patch-strategy: merge 5584 operator: 5585 description: operator represents a key's relationship to a set of values. 5586 Valid operators are In, NotIn, Exists and DoesNotExist. 5587 type: string 5588 values: 5589 description: values is an array of string values. If the operator is In or 5590 NotIn, the values array must be non-empty. If the operator is Exists or 5591 DoesNotExist, the values array must be empty. This array is replaced during 5592 a strategic merge patch. 5593 items: 5594 type: string 5595 type: array 5596 required: 5597 - key 5598 - operator 5599 type: object 5600 io.k8s.apimachinery.pkg.apis.meta.v1.ListMeta: 5601 description: ListMeta describes metadata that synthetic resources must have, including 5602 lists and various status objects. A resource may have only one of {ObjectMeta, 5603 ListMeta}. 5604 properties: 5605 continue: 5606 description: continue may be set if the user set a limit on the number of 5607 items returned, and indicates that the server has more data available. The 5608 value is opaque and may be used to issue another request to the endpoint 5609 that served this list to retrieve the next set of available objects. Continuing 5610 a consistent list may not be possible if the server configuration has changed 5611 or more than a few minutes have passed. The resourceVersion field returned 5612 when using this continue value will be identical to the value in the first 5613 response, unless you have received this token from an error message. 5614 type: string 5615 remainingItemCount: 5616 description: remainingItemCount is the number of subsequent items in the list 5617 which are not included in this list response. If the list request contained 5618 label or field selectors, then the number of remaining items is unknown 5619 and the field will be left unset and omitted during serialization. If the 5620 list is complete (either because it is not chunking or because this is the 5621 last chunk), then there are no more remaining items and this field will 5622 be left unset and omitted during serialization. Servers older than v1.15 5623 do not set this field. The intended use of the remainingItemCount is *estimating* 5624 the size of a collection. Clients should not rely on the remainingItemCount 5625 to be set or to be exact. 5626 format: int64 5627 type: integer 5628 resourceVersion: 5629 description: 'String that identifies the server''s internal version of this 5630 object that can be used by clients to determine when objects have changed. 5631 Value must be treated as opaque by clients and passed unmodified back to 5632 the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' 5633 type: string 5634 selfLink: 5635 description: |- 5636 selfLink is a URL representing this object. Populated by the system. Read-only. 5637 5638 DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. 5639 type: string 5640 type: object 5641 io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry: 5642 description: ManagedFieldsEntry is a workflow-id, a FieldSet and the group version 5643 of the resource that the fieldset applies to. 5644 properties: 5645 apiVersion: 5646 description: APIVersion defines the version of this resource that this field 5647 set applies to. The format is "group/version" just like the top-level APIVersion 5648 field. It is necessary to track the version of a field set because it cannot 5649 be automatically converted. 5650 type: string 5651 fieldsType: 5652 description: 'FieldsType is the discriminator for the different fields format 5653 and version. There is currently only one possible value: "FieldsV1"' 5654 type: string 5655 fieldsV1: 5656 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1' 5657 description: FieldsV1 holds the first JSON version format as described in 5658 the "FieldsV1" type. 5659 manager: 5660 description: Manager is an identifier of the workflow managing these fields. 5661 type: string 5662 operation: 5663 description: Operation is the type of operation which lead to this ManagedFieldsEntry 5664 being created. The only valid values for this field are 'Apply' and 'Update'. 5665 type: string 5666 time: 5667 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 5668 description: Time is timestamp of when these fields were set. It should always 5669 be empty if Operation is 'Apply' 5670 type: object 5671 io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta: 5672 description: ObjectMeta is metadata that all persisted resources must have, which 5673 includes all objects users must create. 5674 properties: 5675 annotations: 5676 additionalProperties: 5677 type: string 5678 description: 'Annotations is an unstructured key value map stored with a resource 5679 that may be set by external tools to store and retrieve arbitrary metadata. 5680 They are not queryable and should be preserved when modifying objects. More 5681 info: http://kubernetes.io/docs/user-guide/annotations' 5682 type: object 5683 clusterName: 5684 description: The name of the cluster which the object belongs to. This is 5685 used to distinguish resources with same name and namespace in different 5686 clusters. This field is not set anywhere right now and apiserver is going 5687 to ignore it if set in create or update request. 5688 type: string 5689 creationTimestamp: 5690 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 5691 description: |- 5692 CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. 5693 5694 Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 5695 deletionGracePeriodSeconds: 5696 description: Number of seconds allowed for this object to gracefully terminate 5697 before it will be removed from the system. Only set when deletionTimestamp 5698 is also set. May only be shortened. Read-only. 5699 format: int64 5700 type: integer 5701 deletionTimestamp: 5702 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.Time' 5703 description: |- 5704 DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested. 5705 5706 Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata 5707 finalizers: 5708 description: Must be empty before the object is deleted from the registry. 5709 Each entry is an identifier for the responsible component that will remove 5710 the entry from the list. If the deletionTimestamp of the object is non-nil, 5711 entries in this list can only be removed. 5712 items: 5713 type: string 5714 type: array 5715 x-kubernetes-patch-strategy: merge 5716 generateName: 5717 description: |- 5718 GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server. 5719 5720 If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header). 5721 5722 Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency 5723 type: string 5724 generation: 5725 description: A sequence number representing a specific generation of the desired 5726 state. Populated by the system. Read-only. 5727 format: int64 5728 type: integer 5729 labels: 5730 additionalProperties: 5731 type: string 5732 description: 'Map of string keys and values that can be used to organize and 5733 categorize (scope and select) objects. May match selectors of replication 5734 controllers and services. More info: http://kubernetes.io/docs/user-guide/labels' 5735 type: object 5736 managedFields: 5737 description: ManagedFields maps workflow-id and version to the set of fields 5738 that are managed by that workflow. This is mostly for internal housekeeping, 5739 and users typically shouldn't need to set or understand this field. A workflow 5740 can be the user's name, a controller's name, or the name of a specific apply 5741 path like "ci-cd". The set of fields is always in the version that the workflow 5742 used when modifying the object. 5743 items: 5744 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry' 5745 type: array 5746 name: 5747 description: 'Name must be unique within a namespace. Is required when creating 5748 resources, although some resources may allow a client to request the generation 5749 of an appropriate name automatically. Name is primarily intended for creation 5750 idempotence and configuration definition. Cannot be updated. More info: 5751 http://kubernetes.io/docs/user-guide/identifiers#names' 5752 type: string 5753 namespace: 5754 description: |- 5755 Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty. 5756 5757 Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces 5758 type: string 5759 ownerReferences: 5760 description: List of objects depended by this object. If ALL objects in the 5761 list have been deleted, this object will be garbage collected. If this object 5762 is managed by a controller, then an entry in this list will point to this 5763 controller, with the controller field set to true. There cannot be more 5764 than one managing controller. 5765 items: 5766 $ref: '#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference' 5767 type: array 5768 x-kubernetes-patch-merge-key: uid 5769 x-kubernetes-patch-strategy: merge 5770 resourceVersion: 5771 description: |- 5772 An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources. 5773 5774 Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency 5775 type: string 5776 selfLink: 5777 description: |- 5778 SelfLink is a URL representing this object. Populated by the system. Read-only. 5779 5780 DEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release. 5781 type: string 5782 uid: 5783 description: |- 5784 UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations. 5785 5786 Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids 5787 type: string 5788 type: object 5789 io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference: 5790 description: OwnerReference contains enough information to let you identify an 5791 owning object. An owning object must be in the same namespace as the dependent, 5792 or be cluster-scoped, so there is no namespace field. 5793 properties: 5794 apiVersion: 5795 description: API version of the referent. 5796 type: string 5797 blockOwnerDeletion: 5798 description: If true, AND if the owner has the "foregroundDeletion" finalizer, 5799 then the owner cannot be deleted from the key-value store until this reference 5800 is removed. Defaults to false. To set this field, a user needs "delete" 5801 permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. 5802 type: boolean 5803 controller: 5804 description: If true, this reference points to the managing controller. 5805 type: boolean 5806 kind: 5807 description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' 5808 type: string 5809 name: 5810 description: 'Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names' 5811 type: string 5812 uid: 5813 description: 'UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids' 5814 type: string 5815 required: 5816 - apiVersion 5817 - kind 5818 - name 5819 - uid 5820 type: object 5821 io.k8s.apimachinery.pkg.apis.meta.v1.Time: 5822 description: Time is a wrapper around time.Time which supports correct marshaling 5823 to YAML and JSON. Wrappers are provided for many of the factory methods that 5824 the time package offers. 5825 format: date-time 5826 type: string 5827 io.k8s.apimachinery.pkg.util.intstr.IntOrString: 5828 description: IntOrString is a type that can hold an int32 or a string. When used 5829 in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner 5830 type. This allows you to have, for example, a JSON field that can accept a 5831 name or number. 5832 format: int-or-string 5833 type: string 5834 info: 5835 title: Jenkins X 5836 version: "1.0" 5837 paths: {} 5838 swagger: "2.0"